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

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status
Authors

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 ¶

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_policy6 - Configure IPv6 policies. type: dict

state - B(Deprecated) type: str required: False choices: present, absent
action - Policy action (allow/deny/ipsec). type: str choices: accept, deny, ipsec
app_category - Application category ID list. type: list

id - Category IDs. type: int required: True

app_group - Application group names. type: list

name - Application group names. Source application.group.name. type: str required: True

application - Application ID list. type: list

id - Application IDs. type: int required: True

application_list - Name of an existing Application list. Source application.list.name. type: str
av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str
comments - Comment. type: str
custom_log_fields - Log field index numbers to append custom log fields to log messages for this policy. type: list

field_id - Custom log field. Source log.custom-field.id. type: str

devices - Names of devices or device groups that can be matched by the policy. type: list

name - Device or group name. Source user.device.alias user.device-group.name user.device-category.name. type: str required: True

diffserv_forward - Enable to change packet"s DiffServ values to the specified diffservcode-forward value. type: str choices: enable, disable
diffserv_reverse - Enable to change packet"s reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: enable, disable
diffservcode_forward - Change packet"s DiffServ to this value. type: str
diffservcode_rev - Change packet"s reverse (reply) DiffServ to this value. type: str
dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str
dscp_match - Enable DSCP check. type: str choices: enable, disable
dscp_negate - Enable negated DSCP match. type: str choices: enable, disable
dscp_value - DSCP value. type: str
dsri - Enable DSRI to ignore HTTP server responses. type: str choices: enable, disable
dstaddr - Destination address and address group names. type: list

name - Address name. Source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name. type: str required: True

dstaddr_negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: enable, disable
dstintf - Outgoing (egress) interface. type: list

name - Interface name. Source system.interface.name system.zone.name. type: str required: True

firewall_session_dirty - How to handle sessions if the configuration of this firewall policy changes. type: str choices: check-all, check-new
fixedport - Enable to prevent source NAT from changing a session"s source port. type: str choices: enable, disable
global_label - Label for the policy that appears when the GUI is in Global View mode. type: str
groups - Names of user groups that can authenticate with this policy. type: list

name - Group name. Source user.group.name. type: str required: True

icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str
inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: enable, disable
ippool - Enable to use IP Pools for source NAT. type: str choices: enable, disable
ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str
label - Label for the policy that appears when the GUI is in Section View mode. type: str
logtraffic - Enable or disable logging. Log all sessions or security profile sessions. type: str choices: all, utm, disable
logtraffic_start - Record logs when a session starts and ends. type: str choices: enable, disable
name - Policy name. type: str
nat - Enable/disable source NAT. type: str choices: enable, disable
natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: enable, disable
natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: enable, disable
outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: enable, disable
per_ip_shaper - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. type: str
policyid - Policy ID. type: int required: True
poolname - IP Pool names. type: list

name - IP pool name. Source firewall.ippool6.name. type: str required: True

profile_group - Name of profile group. Source firewall.profile-group.name. type: str
profile_protocol_options - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. type: str
profile_type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: single, group
replacemsg_override_group - Override the default replacement message group for this policy. Source system.replacemsg-group.name. type: str
rsso - Enable/disable RADIUS single sign-on (RSSO). type: str choices: enable, disable
schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str
send_deny_packet - Enable/disable return of deny-packet. type: str choices: enable, disable
service - Service and service group names. type: list

name - Address name. Source firewall.service.custom.name firewall.service.group.name. type: str required: True

service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable
session_ttl - Session TTL in seconds for sessions accepted by this policy. 0 means use the system default session TTL. type: int
spamfilter_profile - Name of an existing Spam filter profile. Source spamfilter.profile.name. type: str
srcaddr - Source address and address group names. type: list

name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: True

srcaddr_negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: enable, disable
srcintf - Incoming (ingress) interface. type: list

name - Interface name. Source system.zone.name system.interface.name. type: str required: True

ssh_filter_profile - Name of an existing SSH filter profile. Source ssh-filter.profile.name. type: str
ssl_mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str choices: enable, disable
ssl_mirror_intf - SSL mirror interface name. type: list

name - Interface name. Source system.zone.name system.interface.name. type: str required: True

ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str
status - Enable or disable this policy. type: str choices: enable, disable
tcp_mss_receiver - Receiver TCP maximum segment size (MSS). type: int
tcp_mss_sender - Sender TCP maximum segment size (MSS). type: int
tcp_session_without_syn - Enable/disable creation of TCP session without SYN flag. type: str choices: all, data-only, disable
timeout_send_rst - Enable/disable sending RST packets when TCP sessions expire. type: str choices: enable, disable
traffic_shaper - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
traffic_shaper_reverse - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str
url_category - URL category ID list. type: list

id - URL category ID. type: int required: True

users - Names of individual users that can authenticate with this policy. type: list

name - Names of individual users that can authenticate with this policy. Source user.local.name. type: str required: True

utm_status - Enable AV/web/ips protection profile. type: str choices: enable, disable
uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
vlan_cos_fwd - VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest type: int
vlan_cos_rev - VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest type: int
vlan_filter - Set VLAN filters. type: str
voip_profile - Name of an existing VoIP profile. Source voip.profile.name. type: str
vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name. type: str
webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str

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"
        app_category:
         -
            id:  "5"
        app_group:
         -
            name: "default_name_7 (source application.group.name)"
        application:
         -
            id:  "9"
        application_list: "<your_own_value> (source application.list.name)"
        av_profile: "<your_own_value> (source antivirus.profile.name)"
        comments: "<your_own_value>"
        custom_log_fields:
         -
            field_id: "<your_own_value> (source log.custom-field.id)"
        devices:
         -
            name: "default_name_16 (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)"
        dscp_match: "enable"
        dscp_negate: "enable"
        dscp_value: "<your_own_value>"
        dsri: "enable"
        dstaddr:
         -
            name: "default_name_27 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name)"
        dstaddr_negate: "enable"
        dstintf:
         -
            name: "default_name_30 (source system.interface.name system.zone.name)"
        firewall_session_dirty: "check-all"
        fixedport: "enable"
        global_label: "<your_own_value>"
        groups:
         -
            name: "default_name_35 (source user.group.name)"
        icap_profile: "<your_own_value> (source icap.profile.name)"
        inbound: "enable"
        ippool: "enable"
        ips_sensor: "<your_own_value> (source ips.sensor.name)"
        label: "<your_own_value>"
        logtraffic: "all"
        logtraffic_start: "enable"
        name: "default_name_43"
        nat: "enable"
        natinbound: "enable"
        natoutbound: "enable"
        outbound: "enable"
        per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
        policyid: "49"
        poolname:
         -
            name: "default_name_51 (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_60 (source firewall.service.custom.name firewall.service.group.name)"
        service_negate: "enable"
        session_ttl: "62"
        spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
        srcaddr:
         -
            name: "default_name_65 (source firewall.address6.name firewall.addrgrp6.name)"
        srcaddr_negate: "enable"
        srcintf:
         -
            name: "default_name_68 (source system.zone.name system.interface.name)"
        ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
        ssl_mirror: "enable"
        ssl_mirror_intf:
         -
            name: "default_name_72 (source system.zone.name system.interface.name)"
        ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
        status: "enable"
        tcp_mss_receiver: "75"
        tcp_mss_sender: "76"
        tcp_session_without_syn: "all"
        timeout_send_rst: "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:  "82"
        users:
         -
            name: "default_name_84 (source user.local.name)"
        utm_status: "enable"
        uuid: "<your_own_value>"
        vlan_cos_fwd: "87"
        vlan_cos_rev: "88"
        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)"
        webfilter_profile: "<your_own_value> (source webfilter.profile.name)"

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.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.