fortinet.fortimanager.fmgr_firewall_address module – Configure IPv4 addresses.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.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.

New in fortinet.fortimanager 1.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.
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 dictionary	The top level parameters set.
_image-base64 string	Deprecated, please rename it to _image_base64. _Image-Base64.
allow-routing string	Deprecated, please rename it to allow_routing. Enable/disable use of this address in the static route configuration. Choices: `"disable"` `"enable"`
associated-interface string	Deprecated, please rename it to associated_interface. Network interface associated with address.
cache-ttl integer	Deprecated, please rename it to cache_ttl. Defines the minimal TTL of individual IP addresses in FQDN cache measured in se…
clearpass-spt string	Deprecated, please rename it to clearpass_spt. SPT Choices: `"unknown"` `"healthy"` `"quarantine"` `"checkup"` `"transition"` `"infected"` `"transient"`
color integer	Color of icon on the GUI.
comment any	(dict or str) No description.
country string	IP addresses associated to a specific country.
dirty string	To be deleted address. Choices: `"dirty"` `"clean"`
dynamic_mapping list / elements=dictionary	Dynamic_Mapping.
_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. Enable/disable use of this address in the static route configuration. Choices: `"disable"` `"enable"`
associated-interface string	Deprecated, please rename it to associated_interface. Network interface associated with address.
cache-ttl integer	Deprecated, please rename it to cache_ttl. Defines the minimal TTL of individual IP addresses in FQDN cache measur…
clearpass-spt string	Deprecated, please rename it to clearpass_spt. SPT Choices: `"unknown"` `"healthy"` `"quarantine"` `"checkup"` `"transition"` `"infected"` `"transient"`
color integer	Color of icon on the GUI.
comment any	(dict or str) No description.
country string	IP addresses associated to a specific country.
dirty string	To be deleted address. Choices: `"dirty"` `"clean"`
end-ip string	Deprecated, please rename it to end_ip. Final IP address
end-mac string	Deprecated, please rename it to end_mac. Last MAC address in the range.
epg-name string	Deprecated, please rename it to epg_name. Endpoint group name.
fabric-object string	Deprecated, please rename it to fabric_object. Security Fabric global object setting. Choices: `"disable"` `"enable"`
filter string	Match criteria filter.
fqdn string	Fully Qualified Domain Name address.
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	Name of interface whose IP address is to be used.
macaddr any	(list) Macaddr.
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. Object ID for NSX.
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 domain name
os string	Dynamic address matching operating system.
pattern-end integer	Deprecated, please rename it to pattern_end.
pattern-start integer	Deprecated, please rename it to pattern_start.
policy-group string	Deprecated, please rename it to policy_group. Policy group name.
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. Type of addresses to collect. 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. First IP address
start-mac string	Deprecated, please rename it to start_mac. First MAC address in the range.
sub-type string	Deprecated, please rename it to sub_type. Sub-type of address. Choices: `"sdn"` `"clearpass-spt"` `"fsso"` `"ems-tag"` `"swc-tag"` `"fortivoice-tag"` `"fortinac-tag"` `"fortipolicy-tag"` `"device-identification"`
subnet string	IP address and subnet mask of address.
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 of address. Choices: `"ipmask"` `"iprange"` `"fqdn"` `"wildcard"` `"geography"` `"url"` `"wildcard-fqdn"` `"nsx"` `"aws"` `"dynamic"` `"interface-subnet"` `"mac"` `"fqdn-group"` `"route-tag"`
url string	Url.
uuid string	Universally Unique Identifier
visibility string	Enable/disable address visibility in the GUI. Choices: `"disable"` `"enable"`
wildcard string	IP address and wildcard netmask.
wildcard-fqdn string	Deprecated, please rename it to wildcard_fqdn. Fully Qualified Domain Name with wildcard characters.
end-ip string	Deprecated, please rename it to end_ip. Final IP address
end-mac string	Deprecated, please rename it to end_mac. Last MAC address in the range.
epg-name string	Deprecated, please rename it to epg_name. Endpoint group name.
fabric-object string	Deprecated, please rename it to fabric_object. Security Fabric global object setting. Choices: `"disable"` `"enable"`
filter string	Match criteria filter.
fqdn string	Fully Qualified Domain Name address.
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	Name of interface whose IP address is to be used.
list list / elements=dictionary	List.
ip string	IP.
net-id string	Deprecated, please rename it to net_id. Network ID.
obj-id string	Deprecated, please rename it to obj_id. Object ID.
macaddr any	(list) Multiple MAC address ranges.
name string / required	Address name.
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. Object ID for NSX.
obj-tag string	Deprecated, please rename it to obj_tag. Tag of dynamic address object.
obj-type string	Deprecated, please rename it to obj_type. Object type. Choices: `"ip"` `"mac"`
organization string	Organization domain name
os string	Dynamic address matching operating system.
policy-group string	Deprecated, please rename it to policy_group. Policy group name.
profile-list list / elements=dictionary	Deprecated, please rename it to profile_list.
profile-id integer	Deprecated, please rename it to profile_id. NSX service profile ID.
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. Type of addresses to collect. 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. First IP address
start-mac string	Deprecated, please rename it to start_mac. First MAC address in the range.
sub-type string	Deprecated, please rename it to sub_type. Sub-type of address. Choices: `"sdn"` `"clearpass-spt"` `"fsso"` `"ems-tag"` `"swc-tag"` `"fortivoice-tag"` `"fortinac-tag"` `"fortipolicy-tag"` `"device-identification"`
subnet string	IP address and subnet mask of address.
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.
tagging list / elements=dictionary	Tagging.
category string	Tag category.
name string	Tagging entry name.
tags any	(list) Tags.
tags string	Names of object-tags applied to address.
tenant string	Tenant.
type string	Type of address. Choices: `"ipmask"` `"iprange"` `"fqdn"` `"wildcard"` `"geography"` `"url"` `"wildcard-fqdn"` `"nsx"` `"aws"` `"dynamic"` `"interface-subnet"` `"mac"` `"fqdn-group"` `"route-tag"`
uuid string	Universally Unique Identifier
visibility string	Enable/disable address visibility in the GUI. Choices: `"disable"` `"enable"`
wildcard string	IP address and wildcard netmask.
wildcard-fqdn string	Deprecated, please rename it to wildcard_fqdn. Fully Qualified Domain Name with wildcard characters.
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 IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_address:
          allow-routing: disable
          associated-interface: any
          name: "ansible-test1"
          visibility: disable

- 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 IPv4 addresses
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_address"
          params:
            adom: "ansible"
            address: "your_value"

- 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 IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        bypass_validation: false
        adom: root
        state: present
        firewall_address:
          allow-routing: disable
          associated-interface: any
          name: "address-orignal"
          # visibility: enable
    - name: Rename the firewall addressobject
      fortinet.fortimanager.fmgr_rename:
        rename:
          selector: "firewall_address"
          self:
            adom: "root"
            address: "address-orignal"
          target:
            name: "address-new"
    - name: Delete renamed object
      fortinet.fortimanager.fmgr_firewall_address:
        adom: "root"
        state: absent
        firewall_address:
          name: "address-new"

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Create IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        adom: root
        state: present
        firewall_address:
          allow-routing: disable
          associated-interface: any
          name: "fooaddress"
          visibility: disable
      register: info
      failed_when: info.rc != 0
    - name: Create IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        adom: root
        state: present
        firewall_address:
          allow-routing: disable
          associated-interface: any
          name: "fooaddress"
          visibility: disable
      register: info
      failed_when: info.message != 'Object update skipped!'
    - name: Delete created address
      fortinet.fortimanager.fmgr_firewall_address:
        adom: root
        state: absent
        firewall_address:
          name: "fooaddress"

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)

fortinet.fortimanager.fmgr_firewall_address module – Configure IPv4 addresses.

Synopsis

Parameters

Notes

Examples

Return Values