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 – no description

Note

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

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
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	no description
allow-routing string	no description Choices: "disable" "enable"
associated-interface string	no description
cache-ttl integer	no description
clearpass-spt string	no description Choices: "unknown" "healthy" "quarantine" "checkup" "transition" "infected" "transient"
color integer	no description
comment string	no description
country string	no description
dirty string	no description Choices: "dirty" "clean"
dynamic_mapping list / elements=string	no description
_image-base64 string	no description
_scope list / elements=string	no description
name string	no description
vdom string	no description
allow-routing string	no description Choices: "disable" "enable"
associated-interface string	no description
cache-ttl integer	no description
clearpass-spt string	no description Choices: "unknown" "healthy" "quarantine" "checkup" "transition" "infected" "transient"
color integer	no description
comment string	no description
country string	no description
dirty string	no description Choices: "dirty" "clean"
end-ip string	no description
end-mac string	no description
epg-name string	no description
fabric-object string	no description Choices: "disable" "enable"
filter string	no description
fqdn string	no description
fsso-group string	no description
global-object integer	no description
interface string	no description
macaddr string	no description
node-ip-only string	no description Choices: "disable" "enable"
obj-id string	no description
obj-tag string	no description
obj-type string	no description Choices: "ip" "mac"
organization string	no description
pattern-end integer	no description
pattern-start integer	no description
policy-group string	no description
sdn string	no description Choices: "aci" "aws" "nsx" "nuage" "azure" "gcp" "oci" "openstack"
sdn-addr-type string	no description Choices: "private" "public" "all"
sdn-tag string	no description
start-ip string	no description
start-mac string	no description
sub-type string	no description Choices: "sdn" "clearpass-spt" "fsso" "ems-tag" "swc-tag" "fortivoice-tag" "fortinac-tag"
subnet string	no description
subnet-name string	no description
tag-detection-level string	no description
tag-type string	no description
tags string	no description
tenant string	no description
type string	no description Choices: "ipmask" "iprange" "fqdn" "wildcard" "geography" "wildcard-fqdn" "dynamic"
url string	no description
uuid string	no description
visibility string	no description Choices: "disable" "enable"
wildcard string	no description
wildcard-fqdn string	no description
end-ip string	no description
end-mac string	no description
epg-name string	no description
fabric-object string	no description Choices: "disable" "enable"
filter string	no description
fqdn string	no description
fsso-group string	no description
global-object integer	no description
interface string	no description
list list / elements=string	no description
ip string	no description
net-id string	no description
obj-id string	no description
macaddr string	no description
name string	no description
node-ip-only string	no description Choices: "disable" "enable"
obj-id string	no description
obj-tag string	no description
obj-type string	no description Choices: "ip" "mac"
organization string	no description
policy-group string	no description
sdn string	no description Choices: "aci" "aws" "nsx" "nuage" "azure" "gcp" "oci" "openstack"
sdn-addr-type string	no description Choices: "private" "public" "all"
sdn-tag string	no description
start-ip string	no description
start-mac string	no description
sub-type string	no description Choices: "sdn" "clearpass-spt" "fsso" "ems-tag" "swc-tag" "fortivoice-tag" "fortinac-tag"
subnet string	no description
subnet-name string	no description
tag-detection-level string	no description
tag-type string	no description
tagging list / elements=string	no description
category string	no description
name string	no description
tags string	no description
tenant string	no description
type string	no description Choices: "ipmask" "iprange" "fqdn" "wildcard" "geography" "wildcard-fqdn" "dynamic"
uuid string	no description
visibility string	no description Choices: "disable" "enable"
wildcard string	no description
wildcard-fqdn string	no description
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: 'your_value'
- 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)