fortinet.fortios.fortios_firewall_policy6 module – Configure IPv6 policies in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.2.1).
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.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_policy6.
New in fortinet.fortios 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 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.9
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure IPv6 policies. |
|
Policy action (allow/deny/ipsec). Choices:
|
|
Enable/disable anti-replay check. Choices:
|
|
Application category ID list. |
|
Category IDs. |
|
Application group names. |
|
Application group names. Source application.group.name. |
|
Application ID list. |
|
Application IDs. |
|
Name of an existing Application list. Source application.list.name. |
|
Enable/disable policy traffic ASIC offloading. Choices:
|
|
Name of an existing Antivirus profile. Source antivirus.profile.name. |
|
Name of an existing CIFS profile. Source cifs.profile.name. |
|
Comment. |
|
Log field index numbers to append custom log fields to log messages for this policy. |
|
Custom log field. Source log.custom-field.id. |
|
Names of devices or device groups that can be matched by the policy. |
|
Device or group name. Source user.device.alias user.device-group.name user.device-category.name. |
|
Enable to change packet”s DiffServ values to the specified diffservcode-forward value. Choices:
|
|
Enable to change packet”s reverse (reply) DiffServ values to the specified diffservcode-rev value. Choices:
|
|
Change packet”s DiffServ to this value. |
|
Change packet”s reverse (reply) DiffServ to this value. |
|
Name of an existing DLP sensor. Source dlp.sensor.name. |
|
Name of an existing DNS filter profile. Source dnsfilter.profile.name. |
|
Enable DSCP check. Choices:
|
|
Enable negated DSCP match. Choices:
|
|
DSCP value. |
|
Enable DSRI to ignore HTTP server responses. Choices:
|
|
Destination address and address group names. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system .external-resource.name. |
|
When enabled dstaddr specifies what the destination address must NOT be. Choices:
|
|
Outgoing (egress) interface. |
|
Interface name. Source system.interface.name system.zone.name. |
|
Name of an existing email filter profile. Source emailfilter.profile.name. |
|
How to handle sessions if the configuration of this firewall policy changes. Choices:
|
|
Enable to prevent source NAT from changing a session”s source port. Choices:
|
|
Names of FSSO groups. |
|
Names of FSSO groups. Source user.adgrp.name. |
|
Label for the policy that appears when the GUI is in Global View mode. |
|
Names of user groups that can authenticate with this policy. |
|
Group name. Source user.group.name. |
|
Redirect HTTP(S) traffic to matching transparent web proxy policy. Choices:
|
|
Name of an existing ICAP profile. Source icap.profile.name. |
|
Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. Choices:
|
|
Policy inspection mode (Flow/proxy). Default is Flow mode. Choices:
|
|
Enable to use IP Pools for source NAT. Choices:
|
|
Name of an existing IPS sensor. Source ips.sensor.name. |
|
Label for the policy that appears when the GUI is in Section View mode. |
|
Enable or disable logging. Log all sessions or security profile sessions. Choices:
|
|
Record logs when a session starts. Choices:
|
|
Name of an existing MMS profile. Source firewall.mms-profile.name. |
|
Policy name. |
|
Enable/disable source NAT. Choices:
|
|
Policy-based IPsec VPN: apply destination NAT to inbound traffic. Choices:
|
|
Policy-based IPsec VPN: apply source NAT to outbound traffic. Choices:
|
|
Enable/disable UTM Network Processor acceleration. Choices:
|
|
Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. Choices:
|
|
Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. |
|
Policy ID (0 - 4294967294). |
|
IP Pool names. |
|
IP pool name. Source firewall.ippool6.name. |
|
Name of profile group. Source firewall.profile-group.name. |
|
Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. |
|
Determine whether the firewall policy allows security profile groups or single profiles only. Choices:
|
|
Override the default replacement message group for this policy. Source system.replacemsg-group.name. |
|
Enable/disable RADIUS single sign-on (RSSO). Choices:
|
|
Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. |
|
Enable/disable return of deny-packet. Choices:
|
|
Service and service group names. |
|
Address name. Source firewall.service.custom.name firewall.service.group.name. |
|
When enabled service specifies what the service must NOT be. Choices:
|
|
Session TTL in seconds for sessions accepted by this policy. 0 means use the system default session TTL. |
|
Name of an existing Spam filter profile. Source spamfilter.profile.name. |
|
Source address and address group names. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. |
|
When enabled srcaddr specifies what the source address must NOT be. Choices:
|
|
Incoming (ingress) interface. |
|
Interface name. Source system.zone.name system.interface.name. |
|
Name of an existing SSH filter profile. Source ssh-filter.profile.name. |
|
Redirect SSH traffic to matching transparent proxy policy. Choices:
|
|
Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). Choices:
|
|
SSL mirror interface name. |
|
Interface name. Source system.zone.name system.interface.name. |
|
Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. |
|
Enable or disable this policy. Choices:
|
|
Receiver TCP maximum segment size (MSS). |
|
Sender TCP maximum segment size (MSS). |
|
Enable/disable creation of TCP session without SYN flag. Choices:
|
|
Enable/disable sending RST packets when TCP sessions expire. Choices:
|
|
ToS (Type of Service) value used for comparison. |
|
Non-zero bit positions are used for comparison while zero bit positions are ignored. |
|
Enable negated TOS match. Choices:
|
|
Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
|
Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
|
URL category ID list. |
|
URL category ID. |
|
Names of individual users that can authenticate with this policy. |
|
Names of individual users that can authenticate with this policy. Source user.local.name. |
|
Enable AV/web/ips protection profile. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest |
|
VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest |
|
Set VLAN filters. |
|
Name of an existing VoIP profile. Source voip.profile.name. |
|
Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. |
|
Name of an existing Web application firewall profile. Source waf.profile.name. |
|
Enable/disable web cache. Choices:
|
|
Enable/disable web cache for HTTPS. Choices:
|
|
Name of an existing Web filter profile. Source webfilter.profile.name. |
|
Web proxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. |
|
Webproxy profile name. Source web-proxy.profile.name. |
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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 policies.
fortios_firewall_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_policy6:
action: "accept"
anti_replay: "enable"
app_category:
-
id: "6"
app_group:
-
name: "default_name_8 (source application.group.name)"
application:
-
id: "10"
application_list: "<your_own_value> (source application.list.name)"
auto_asic_offload: "enable"
av_profile: "<your_own_value> (source antivirus.profile.name)"
cifs_profile: "<your_own_value> (source cifs.profile.name)"
comments: "<your_own_value>"
custom_log_fields:
-
field_id: "<your_own_value> (source log.custom-field.id)"
devices:
-
name: "default_name_19 (source user.device.alias user.device-group.name user.device-category.name)"
diffserv_forward: "enable"
diffserv_reverse: "enable"
diffservcode_forward: "<your_own_value>"
diffservcode_rev: "<your_own_value>"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
dscp_match: "enable"
dscp_negate: "enable"
dscp_value: "<your_own_value>"
dsri: "enable"
dstaddr:
-
name: "default_name_31 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system.external-resource
.name)"
dstaddr_negate: "enable"
dstintf:
-
name: "default_name_34 (source system.interface.name system.zone.name)"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
firewall_session_dirty: "check-all"
fixedport: "enable"
fsso_groups:
-
name: "default_name_39 (source user.adgrp.name)"
global_label: "<your_own_value>"
groups:
-
name: "default_name_42 (source user.group.name)"
http_policy_redirect: "enable"
icap_profile: "<your_own_value> (source icap.profile.name)"
inbound: "enable"
inspection_mode: "proxy"
ippool: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
label: "<your_own_value>"
logtraffic: "all"
logtraffic_start: "enable"
mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
name: "default_name_53"
nat: "enable"
natinbound: "enable"
natoutbound: "enable"
np_acceleration: "enable"
outbound: "enable"
per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
policyid: "2147483647"
poolname:
-
name: "default_name_62 (source firewall.ippool6.name)"
profile_group: "<your_own_value> (source firewall.profile-group.name)"
profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
profile_type: "single"
replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
rsso: "enable"
schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
send_deny_packet: "enable"
service:
-
name: "default_name_71 (source firewall.service.custom.name firewall.service.group.name)"
service_negate: "enable"
session_ttl: "<your_own_value>"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
srcaddr:
-
name: "default_name_76 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
srcaddr_negate: "enable"
srcintf:
-
name: "default_name_79 (source system.zone.name system.interface.name)"
ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
ssh_policy_redirect: "enable"
ssl_mirror: "enable"
ssl_mirror_intf:
-
name: "default_name_84 (source system.zone.name system.interface.name)"
ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
status: "enable"
tcp_mss_receiver: "32767"
tcp_mss_sender: "32767"
tcp_session_without_syn: "all"
timeout_send_rst: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
tos_negate: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
url_category:
-
id: "97"
users:
-
name: "default_name_99 (source user.local.name)"
utm_status: "enable"
uuid: "<your_own_value>"
vlan_cos_fwd: "3"
vlan_cos_rev: "3"
vlan_filter: "<your_own_value>"
voip_profile: "<your_own_value> (source voip.profile.name)"
vpntunnel: "<your_own_value> (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)"
waf_profile: "<your_own_value> (source waf.profile.name)"
webcache: "enable"
webcache_https: "disable"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
webproxy_forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |