fortinet.fortios.fortios_firewall_policy6 – Configure IPv6 policies in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_firewall_policy6.

New in version 2.10: of fortinet.fortios

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.0

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

firewall_policy6

dictionary

Configure IPv6 policies.

action

string

Policy action (allow/deny/ipsec).

Choices:

  • accept

  • deny

  • ipsec

anti_replay

string

Enable/disable anti-replay check.

Choices:

  • enable

  • disable

app_category

list / elements=string

Application category ID list.

id

integer / required

Category IDs.

app_group

list / elements=string

Application group names.

name

string / required

Application group names. Source application.group.name.

application

list / elements=string

Application ID list.

id

integer / required

Application IDs.

application_list

string

Name of an existing Application list. Source application.list.name.

auto_asic_offload

string

Enable/disable policy traffic ASIC offloading.

Choices:

  • enable

  • disable

av_profile

string

Name of an existing Antivirus profile. Source antivirus.profile.name.

cifs_profile

string

Name of an existing CIFS profile. Source cifs.profile.name.

comments

string

Comment.

custom_log_fields

list / elements=string

Log field index numbers to append custom log fields to log messages for this policy.

field_id

string

Custom log field. Source log.custom-field.id.

devices

list / elements=string

Names of devices or device groups that can be matched by the policy.

name

string / required

Device or group name. Source user.device.alias user.device-group.name user.device-category.name.

diffserv_forward

string

Enable to change packet”s DiffServ values to the specified diffservcode-forward value.

Choices:

  • enable

  • disable

diffserv_reverse

string

Enable to change packet”s reverse (reply) DiffServ values to the specified diffservcode-rev value.

Choices:

  • enable

  • disable

diffservcode_forward

string

Change packet”s DiffServ to this value.

diffservcode_rev

string

Change packet”s reverse (reply) DiffServ to this value.

dlp_sensor

string

Name of an existing DLP sensor. Source dlp.sensor.name.

dnsfilter_profile

string

Name of an existing DNS filter profile. Source dnsfilter.profile.name.

dscp_match

string

Enable DSCP check.

Choices:

  • enable

  • disable

dscp_negate

string

Enable negated DSCP match.

Choices:

  • enable

  • disable

dscp_value

string

DSCP value.

dsri

string

Enable DSRI to ignore HTTP server responses.

Choices:

  • enable

  • disable

dstaddr

list / elements=string

Destination address and address group names.

name

string / required

Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name.

dstaddr_negate

string

When enabled dstaddr specifies what the destination address must NOT be.

Choices:

  • enable

  • disable

dstintf

list / elements=string

Outgoing (egress) interface.

name

string / required

Interface name. Source system.interface.name system.zone.name.

emailfilter_profile

string

Name of an existing email filter profile. Source emailfilter.profile.name.

firewall_session_dirty

string

How to handle sessions if the configuration of this firewall policy changes.

Choices:

  • check-all

  • check-new

fixedport

string

Enable to prevent source NAT from changing a session”s source port.

Choices:

  • enable

  • disable

fsso_groups

list / elements=string

Names of FSSO groups.

name

string / required

Names of FSSO groups. Source user.adgrp.name.

global_label

string

Label for the policy that appears when the GUI is in Global View mode.

groups

list / elements=string

Names of user groups that can authenticate with this policy.

name

string / required

Group name. Source user.group.name.

http_policy_redirect

string

Redirect HTTP(S) traffic to matching transparent web proxy policy.

Choices:

  • enable

  • disable

icap_profile

string

Name of an existing ICAP profile. Source icap.profile.name.

inbound

string

Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN.

Choices:

  • enable

  • disable

inspection_mode

string

Policy inspection mode (Flow/proxy). Default is Flow mode.

Choices:

  • proxy

  • flow

ippool

string

Enable to use IP Pools for source NAT.

Choices:

  • enable

  • disable

ips_sensor

string

Name of an existing IPS sensor. Source ips.sensor.name.

label

string

Label for the policy that appears when the GUI is in Section View mode.

logtraffic

string

Enable or disable logging. Log all sessions or security profile sessions.

Choices:

  • all

  • utm

  • disable

logtraffic_start

string

Record logs when a session starts and ends.

Choices:

  • enable

  • disable

mms_profile

string

Name of an existing MMS profile. Source firewall.mms-profile.name.

name

string

Policy name.

nat

string

Enable/disable source NAT.

Choices:

  • enable

  • disable

natinbound

string

Policy-based IPsec VPN: apply destination NAT to inbound traffic.

Choices:

  • enable

  • disable

natoutbound

string

Policy-based IPsec VPN: apply source NAT to outbound traffic.

Choices:

  • enable

  • disable

np_acceleration

string

Enable/disable UTM Network Processor acceleration.

Choices:

  • enable

  • disable

outbound

string

Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN.

Choices:

  • enable

  • disable

per_ip_shaper

string

Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name.

policyid

integer / required

Policy ID.

poolname

list / elements=string

IP Pool names.

name

string / required

IP pool name. Source firewall.ippool6.name.

profile_group

string

Name of profile group. Source firewall.profile-group.name.

profile_protocol_options

string

Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name.

profile_type

string

Determine whether the firewall policy allows security profile groups or single profiles only.

Choices:

  • single

  • group

replacemsg_override_group

string

Override the default replacement message group for this policy. Source system.replacemsg-group.name.

rsso

string

Enable/disable RADIUS single sign-on (RSSO).

Choices:

  • enable

  • disable

schedule

string

Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name.

send_deny_packet

string

Enable/disable return of deny-packet.

Choices:

  • enable

  • disable

service

list / elements=string

Service and service group names.

name

string / required

Address name. Source firewall.service.custom.name firewall.service.group.name.

service_negate

string

When enabled service specifies what the service must NOT be.

Choices:

  • enable

  • disable

session_ttl

integer

Session TTL in seconds for sessions accepted by this policy. 0 means use the system default session TTL.

spamfilter_profile

string

Name of an existing Spam filter profile. Source spamfilter.profile.name.

srcaddr

list / elements=string

Source address and address group names.

name

string / required

Address name. Source firewall.address6.name firewall.addrgrp6.name.

srcaddr_negate

string

When enabled srcaddr specifies what the source address must NOT be.

Choices:

  • enable

  • disable

srcintf

list / elements=string

Incoming (ingress) interface.

name

string / required

Interface name. Source system.zone.name system.interface.name.

ssh_filter_profile

string

Name of an existing SSH filter profile. Source ssh-filter.profile.name.

ssh_policy_redirect

string

Redirect SSH traffic to matching transparent proxy policy.

Choices:

  • enable

  • disable

ssl_mirror

string

Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring).

Choices:

  • enable

  • disable

ssl_mirror_intf

list / elements=string

SSL mirror interface name.

name

string / required

Interface name. Source system.zone.name system.interface.name.

ssl_ssh_profile

string

Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name.

status

string

Enable or disable this policy.

Choices:

  • enable

  • disable

tcp_mss_receiver

integer

Receiver TCP maximum segment size (MSS).

tcp_mss_sender

integer

Sender TCP maximum segment size (MSS).

tcp_session_without_syn

string

Enable/disable creation of TCP session without SYN flag.

Choices:

  • all

  • data-only

  • disable

timeout_send_rst

string

Enable/disable sending RST packets when TCP sessions expire.

Choices:

  • enable

  • disable

tos

string

ToS (Type of Service) value used for comparison.

tos_mask

string

Non-zero bit positions are used for comparison while zero bit positions are ignored.

tos_negate

string

Enable negated TOS match.

Choices:

  • enable

  • disable

traffic_shaper

string

Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name.

traffic_shaper_reverse

string

Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name.

url_category

list / elements=string

URL category ID list.

id

integer / required

URL category ID.

users

list / elements=string

Names of individual users that can authenticate with this policy.

name

string / required

Names of individual users that can authenticate with this policy. Source user.local.name.

utm_status

string

Enable AV/web/ips protection profile.

Choices:

  • enable

  • disable

uuid

string

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

vlan_cos_fwd

integer

VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest

vlan_cos_rev

integer

VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest

vlan_filter

string

Set VLAN filters.

voip_profile

string

Name of an existing VoIP profile. Source voip.profile.name.

vpntunnel

string

Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name.

waf_profile

string

Name of an existing Web application firewall profile. Source waf.profile.name.

webcache

string

Enable/disable web cache.

Choices:

  • enable

  • disable

webcache_https

string

Enable/disable web cache for HTTPS.

Choices:

  • disable

  • enable

webfilter_profile

string

Name of an existing Web filter profile. Source webfilter.profile.name.

webproxy_forward_server

string

Web proxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name.

webproxy_profile

string

Webproxy profile name. Source web-proxy.profile.name.

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

state

string / required

Indicates whether to create or remove the object.

Choices:

  • present

  • absent

vdom

string

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: “root”

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_firewall_policy6
    fortios_firewall_policy6:
      vdom: root
      state: present
      firewall_policy6:
        action: deny
        anti_replay: enable
        auto_asic_offload: enable
        diffserv_forward: disable
        diffserv_reverse: disable
        diffservcode_forward: '000000'
        diffservcode_rev: '000000'
        dsri: disable
        dstaddr:
        - name: all
        dstaddr_negate: disable
        dstintf:
        - name: port3
        firewall_session_dirty: check-all
        fixedport: disable
        http_policy_redirect: disable
        inbound: disable
        inspection_mode: flow
        ippool: disable
        logtraffic: disable
        logtraffic_start: disable
        name: policy6p1
        nat: disable
        natinbound: disable
        natoutbound: disable
        outbound: disable
        policyid: 1
        profile_type: single
        rsso: disable
        schedule: always
        send_deny_packet: disable
        service:
        - name: ALL
        service_negate: disable
        srcaddr:
        - name: all
        srcaddr_negate: disable
        srcintf:
        - name: port4
        ssh_policy_redirect: disable
        ssl_mirror: disable
        status: enable
        tcp_mss_receiver: 0
        tcp_mss_sender: 0
        tcp_session_without_syn: disable
        timeout_send_rst: disable
        tos: '0x00'
        tos_mask: '0x00'
        tos_negate: disable
        utm_status: disable
        vlan_cos_fwd: 0
        vlan_cos_rev: 0
        webcache: disable
        webcache_https: disable

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

Sample: “v5.6.3”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)