fortinet.fortimanager.fmgr_firewall_address – Configure IPv4 addresses.

Note

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

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
firewall_address
dictionary
the top level parameters set
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.
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
no description
_scope
list / elements=string
no description
name
string
no description
vdom
string
no description
allow-routing
string
    Choices:
  • disable
  • enable
no description
associated-interface
string
no description
cache-ttl
integer
no description
color
integer
no description
comment
string
no description
country
string
no description
end-ip
string
no description
end-mac
string
no description
epg-name
string
no description
filter
string
no description
fqdn
string
no description
interface
string
no description
obj-id
string
no description
organization
string
no description
policy-group
string
no description
sdn
string
    Choices:
  • aci
  • aws
  • nsx
  • nuage
  • azure
  • gcp
  • oci
  • openstack
no description
sdn-addr-type
string
    Choices:
  • private
  • public
  • all
no description
sdn-tag
string
no description
start-ip
string
no description
start-mac
string
no description
subnet
string
no description
subnet-name
string
no description
tags
string
no description
tenant
string
no description
type
string
    Choices:
  • ipmask
  • iprange
  • fqdn
  • wildcard
  • geography
  • wildcard-fqdn
  • dynamic
no description
url
string
no description
uuid
string
no description
visibility
string
    Choices:
  • disable
  • enable
no description
wildcard
string
no description
wildcard-fqdn
string
no description
end-ip
string
Final IP address (inclusive) in the range for the address.
epg-name
string
Endpoint group name.
filter
string
Match criteria filter.
fqdn
string
Fully Qualified Domain Name address.
list
list / elements=string
no description
ip
string
IP.
name
string
Address name.
obj-id
string
Object ID for NSX.
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-tag
string
SDN Tag.
start-ip
string
First IP address (inclusive) in the range for the address.
subnet
string
IP address and subnet mask of address.
subnet-name
string
Subnet name.
tagging
list / elements=string
no description
category
string
Tag category.
name
string
Tagging entry name.
tags
string
no description
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.
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: fortimanager-inventory
  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
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_address:
           allow-routing: <value in [disable, enable]>
           associated-interface: <value of string>
           cache-ttl: <value of integer>
           color: <value of integer>
           comment: <value of string>
           country: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 allow-routing: <value in [disable, enable]>
                 associated-interface: <value of string>
                 cache-ttl: <value of integer>
                 color: <value of integer>
                 comment: <value of string>
                 country: <value of string>
                 end-ip: <value of string>
                 end-mac: <value of string>
                 epg-name: <value of string>
                 filter: <value of string>
                 fqdn: <value of string>
                 interface: <value of string>
                 obj-id: <value of string>
                 organization: <value of string>
                 policy-group: <value of string>
                 sdn: <value in [aci, aws, nsx, ...]>
                 sdn-addr-type: <value in [private, public, all]>
                 sdn-tag: <value of string>
                 start-ip: <value of string>
                 start-mac: <value of string>
                 subnet: <value of string>
                 subnet-name: <value of string>
                 tags: <value of string>
                 tenant: <value of string>
                 type: <value in [ipmask, iprange, fqdn, ...]>
                 url: <value of string>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>
                 wildcard: <value of string>
                 wildcard-fqdn: <value of string>
           end-ip: <value of string>
           epg-name: <value of string>
           filter: <value of string>
           fqdn: <value of string>
           list:
             -
                 ip: <value of string>
           name: <value of string>
           obj-id: <value of string>
           organization: <value of string>
           policy-group: <value of string>
           sdn: <value in [aci, aws, nsx, ...]>
           sdn-tag: <value of string>
           start-ip: <value of string>
           subnet: <value of string>
           subnet-name: <value of string>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           tenant: <value of string>
           type: <value in [ipmask, iprange, fqdn, ...]>
           uuid: <value of string>
           visibility: <value in [disable, enable]>
           wildcard: <value of string>
           wildcard-fqdn: <value of string>

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)