fortios_firewall_interface_policy6 – Configure IPv6 interface policies in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and interface_policy6 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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_interface_policy6 - Configure IPv6 interface policies. type: dict more...
- address_type - Policy address type (IPv4 or IPv6). type: str choices: ipv4, ipv6 more...
- application_list - Application list name. Source application.list.name. type: str more...
- application_list_status - Enable/disable application control. type: str choices: enable, disable more...
- av_profile - Antivirus profile. Source antivirus.profile.name. type: str more...
- av_profile_status - Enable/disable antivirus. type: str choices: enable, disable more...
- casb_profile - CASB profile. Source casb.profile.name. type: str more...
- casb_profile_status - Enable/disable CASB. type: str choices: enable, disable more...
- comments - Comments. type: str more...
- dlp_profile - DLP profile name. Source dlp.profile.name. type: str more...
- dlp_profile_status - Enable/disable DLP. type: str choices: enable, disable more...
- dlp_sensor - DLP sensor name. Source dlp.sensor.name. type: str more...
- dlp_sensor_status - Enable/disable DLP. type: str choices: enable, disable more...
- dsri - Enable/disable DSRI. type: str choices: enable, disable more...
- dstaddr6 - IPv6 address object to limit traffic monitoring to network traffic sent to the specified address or range. type: list member_path: dstaddr6:name more...
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true more...
- emailfilter_profile - Email filter profile. Source emailfilter.profile.name. type: str more...
- emailfilter_profile_status - Enable/disable email filter. type: str choices: enable, disable more...
- interface - Monitored interface name from available interfaces. Source system.zone.name system.interface.name. type: str more...
- ips_sensor - IPS sensor name. Source ips.sensor.name. type: str more...
- ips_sensor_status - Enable/disable IPS. type: str choices: enable, disable more...
- label - Label. type: str more...
- logtraffic - Logging type to be used in this policy (Options: all | utm | disable). type: str choices: all, utm, disable more...
- policyid - Policy ID (0 - 4294967295). see Notes. type: int required: true more...
- scan_botnet_connections - Enable/disable scanning for connections to Botnet servers. type: str choices: disable, block, monitor more...
- service6 - Service name. type: list member_path: service6:name more...
- name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...
- spamfilter_profile - Antispam profile. Source spamfilter.profile.name. type: str more...
- spamfilter_profile_status - Enable/disable antispam. type: str choices: enable, disable more...
- srcaddr6 - IPv6 address object to limit traffic monitoring to network traffic sent from the specified address or range. type: list member_path: srcaddr6:name more...
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true more...
- status - Enable/disable this policy. type: str choices: enable, disable more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
- webfilter_profile - Web filter profile. Source webfilter.profile.name. type: str more...
- webfilter_profile_status - Enable/disable web filtering. type: str choices: enable, disable more...
Notes
Note
We highly recommend using your own value as the policyid instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure IPv6 interface policies.
fortinet.fortios.fortios_firewall_interface_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_interface_policy6:
address_type: "ipv4"
application_list: "<your_own_value> (source application.list.name)"
application_list_status: "enable"
av_profile: "<your_own_value> (source antivirus.profile.name)"
av_profile_status: "enable"
casb_profile: "<your_own_value> (source casb.profile.name)"
casb_profile_status: "enable"
comments: "<your_own_value>"
dlp_profile: "<your_own_value> (source dlp.profile.name)"
dlp_profile_status: "enable"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dlp_sensor_status: "enable"
dsri: "enable"
dstaddr6:
-
name: "default_name_17 (source firewall.address6.name firewall.addrgrp6.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
emailfilter_profile_status: "enable"
interface: "<your_own_value> (source system.zone.name system.interface.name)"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
ips_sensor_status: "enable"
label: "<your_own_value>"
logtraffic: "all"
policyid: "<you_own_value>"
scan_botnet_connections: "disable"
service6:
-
name: "default_name_28 (source firewall.service.custom.name firewall.service.group.name)"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
spamfilter_profile_status: "enable"
srcaddr6:
-
name: "default_name_32 (source firewall.address6.name firewall.addrgrp6.name)"
status: "enable"
uuid: "<your_own_value>"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
webfilter_profile_status: "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
Status
This module is not guaranteed to have a backwards compatible interface.