fmgr_firewall_address – Configure IPv4 addresses.¶

New in version 2.10.

Synopsis
Requirements
FortiManager Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v6.0.0.

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

FortiManager Version Compatibility ¶

	`6.0.0`	`6.2.1`	`6.2.3`	`6.2.5`	`6.4.0`	`6.4.2`	`6.4.5`	`7.0.0`
firewall_address	yes	yes	yes	yes	yes	yes	yes	yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
state - The directive to create, update or delete an object type: str required: true choices: present, absent
adom - The parameter in requested url type: str required: true
firewall_address - Configure IPv4 addresses. type: dict

allow-routing - Enable/disable use of this address in the static route configuration. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

allow-routing True True True True True True True True
associated-interface - Network interface associated with address. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

associated-interface True True True True True True True True
cache-ttl - Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

cache-ttl True True True True True True True True
color - Color of icon on the GUI. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

color True True True True True True True True
comment - No description for the parameter type: str
country - IP addresses associated to a specific country. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

country True True True True True True True True
dynamic_mapping - No description for the parameter type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

dynamic_mapping True True True True True True True True
- _scope - No description for the parameter type: array more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  _scope True True True True True True True True
  - name - No description for the parameter type: str more...
    
    6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
    
    name True True True True True True True True
  - vdom - No description for the parameter type: str more...
    
    6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
    
    vdom True True True True True True True True
- allow-routing - No description for the parameter type: str choices: [disable, enable] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  allow-routing True True True True True True True True
- associated-interface - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  associated-interface True True True True True True True True
- cache-ttl - No description for the parameter type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  cache-ttl True True True True True True True True
- color - No description for the parameter type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  color True True True True True True True True
- comment - No description for the parameter type: str
- country - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  country True True True True True True True True
- end-ip - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  end-ip True True True True True True True True
- end-mac - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  end-mac True True True True True True True True
- epg-name - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  epg-name True True True True True True True True
- filter - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  filter True True True True True True True True
- fqdn - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  fqdn True True True True True True True True
- interface - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  interface True True True True True True True True
- obj-id - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  obj-id True True True True True True True True
- organization - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  organization True True True True True True True True
- policy-group - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  policy-group True True True True True True True True
- sdn - No description for the parameter type: str choices: [aci, aws, nsx, nuage, azure, gcp, oci, openstack] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  sdn True True True True True True True True
- sdn-addr-type - No description for the parameter type: str choices: [private, public, all] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  sdn-addr-type True True True True True True True True
- sdn-tag - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  sdn-tag True True True True True True True True
- start-ip - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  start-ip True True True True True True True True
- start-mac - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  start-mac True True True True True True True True
- subnet - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  subnet True True True True True True True True
- subnet-name - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  subnet-name True True True True True True True True
- tags - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  tags True True True True True True True True
- tenant - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  tenant True True True True True True True True
- type - No description for the parameter type: str choices: [ipmask, iprange, fqdn, wildcard, geography, wildcard-fqdn, dynamic]
- url - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  url True True True True True True True True
- uuid - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  uuid True True True True True True True True
- visibility - No description for the parameter type: str choices: [disable, enable] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  visibility True True True True True True True True
- wildcard - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  wildcard True True True True True True True True
- wildcard-fqdn - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  wildcard-fqdn True True True True True True True True
- _image-base64 - No description for the parameter type: str more...
  
  6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  _image-base64 True True True True True True
- clearpass-spt - No description for the parameter type: str choices: [unknown, healthy, quarantine, checkup, transition, infected, transient] more...
  
  6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  clearpass-spt True True True True True True
- fsso-group - No description for the parameter type: str more...
  
  6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  fsso-group True True True True True True
- sub-type - No description for the parameter type: str choices: [sdn, clearpass-spt, fsso, ems-tag] more...
  
  6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  sub-type True True True True True True
- global-object - No description for the parameter type: int more...
  
  6.4.0 6.4.2 6.4.5 7.0.0
  
  global-object True True True True
- obj-tag - No description for the parameter type: str more...
  
  6.4.2 6.4.5 7.0.0
  
  obj-tag True True True
- obj-type - No description for the parameter type: str choices: [ip, mac] more...
  
  6.4.2 6.4.5 7.0.0
  
  obj-type True True True
- fabric-object - Security Fabric global object setting. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0
  
  fabric-object True True
- macaddr - No description for the parameter type: str more...
  
  7.0.0
  
  macaddr True
- node-ip-only - Enable/disable collection of node addresses only in Kubernetes. type: str choices: [disable, enable] more...
  
  7.0.0
  
  node-ip-only True
end-ip - Final IP address (inclusive) in the range for the address. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

end-ip True True True True True True True True
epg-name - Endpoint group name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

epg-name True True True True True True True True
filter - Match criteria filter. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

filter True True True True True True True True
fqdn - Fully Qualified Domain Name address. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

fqdn True True True True True True True True
list - No description for the parameter type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

list True True True True True True True True
- ip - IP. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  ip True True True True True True True True
- net-id - Network ID. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  net-id True True True True True True True
- obj-id - Object ID. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  obj-id True True True True True True True
name - Address name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

name True True True True True True True True
obj-id - Object ID for NSX. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

obj-id True True True True True True True True
organization - Organization domain name (Syntax: organization/domain). type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

organization True True True True True True True True
policy-group - Policy group name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

policy-group True True True True True True True True
sdn - SDN. type: str choices: [aci, aws, nsx, nuage, azure, gcp, oci, openstack] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

sdn True True True True True True True True
sdn-tag - SDN Tag. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

sdn-tag True True True True True True True True
start-ip - First IP address (inclusive) in the range for the address. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

start-ip True True True True True True True True
subnet - IP address and subnet mask of address. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

subnet True True True True True True True True
subnet-name - Subnet name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

subnet-name True True True True True True True True
tagging - No description for the parameter type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

tagging True True True True True True True True
- category - Tag category. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  category True True True True True True True True
- name - Tagging entry name. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  name True True True True True True True True
- tags - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  tags True True True True True True True True
tenant - Tenant. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

tenant True True True True True True True True
type - Type of address. type: str choices: [ipmask, iprange, fqdn, wildcard, geography, wildcard-fqdn, dynamic]
uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

uuid True True True True True True True True
visibility - Enable/disable address visibility in the GUI. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

visibility True True True True False False False False
wildcard - IP address and wildcard netmask. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

wildcard True True True True True True True True
wildcard-fqdn - Fully Qualified Domain Name with wildcard characters. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

wildcard-fqdn True True True True True True True True
end-mac - Last MAC address in the range. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

end-mac True True True True True True False
interface - Name of interface whose IP address is to be used. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

interface True True True True True True True
sdn-addr-type - Type of addresses to collect. type: str choices: [private, public, all] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

sdn-addr-type True True True True True True True
start-mac - First MAC address in the range. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

start-mac True True True True True True False
_image-base64 - No description for the parameter type: str more...

6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

_image-base64 True True True True True True
clearpass-spt - SPT (System Posture Token) value. type: str choices: [unknown, healthy, quarantine, checkup, transition, infected, transient] more...

6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

clearpass-spt True True True True True True
fsso-group - FSSO group(s). type: str more...

6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

fsso-group True True True True True True
sub-type - Sub-type of address. type: str choices: [sdn, clearpass-spt, fsso, ems-tag] more...

6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

sub-type True True True True True True
global-object - Global Object. type: int more...

6.4.0 6.4.2 6.4.5 7.0.0

global-object True True True False
obj-tag - Tag of dynamic address object. type: str more...

6.4.2 6.4.5 7.0.0

obj-tag True True True
obj-type - Object type. type: str choices: [ip, mac] more...

6.4.2 6.4.5 7.0.0

obj-type True True True
fabric-object - Security Fabric global object setting. type: str choices: [disable, enable] more...

6.4.5 7.0.0

fabric-object True True
macaddr - No description for the parameter type: str more...

7.0.0

macaddr True
node-ip-only - Enable/disable collection of node addresses only in Kubernetes. type: str choices: [disable, enable] more...

7.0.0

node-ip-only True

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>
                 _image-base64: <value of string>
                 clearpass-spt: <value in [unknown, healthy, quarantine, ...]>
                 fsso-group: <value of string>
                 sub-type: <value in [sdn, clearpass-spt, fsso, ...]>
                 global-object: <value of integer>
                 obj-tag: <value of string>
                 obj-type: <value in [ip, mac]>
                 fabric-object: <value in [disable, enable]>
                 macaddr: <value of string>
                 node-ip-only: <value in [disable, enable]>
           end-ip: <value of string>
           epg-name: <value of string>
           filter: <value of string>
           fqdn: <value of string>
           list:
             -
                 ip: <value of string>
                 net-id: <value of string>
                 obj-id: <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>
           end-mac: <value of string>
           interface: <value of string>
           sdn-addr-type: <value in [private, public, all]>
           start-mac: <value of string>
           _image-base64: <value of string>
           clearpass-spt: <value in [unknown, healthy, quarantine, ...]>
           fsso-group: <value of string>
           sub-type: <value in [sdn, clearpass-spt, fsso, ...]>
           global-object: <value of integer>
           obj-tag: <value of string>
           obj-type: <value in [ip, mac]>
           fabric-object: <value in [disable, enable]>
           macaddr: <value of string>
           node-ip-only: <value in [disable, enable]>

Return Values ¶

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

request_url - The full url requested returned: always type: str sample: /sys/login/user
response_code - The status of api request returned: always type: int sample: 0
response_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.