fortinet.fortimanager.fmgr_firewall_address_dynamicmapping (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dynamic mappings of IPv4 address
      fortinet.fortimanager.fmgr_firewall_address_dynamicmapping:
        bypass_validation: true
        adom: ansible
        address: "ansible-test1" # name
        state: present
        firewall_address_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          allow-routing: disable # <value in [disable, enable]>
          cache-ttl: 0
          color: 1
          comment: "ansible-comment"
          subnet: "222.222.222.101/32"
          subnet-name: "ansible-test"
          type: ipmask # <value in [ipmask, iprange, fqdn, ...]>
          visibility: enable

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the dynamic mappings of IPv4 address
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_address_dynamicmapping"
          params:
            adom: "ansible"
            address: "ansible-test1" # name
            dynamic_mapping: "your_value"

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

address:
    description: The parameter (address) in requested url.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

firewall_address_dynamicmapping:
    description: The top level parameters set.
    required: false
    suboptions:
      _image-base64:
        description: Deprecated, please rename it to _image_base64.
        type: str
      _scope:
        description: No description.
        elements: dict
        suboptions:
          name:
            description: No description.
            type: str
          vdom:
            description: No description.
            type: str
        type: list
      allow-routing:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to allow_routing.
        type: str
      associated-interface:
        description: Deprecated, please rename it to associated_interface.
        type: str
      cache-ttl:
        description: Deprecated, please rename it to cache_ttl.
        type: int
      clearpass-spt:
        choices:
        - unknown
        - healthy
        - quarantine
        - checkup
        - transition
        - infected
        - transient
        description: Deprecated, please rename it to clearpass_spt.
        type: str
      color:
        description: No description.
        type: int
      comment:
        description: (dict or str) No description.
        type: raw
      country:
        description: No description.
        type: str
      dirty:
        choices:
        - dirty
        - clean
        description: To be deleted address.
        type: str
      end-ip:
        description: Deprecated, please rename it to end_ip.
        type: str
      end-mac:
        description: Deprecated, please rename it to end_mac.
        type: str
      epg-name:
        description: Deprecated, please rename it to epg_name.
        type: str
      fabric-object:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to fabric_object. Security Fabric global
          object setting.
        type: str
      filter:
        description: No description.
        type: str
      fqdn:
        description: No description.
        type: str
      fsso-group:
        description: (list or str) Deprecated, please rename it to fsso_group.
        type: raw
      global-object:
        description: Deprecated, please rename it to global_object.
        type: int
      hw-model:
        description: Deprecated, please rename it to hw_model. Dynamic address matching
          hardware model.
        type: str
      hw-vendor:
        description: Deprecated, please rename it to hw_vendor. Dynamic address matching
          hardware vendor.
        type: str
      interface:
        description: No description.
        type: str
      macaddr:
        description: (list) No description.
        type: raw
      node-ip-only:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to node_ip_only. Enable/disable collection
          of node addresses only in Kubernetes.
        type: str
      obj-id:
        description: Deprecated, please rename it to obj_id.
        type: str
      obj-tag:
        description: Deprecated, please rename it to obj_tag.
        type: str
      obj-type:
        choices:
        - ip
        - mac
        description: Deprecated, please rename it to obj_type.
        type: str
      organization:
        description: No description.
        type: str
      os:
        description: Dynamic address matching operating system.
        type: str
      pattern-end:
        description: Deprecated, please rename it to pattern_end.
        type: int
      pattern-start:
        description: Deprecated, please rename it to pattern_start.
        type: int
      policy-group:
        description: Deprecated, please rename it to policy_group.
        type: str
      route-tag:
        description: Deprecated, please rename it to route_tag. Route-tag address.
        type: int
      sdn:
        choices:
        - aci
        - aws
        - nsx
        - nuage
        - azure
        - gcp
        - oci
        - openstack
        description: No description.
        type: str
      sdn-addr-type:
        choices:
        - private
        - public
        - all
        description: Deprecated, please rename it to sdn_addr_type.
        type: str
      sdn-tag:
        description: Deprecated, please rename it to sdn_tag.
        type: str
      start-ip:
        description: Deprecated, please rename it to start_ip.
        type: str
      start-mac:
        description: Deprecated, please rename it to start_mac.
        type: str
      sub-type:
        choices:
        - sdn
        - clearpass-spt
        - fsso
        - ems-tag
        - swc-tag
        - fortivoice-tag
        - fortinac-tag
        - fortipolicy-tag
        - device-identification
        description: Deprecated, please rename it to sub_type.
        type: str
      subnet:
        description: No description.
        type: str
      subnet-name:
        description: Deprecated, please rename it to subnet_name.
        type: str
      sw-version:
        description: Deprecated, please rename it to sw_version. Dynamic address matching
          software version.
        type: str
      tag-detection-level:
        description: Deprecated, please rename it to tag_detection_level. Tag detection
          level of dynamic address object.
        type: str
      tag-type:
        description: Deprecated, please rename it to tag_type. Tag type of dynamic address
          object.
        type: str
      tags:
        description: (list or str) No description.
        type: raw
      tenant:
        description: No description.
        type: str
      type:
        choices:
        - ipmask
        - iprange
        - fqdn
        - wildcard
        - geography
        - url
        - wildcard-fqdn
        - nsx
        - aws
        - dynamic
        - interface-subnet
        - mac
        - fqdn-group
        - route-tag
        description: No description.
        type: str
      url:
        description: No description.
        type: str
      uuid:
        description: No description.
        type: str
      visibility:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      wildcard:
        description: No description.
        type: str
      wildcard-fqdn:
        description: Deprecated, please rename it to wildcard_fqdn.
        type: str
    type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list