fortinet.fortimanager.fmgr_firewall_address module – Configure IPv4 addresses.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Image base64. |
|
Enable/disable use of this address in the static route configuration. Choices:
|
|
Network interface associated with address. |
|
Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds. |
|
SPT Choices:
|
|
Color of icon on the GUI. |
|
(dict or str) Comment. |
|
IP addresses associated to a specific country. |
|
To be deleted address. Choices:
|
|
Dynamic mapping. |
|
Image base64. |
|
Scope. |
|
Name. |
|
Vdom. |
|
Allow routing. Choices:
|
|
Associated interface. |
|
Cache ttl. |
|
Clearpass spt. Choices:
|
|
Color. |
|
(dict or str) Comment. |
|
Country. |
|
To be deleted address. Choices:
|
|
End ip. |
|
End mac. |
|
Epg name. |
|
Security Fabric global object setting. Choices:
|
|
Filter. |
|
Fqdn. |
|
(list or str) Fsso group. |
|
Global object. |
|
Dynamic address matching hardware model. |
|
Dynamic address matching hardware vendor. |
|
Interface. |
|
(list) Multiple MAC address ranges. |
|
Enable/disable collection of node addresses only in Kubernetes. Choices:
|
|
Obj id. |
|
Obj tag. |
|
Obj type. Choices:
|
|
Organization. |
|
Dynamic address matching operating system. |
|
Pattern end. |
|
Pattern start. |
|
Policy group. |
|
Route-tag address. |
|
Sdn. Choices:
|
|
Sdn addr type. Choices:
|
|
Sdn tag. |
|
Start ip. |
|
Start mac. |
|
Sub type. Choices:
|
|
Subnet. |
|
Subnet name. |
|
Dynamic address matching software version. |
|
Tag detection level of dynamic address object. |
|
Tag type of dynamic address object. |
|
(list or str) Tags. |
|
Tenant. |
|
Type. Choices:
|
|
Url. |
|
Uuid. |
|
Visibility. Choices:
|
|
Wildcard. |
|
Wildcard fqdn. |
|
Final IP address |
|
Last MAC address in the range. |
|
Endpoint group name. |
|
Security Fabric global object setting. Choices:
|
|
Match criteria filter. |
|
Fully Qualified Domain Name address. |
|
(list or str) FSSO group |
|
Global Object. |
|
Dynamic address matching hardware model. |
|
Dynamic address matching hardware vendor. |
|
Name of interface whose IP address is to be used. |
|
List. |
|
IP. |
|
Network ID. |
|
Object ID. |
|
(list) Multiple MAC address ranges. |
|
Address name. |
|
Enable/disable collection of node addresses only in Kubernetes. Choices:
|
|
Object ID for NSX. |
|
Tag of dynamic address object. |
|
Object type. Choices:
|
|
Organization domain name |
|
Dynamic address matching operating system. |
|
Policy group name. |
|
Profile list. |
|
NSX service profile ID. |
|
Route-tag address. |
|
SDN. Choices:
|
|
Type of addresses to collect. Choices:
|
|
SDN Tag. |
|
First IP address |
|
First MAC address in the range. |
|
Sub-type of address. Choices:
|
|
IP address and subnet mask of address. |
|
Subnet name. |
|
Dynamic address matching software version. |
|
Tag detection level of dynamic address object. |
|
Tag type of dynamic address object. |
|
Tagging. |
|
Tag category. |
|
Tagging entry name. |
|
(list) Tags. |
|
Names of object-tags applied to address. |
|
Tenant. |
|
Type of address. Choices:
|
|
Universally Unique Identifier |
|
Enable/disable address visibility in the GUI. Choices:
|
|
IP address and wildcard netmask. |
|
Fully Qualified Domain Name with wildcard characters. |
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 addresses.
fortinet.fortimanager.fmgr_firewall_address:
bypass_validation: false
adom: ansible
state: present
firewall_address:
allow-routing: disable
associated-interface: any
name: "ansible-test1"
visibility: disable
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the IPv4 addresses
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_address"
params:
adom: "ansible"
address: "your_value"
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 addresses.
fortinet.fortimanager.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
fortinet.fortimanager.fmgr_rename:
rename:
selector: "firewall_address"
self:
adom: "root"
address: "address-orignal"
target:
name: "address-new"
- name: Delete renamed object
fortinet.fortimanager.fmgr_firewall_address:
adom: "root"
state: absent
firewall_address:
name: "address-new"
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Create IPv4 addresses.
fortinet.fortimanager.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.
fortinet.fortimanager.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
fortinet.fortimanager.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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |