You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortimanager.fmgr_firewall_address module – Configure IPv4 addresses.

Note

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

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 version 2.10: of fortinet.fortimanager

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
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: no ← (default) yes
enable_log boolean	Enable/Disable logging for task Choices: no ← (default) yes
firewall_address dictionary	the top level parameters set
_image-base64 string	_Image-Base64.
allow-routing string	Enable/disable use of this address in the static route configuration. Choices: disable enable
associated-interface string	Network interface associated with address.
cache-ttl integer	Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
clearpass-spt string	SPT (System Posture Token) value. Choices: unknown healthy quarantine checkup transition infected transient
color integer	Color of icon on the GUI.
comment string	no description
country string	IP addresses associated to a specific country.
dynamic_mapping list / elements=string	Dynamic_Mapping.
_image-base64 string	_Image-Base64.
_scope list / elements=string	_Scope.
name string	Name.
vdom string	Vdom.
allow-routing string	Enable/disable use of this address in the static route configuration. Choices: disable enable
associated-interface string	Network interface associated with address.
cache-ttl integer	Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
clearpass-spt string	SPT (System Posture Token) value. Choices: unknown healthy quarantine checkup transition infected transient
color integer	Color of icon on the GUI.
comment string	no description
country string	IP addresses associated to a specific country.
end-ip string	Final IP address (inclusive) in the range for the address.
end-mac string	Last MAC address in the range.
epg-name string	Endpoint group name.
fabric-object string	Security Fabric global object setting. Choices: disable enable
filter string	Match criteria filter.
fqdn string	Fully Qualified Domain Name address.
fsso-group string	FSSO group(s).
global-object integer	Global-Object.
interface string	Name of interface whose IP address is to be used.
macaddr string	Macaddr.
node-ip-only string	Enable/disable collection of node addresses only in Kubernetes. Choices: disable enable
obj-id string	Object ID for NSX.
obj-tag string	Obj-Tag.
obj-type string	Obj-Type. Choices: ip mac
organization string	Organization domain name (Syntax: organization/domain).
policy-group string	Policy group name.
sdn string	SDN. Choices: aci aws nsx nuage azure gcp oci openstack
sdn-addr-type string	Type of addresses to collect. Choices: private public all
sdn-tag string	SDN Tag.
start-ip string	First IP address (inclusive) in the range for the address.
start-mac string	First MAC address in the range.
sub-type string	Sub-type of address. Choices: sdn clearpass-spt fsso ems-tag
subnet string	IP address and subnet mask of address.
subnet-name string	Subnet name.
tags string	Tags.
tenant string	Tenant.
type string	Type of address. Choices: ipmask iprange fqdn wildcard geography wildcard-fqdn dynamic
url string	Url.
uuid string	Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
visibility string	Enable/disable address visibility in the GUI. Choices: disable enable
wildcard string	IP address and wildcard netmask.
wildcard-fqdn string	Fully Qualified Domain Name with wildcard characters.
end-ip string	Final IP address (inclusive) in the range for the address.
end-mac string	Last MAC address in the range.
epg-name string	Endpoint group name.
fabric-object string	Security Fabric global object setting. Choices: disable enable
filter string	Match criteria filter.
fqdn string	Fully Qualified Domain Name address.
fsso-group string	FSSO group(s).
global-object integer	Global Object.
interface string	Name of interface whose IP address is to be used.
list list / elements=string	List.
ip string	IP.
net-id string	Network ID.
obj-id string	Object ID.
macaddr string	Multiple MAC address ranges.
name string	Address name.
node-ip-only string	Enable/disable collection of node addresses only in Kubernetes. Choices: disable enable
obj-id string	Object ID for NSX.
obj-tag string	Tag of dynamic address object.
obj-type string	Object type. Choices: ip mac
organization string	Organization domain name (Syntax: organization/domain).
policy-group string	Policy group name.
sdn string	SDN. Choices: aci aws nsx nuage azure gcp oci openstack
sdn-addr-type string	Type of addresses to collect. Choices: private public all
sdn-tag string	SDN Tag.
start-ip string	First IP address (inclusive) in the range for the address.
start-mac string	First MAC address in the range.
sub-type string	Sub-type of address. Choices: sdn clearpass-spt fsso ems-tag
subnet string	IP address and subnet mask of address.
subnet-name string	Subnet name.
tagging list / elements=string	Tagging.
category string	Tag category.
name string	Tagging entry name.
tags string	Tags.
tenant string	Tenant.
type string	Type of address. Choices: ipmask iprange fqdn wildcard geography wildcard-fqdn dynamic
uuid string	Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
visibility string	Enable/disable address visibility in the GUI. Choices: disable enable
wildcard string	IP address and wildcard netmask.
wildcard-fqdn string	Fully Qualified Domain Name with wildcard characters.
proposed_method string	The overridden method for the underlying Json RPC request Choices: update set add
rc_failed list / elements=string	the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string	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

• 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: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the IPv4 addresses
     fmgr_fact:
       facts:
           selector: 'firewall_address'
           params:
               adom: 'ansible'
               address: ''
- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv4 addresses.
     fmgr_firewall_address:
        bypass_validation: False
        adom: ansible
        state: present
        firewall_address:
           allow-routing: disable
           associated-interface: any
           name: 'ansible-test1'
           visibility: disable

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:

   - name: Configure IPv4 addresses.
     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
     fmgr_rename:
        rename:
            selector: 'firewall_address'
            self:
             adom: 'root'
             address: 'address-orignal'
            target:
             name: 'address-new'

   - name: delete renamed object
     fmgr_firewall_address:
        adom: 'root'
        state: absent
        firewall_address:
            name: 'address-new'


- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: create IPv4 addresses.
     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.
     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
     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
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_message string	The descriptive message of the api response Returned: always Sample: “OK.”

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

Issue Tracker Homepage Repository (Sources)