fortinet.fortimanager.fmgr_firewall_address – Configure IPv4 addresses.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
firewall_address
dictionary
the top level parameters set
_image-base64
string
_Image-Base64.
allow-routing
string
    Choices:
  • disable
  • enable
Enable/disable use of this address in the static route configuration.
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
    Choices:
  • unknown
  • healthy
  • quarantine
  • checkup
  • transition
  • infected
  • transient
SPT (System Posture Token) value.
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
    Choices:
  • disable
  • enable
Enable/disable use of this address in the static route configuration.
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
    Choices:
  • unknown
  • healthy
  • quarantine
  • checkup
  • transition
  • infected
  • transient
SPT (System Posture Token) value.
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
    Choices:
  • disable
  • enable
Security Fabric global object setting.
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
    Choices:
  • disable
  • enable
Enable/disable collection of node addresses only in Kubernetes.
obj-id
string
Object ID for NSX.
obj-tag
string
Obj-Tag.
obj-type
string
    Choices:
  • ip
  • mac
Obj-Type.
organization
string
Organization domain name (Syntax: organization/domain).
policy-group
string
Policy group name.
sdn
string
    Choices:
  • aci
  • aws
  • nsx
  • nuage
  • azure
  • gcp
  • oci
  • openstack
SDN.
sdn-addr-type
string
    Choices:
  • private
  • public
  • all
Type of addresses to collect.
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
    Choices:
  • sdn
  • clearpass-spt
  • fsso
  • ems-tag
Sub-type of address.
subnet
string
IP address and subnet mask of address.
subnet-name
string
Subnet name.
tags
string
Tags.
tenant
string
Tenant.
type
string
    Choices:
  • ipmask
  • iprange
  • fqdn
  • wildcard
  • geography
  • wildcard-fqdn
  • dynamic
Type of address.
url
string
Url.
uuid
string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
visibility
string
    Choices:
  • disable
  • enable
Enable/disable address visibility in the GUI.
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
    Choices:
  • disable
  • enable
Security Fabric global object setting.
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
    Choices:
  • disable
  • enable
Enable/disable collection of node addresses only in Kubernetes.
obj-id
string
Object ID for NSX.
obj-tag
string
Tag of dynamic address object.
obj-type
string
    Choices:
  • ip
  • mac
Object type.
organization
string
Organization domain name (Syntax: organization/domain).
policy-group
string
Policy group name.
sdn
string
    Choices:
  • aci
  • aws
  • nsx
  • nuage
  • azure
  • gcp
  • oci
  • openstack
SDN.
sdn-addr-type
string
    Choices:
  • private
  • public
  • all
Type of addresses to collect.
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
    Choices:
  • sdn
  • clearpass-spt
  • fsso
  • ems-tag
Sub-type of address.
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
    Choices:
  • ipmask
  • iprange
  • fqdn
  • wildcard
  • geography
  • wildcard-fqdn
  • dynamic
Type of address.
uuid
string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
visibility
string
    Choices:
  • disable
  • enable
Enable/disable address visibility in the GUI.
wildcard
string
IP address and wildcard netmask.
wildcard-fqdn
string
Fully Qualified Domain Name with wildcard characters.
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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

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

- 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: ''

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)