fortinet.fortimanager.fmgr_firewall_address_dynamicmapping module – Configure IPv4 addresses.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_address_dynamicmapping.

New in fortinet.fortimanager 2.0.0

Synopsis

  • 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.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

address

string / required

The parameter (address) in requested url.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

firewall_address_dynamicmapping

dictionary

The top level parameters set.

_image-base64

string

Deprecated, please rename it to _image_base64. Image base64.

_scope

list / elements=dictionary

Scope.

name

string

Name.

vdom

string

Vdom.

allow-routing

string

Deprecated, please rename it to allow_routing. Allow routing.

Choices:

  • "disable"

  • "enable"

associated-interface

string

Deprecated, please rename it to associated_interface. Associated interface.

cache-ttl

integer

Deprecated, please rename it to cache_ttl. Cache ttl.

clearpass-spt

string

Deprecated, please rename it to clearpass_spt. Clearpass spt.

Choices:

  • "unknown"

  • "healthy"

  • "quarantine"

  • "checkup"

  • "transition"

  • "infected"

  • "transient"

color

integer

Color.

comment

any

(dict or str) Comment.

country

string

Country.

dirty

string

To be deleted address.

Choices:

  • "dirty"

  • "clean"

end-ip

string

Deprecated, please rename it to end_ip. End ip.

end-mac

string

Deprecated, please rename it to end_mac. End mac.

epg-name

string

Deprecated, please rename it to epg_name. Epg name.

fabric-object

string

Deprecated, please rename it to fabric_object. Security Fabric global object setting.

Choices:

  • "disable"

  • "enable"

filter

string

Filter.

fqdn

string

Fqdn.

fsso-group

any

(list or str) Deprecated, please rename it to fsso_group. Fsso group.

global-object

integer

Deprecated, please rename it to global_object. Global object.

hw-model

string

Deprecated, please rename it to hw_model. Dynamic address matching hardware model.

hw-vendor

string

Deprecated, please rename it to hw_vendor. Dynamic address matching hardware vendor.

interface

string

Interface.

macaddr

any

(list) Multiple MAC address ranges.

node-ip-only

string

Deprecated, please rename it to node_ip_only. Enable/disable collection of node addresses only in Kubernetes.

Choices:

  • "disable"

  • "enable"

obj-id

string

Deprecated, please rename it to obj_id. Obj id.

obj-tag

string

Deprecated, please rename it to obj_tag. Obj tag.

obj-type

string

Deprecated, please rename it to obj_type. Obj type.

Choices:

  • "ip"

  • "mac"

organization

string

Organization.

os

string

Dynamic address matching operating system.

pattern-end

integer

Deprecated, please rename it to pattern_end. Pattern end.

pattern-start

integer

Deprecated, please rename it to pattern_start. Pattern start.

policy-group

string

Deprecated, please rename it to policy_group. Policy group.

route-tag

integer

Deprecated, please rename it to route_tag. Route-tag address.

sdn

string

Sdn.

Choices:

  • "aci"

  • "aws"

  • "nsx"

  • "nuage"

  • "azure"

  • "gcp"

  • "oci"

  • "openstack"

sdn-addr-type

string

Deprecated, please rename it to sdn_addr_type. Sdn addr type.

Choices:

  • "private"

  • "public"

  • "all"

sdn-tag

string

Deprecated, please rename it to sdn_tag. Sdn tag.

start-ip

string

Deprecated, please rename it to start_ip. Start ip.

start-mac

string

Deprecated, please rename it to start_mac. Start mac.

sub-type

string

Deprecated, please rename it to sub_type. Sub type.

Choices:

  • "sdn"

  • "clearpass-spt"

  • "fsso"

  • "ems-tag"

  • "swc-tag"

  • "fortivoice-tag"

  • "fortinac-tag"

  • "fortipolicy-tag"

  • "device-identification"

subnet

string

Subnet.

subnet-name

string

Deprecated, please rename it to subnet_name. Subnet name.

sw-version

string

Deprecated, please rename it to sw_version. Dynamic address matching software version.

tag-detection-level

string

Deprecated, please rename it to tag_detection_level. Tag detection level of dynamic address object.

tag-type

string

Deprecated, please rename it to tag_type. Tag type of dynamic address object.

tags

any

(list or str) Tags.

tenant

string

Tenant.

type

string

Type.

Choices:

  • "ipmask"

  • "iprange"

  • "fqdn"

  • "wildcard"

  • "geography"

  • "url"

  • "wildcard-fqdn"

  • "nsx"

  • "aws"

  • "dynamic"

  • "interface-subnet"

  • "mac"

  • "fqdn-group"

  • "route-tag"

url

string

Url.

uuid

string

Uuid.

visibility

string

Visibility.

Choices:

  • "disable"

  • "enable"

wildcard

string

Wildcard.

wildcard-fqdn

string

Deprecated, please rename it to wildcard_fqdn. Wildcard fqdn.

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

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

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- 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

- 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"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)