fortios_firewall_address6 – Configure IPv6 firewall addresses in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and address6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
- firewall_address6 - Configure IPv6 firewall addresses. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- 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). type: int
- comment - Comment. type: str
- 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 - IP address list. type: list
- ip - IP. type: str required: True
- name - Address name. type: str required: True
- obj_id - Object ID for NSX. type: int
- 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 - IPv6 subnet segments. type: list
- name - Name. type: str required: True
- type - Subnet segment type. type: str choices: any, specific
- value - Subnet segment value. type: str
- tagging - Config object tagging type: list
- category - Tag category. Source system.object-tagging.category. type: str
- name - Tagging entry name. type: str required: True
- tags - Tags. type: list
- name - Tag name. Source system.object-tagging.tags.name. type: str required: True
- template - IPv6 address template. Source firewall.address6-template.name. type: str
- type - Type of IPv6 address object . type: str choices: ipprefix, iprange, fqdn, dynamic, 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: enable, disable
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 firewall addresses.
fortios_firewall_address6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_address6:
cache_ttl: "3"
color: "4"
comment: "Comment."
end_ip: "<your_own_value>"
fqdn: "<your_own_value>"
host: "<your_own_value>"
host_type: "any"
ip6: "<your_own_value>"
list:
-
ip: "<your_own_value>"
name: "default_name_13"
obj_id: "14"
sdn: "nsx"
start_ip: "<your_own_value>"
subnet_segment:
-
name: "default_name_18"
type: "any"
value: "<your_own_value>"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_23"
tags:
-
name: "default_name_25 (source system.object-tagging.tags.name)"
template: "<your_own_value> (source firewall.address6-template.name)"
type: "ipprefix"
uuid: "<your_own_value>"
visibility: "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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3