fmgr_firewall_address6 – Configure IPv6 firewall addresses.¶
New in version 2.10.
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
Parameters¶
- 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_address6 - Configure IPv6 firewall addresses. type: dict
- cache-ttl - Minimal TTL of individual IPv6 addresses in FQDN cache. type: int
- color - Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1). type: int
- comment - Comment. type: str
- dynamic_mapping - No description for the parameter type: array
- _scope - No description for the parameter type: array
- name - No description for the parameter type: str
- vdom - No description for the parameter type: str
- cache-ttl - No description for the parameter type: int
- color - No description for the parameter type: int
- comment - No description for the parameter type: str
- end-ip - No description for the parameter type: str
- fqdn - No description for the parameter type: str
- host - No description for the parameter type: str
- host-type - No description for the parameter type: str choices: [any, specific]
- ip6 - No description for the parameter type: str
- obj-id - No description for the parameter type: str
- sdn - No description for the parameter type: str choices: [nsx]
- start-ip - No description for the parameter type: str
- tags - No description for the parameter type: str
- template - No description for the parameter type: str
- type - No description for the parameter type: str choices: [ipprefix, iprange, nsx, dynamic, fqdn, template]
- uuid - No description for the parameter type: str
- visibility - No description for the parameter type: str choices: [disable, enable]
- _scope - No description for the parameter type: array
- end-ip - Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str
- fqdn - Fully qualified domain name. type: str
- host - Host Address. type: str
- host-type - Host type. type: str choices: [any, specific]
- ip6 - IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). type: str
- list - No description for the parameter type: array
- ip - IP. type: str
- name - Address name. type: str
- obj-id - Object ID for NSX. type: str
- sdn - SDN. type: str choices: [nsx]
- start-ip - First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str
- subnet-segment - No description for the parameter type: array
- name - Name. type: str
- type - Subnet segment type. type: str choices: [any, specific]
- value - Subnet segment value. type: str
- tagging - No description for the parameter type: array
- category - Tag category. type: str
- name - Tagging entry name. type: str
- tags - No description for the parameter type: str
- template - IPv6 address template. type: str
- type - Type of IPv6 address object (default = ipprefix). type: str choices: [ipprefix, iprange, nsx, dynamic, fqdn, template]
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
- visibility - Enable/disable the visibility of the object in the GUI. type: str choices: [disable, enable]
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 IPv6 firewall addresses.
fmgr_firewall_address6:
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_address6:
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of string>
end-ip: <value of string>
fqdn: <value of string>
host: <value of string>
host-type: <value in [any, specific]>
ip6: <value of string>
obj-id: <value of string>
sdn: <value in [nsx]>
start-ip: <value of string>
tags: <value of string>
template: <value of string>
type: <value in [ipprefix, iprange, nsx, ...]>
uuid: <value of string>
visibility: <value in [disable, enable]>
end-ip: <value of string>
fqdn: <value of string>
host: <value of string>
host-type: <value in [any, specific]>
ip6: <value of string>
list:
-
ip: <value of string>
name: <value of string>
obj-id: <value of string>
sdn: <value in [nsx]>
start-ip: <value of string>
subnet-segment:
-
name: <value of string>
type: <value in [any, specific]>
value: <value of string>
tagging:
-
category: <value of string>
name: <value of string>
tags: <value of string>
template: <value of string>
type: <value in [ipprefix, iprange, nsx, ...]>
uuid: <value of string>
visibility: <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