fortinet.fortimanager.fmgr_firewall_address6 module – Configure IPv6 firewall addresses.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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_address6
.
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. |
|
Deprecated, please rename it to _image_base64. Image base64. |
|
Deprecated, please rename it to cache_ttl. Minimal TTL of individual IPv6 addresses in FQDN cache. |
|
Integer value to determine the color of the icon in the GUI |
|
Comment. |
|
IPv6 addresses associated to a specific country. |
|
Dynamic mapping. |
|
Deprecated, please rename it to _image_base64. Image base64. |
|
Scope. |
|
Name. |
|
Vdom. |
|
Deprecated, please rename it to cache_ttl. Cache ttl. |
|
Color. |
|
Comment. |
|
Country. |
|
Deprecated, please rename it to end_ip. End ip. |
|
Deprecated, please rename it to end_mac. End mac. |
|
Deprecated, please rename it to epg_name. Endpoint group name. |
|
Deprecated, please rename it to fabric_object. Security Fabric global object setting. Choices:
|
|
Fqdn. |
|
Deprecated, please rename it to global_object. Global object. |
|
Host. |
|
Deprecated, please rename it to host_type. Host type. Choices:
|
|
Ip6. |
|
(list) Multiple MAC address ranges. |
|
Deprecated, please rename it to obj_id. Obj id. |
|
Deprecated, please rename it to route_tag. Route-tag address. |
|
Sdn. Choices:
|
|
Deprecated, please rename it to sdn_tag. SDN Tag. |
|
Deprecated, please rename it to start_ip. Start ip. |
|
Deprecated, please rename it to start_mac. Start mac. |
|
Deprecated, please rename it to subnet_segment. Subnet segment. |
|
Name. |
|
Type. Choices:
|
|
Value. |
|
(list or str) Tags. |
|
Template. |
|
Tenant. |
|
Type. Choices:
|
|
Uuid. |
|
Visibility. Choices:
|
|
Deprecated, please rename it to end_ip. Final IP address |
|
Deprecated, please rename it to end_mac. Last MAC address in the range. |
|
Deprecated, please rename it to epg_name. Endpoint group name. |
|
Deprecated, please rename it to fabric_object. Security Fabric global object setting. Choices:
|
|
Fully qualified domain name. |
|
Deprecated, please rename it to global_object. Global Object. |
|
Host Address. |
|
Deprecated, please rename it to host_type. Host type. Choices:
|
|
IPv6 address prefix |
|
List. |
|
IP. |
|
Deprecated, please rename it to net_id. Network ID. |
|
Deprecated, please rename it to obj_id. Object ID. |
|
(list) Multiple MAC address ranges. |
|
Address name. |
|
Deprecated, please rename it to obj_id. Object ID for NSX. |
|
Deprecated, please rename it to profile_list. Profile list. |
|
Deprecated, please rename it to profile_id. NSX service profile ID. |
|
Deprecated, please rename it to route_tag. Route-tag address. |
|
SDN. Choices:
|
|
Deprecated, please rename it to sdn_tag. SDN Tag. |
|
Deprecated, please rename it to start_ip. First IP address |
|
Deprecated, please rename it to start_mac. First MAC address in the range. |
|
Deprecated, please rename it to subnet_segment. Subnet segment. |
|
Name. |
|
Subnet segment type. Choices:
|
|
Subnet segment value. |
|
Tagging. |
|
Tag category. |
|
Tagging entry name. |
|
(list) Tags. |
|
Names of object-tags applied to address. |
|
IPv6 address template. |
|
Tenant. |
|
Type of IPv6 address object Choices:
|
|
Universally Unique Identifier |
|
Enable/disable the visibility of the object in the GUI. Choices:
|
|
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 IPv6 firewall addresses.
fortinet.fortimanager.fmgr_firewall_address6:
bypass_validation: false
adom: ansible
state: present
firewall_address6:
host-type: any # <value in [any, specific]>
ip6: "::/55"
name: "ansible-test"
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 IPv6 addresses
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_address6"
params:
adom: "ansible"
address6: "your_value"
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 |