fortios_firewall_policy – Configure IPv4 policies

New in version 2.8.

Synopsis

  • This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall feature and policy category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

The below requirements are needed on the host that executes this module.

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments
firewall_policy
-
Default:
null
Configure IPv4 policies.
action
-
    Choices:
  • accept
  • deny
  • ipsec
Policy action (allow/deny/ipsec).
app-category
-
Application category ID list.
id
- / required
Category IDs.
app-group
-
Application group names.
name
- / required
Application group names. Source application.group.name.
application
-
Application ID list.
id
- / required
Application IDs.
application-list
-
Name of an existing Application list. Source application.list.name.
auth-cert
-
HTTPS server certificate for policy authentication. Source vpn.certificate.local.name.
auth-path
-
    Choices:
  • enable
  • disable
Enable/disable authentication-based routing.
auth-redirect-addr
-
HTTP-to-HTTPS redirect address for firewall authentication.
av-profile
-
Name of an existing Antivirus profile. Source antivirus.profile.name.
block-notification
-
    Choices:
  • enable
  • disable
Enable/disable block notification.
captive-portal-exempt
-
    Choices:
  • enable
  • disable
Enable to exempt some users from the captive portal.
capture-packet
-
    Choices:
  • enable
  • disable
Enable/disable capture packets.
comments
-
Comment.
custom-log-fields
-
Custom fields to append to log messages for this policy.
field-id
- / required
Custom log field. Source log.custom-field.id.
delay-tcp-npu-session
-
    Choices:
  • enable
  • disable
Enable TCP NPU session delay to guarantee packet order of 3-way handshake.
devices
-
Names of devices or device groups that can be matched by the policy.
name
- / required
Device or group name. Source user.device.alias user.device-group.name user.device-category.name.
diffserv-forward
-
    Choices:
  • enable
  • disable
Enable to change packet's DiffServ values to the specified diffservcode-forward value.
diffserv-reverse
-
    Choices:
  • enable
  • disable
Enable to change packet's reverse (reply) DiffServ values to the specified diffservcode-rev value.
diffservcode-forward
-
Change packet's DiffServ to this value.
diffservcode-rev
-
Change packet's reverse (reply) DiffServ to this value.
disclaimer
-
    Choices:
  • enable
  • disable
Enable/disable user authentication disclaimer.
dlp-sensor
-
Name of an existing DLP sensor. Source dlp.sensor.name.
dnsfilter-profile
-
Name of an existing DNS filter profile. Source dnsfilter.profile.name.
dscp-match
-
    Choices:
  • enable
  • disable
Enable DSCP check.
dscp-negate
-
    Choices:
  • enable
  • disable
Enable negated DSCP match.
dscp-value
-
DSCP value.
dsri
-
    Choices:
  • enable
  • disable
Enable DSRI to ignore HTTP server responses.
dstaddr
-
Destination address and address group names.
name
- / required
Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name.
dstaddr-negate
-
    Choices:
  • enable
  • disable
When enabled dstaddr specifies what the destination address must NOT be.
dstintf
-
Outgoing (egress) interface.
name
- / required
Interface name. Source system.interface.name system.zone.name.
firewall-session-dirty
-
    Choices:
  • check-all
  • check-new
How to handle sessions if the configuration of this firewall policy changes.
fixedport
-
    Choices:
  • enable
  • disable
Enable to prevent source NAT from changing a session's source port.
fsso
-
    Choices:
  • enable
  • disable
Enable/disable Fortinet Single Sign-On.
fsso-agent-for-ntlm
-
FSSO agent to use for NTLM authentication. Source user.fsso.name.
global-label
-
Label for the policy that appears when the GUI is in Global View mode.
groups
-
Names of user groups that can authenticate with this policy.
name
- / required
Group name. Source user.group.name.
icap-profile
-
Name of an existing ICAP profile. Source icap.profile.name.
identity-based-route
-
Name of identity-based routing rule. Source firewall.identity-based-route.name.
inbound
-
    Choices:
  • enable
  • disable
Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN.
internet-service
-
    Choices:
  • enable
  • disable
Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used.
internet-service-custom
-
Custom Internet Service name.
name
- / required
Custom Internet Service name. Source firewall.internet-service-custom.name.
internet-service-id
-
Internet Service ID.
id
- / required
Internet Service ID. Source firewall.internet-service.id.
internet-service-negate
-
    Choices:
  • enable
  • disable
When enabled internet-service specifies what the service must NOT be.
internet-service-src
-
    Choices:
  • enable
  • disable
Enable/disable use of Internet Services in source for this policy. If enabled, source address is not used.
internet-service-src-custom
-
Custom Internet Service source name.
name
- / required
Custom Internet Service name. Source firewall.internet-service-custom.name.
internet-service-src-id
-
Internet Service source ID.
id
- / required
Internet Service ID. Source firewall.internet-service.id.
internet-service-src-negate
-
    Choices:
  • enable
  • disable
When enabled internet-service-src specifies what the service must NOT be.
ippool
-
    Choices:
  • enable
  • disable
Enable to use IP Pools for source NAT.
ips-sensor
-
Name of an existing IPS sensor. Source ips.sensor.name.
label
-
Label for the policy that appears when the GUI is in Section View mode.
learning-mode
-
    Choices:
  • enable
  • disable
Enable to allow everything, but log all of the meaningful data for security information gathering. A learning report will be generated.
logtraffic
-
    Choices:
  • all
  • utm
  • disable
Enable or disable logging. Log all sessions or security profile sessions.
logtraffic-start
-
    Choices:
  • enable
  • disable
Record logs when a session starts and ends.
match-vip
-
    Choices:
  • enable
  • disable
Enable to match packets that have had their destination addresses changed by a VIP.
name
-
Policy name.
nat
-
    Choices:
  • enable
  • disable
Enable/disable source NAT.
natinbound
-
    Choices:
  • enable
  • disable
Policy-based IPsec VPN: apply destination NAT to inbound traffic.
natip
-
Policy-based IPsec VPN: source NAT IP address for outgoing traffic.
natoutbound
-
    Choices:
  • enable
  • disable
Policy-based IPsec VPN: apply source NAT to outbound traffic.
ntlm
-
    Choices:
  • enable
  • disable
Enable/disable NTLM authentication.
ntlm-enabled-browsers
-
HTTP-User-Agent value of supported browsers.
user-agent-string
- / required
User agent string.
ntlm-guest
-
    Choices:
  • enable
  • disable
Enable/disable NTLM guest user access.
outbound
-
    Choices:
  • enable
  • disable
Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN.
per-ip-shaper
-
Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name.
permit-any-host
-
    Choices:
  • enable
  • disable
Accept UDP packets from any host.
permit-stun-host
-
    Choices:
  • enable
  • disable
Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host.
policyid
- / required
Policy ID.
poolname
-
IP Pool names.
name
- / required
IP pool name. Source firewall.ippool.name.
profile-group
-
Name of profile group. Source firewall.profile-group.name.
profile-protocol-options
-
Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name.
profile-type
-
    Choices:
  • single
  • group
Determine whether the firewall policy allows security profile groups or single profiles only.
radius-mac-auth-bypass
-
    Choices:
  • enable
  • disable
Enable MAC authentication bypass. The bypassed MAC address must be received from RADIUS server.
redirect-url
-
URL users are directed to after seeing and accepting the disclaimer or authenticating.
replacemsg-override-group
-
Override the default replacement message group for this policy. Source system.replacemsg-group.name.
rsso
-
    Choices:
  • enable
  • disable
Enable/disable RADIUS single sign-on (RSSO).
rtp-addr
-
Address names if this is an RTP NAT policy.
name
- / required
Address name. Source firewall.address.name firewall.addrgrp.name.
rtp-nat
-
    Choices:
  • disable
  • enable
Enable Real Time Protocol (RTP) NAT.
scan-botnet-connections
-
    Choices:
  • disable
  • block
  • monitor
Block or monitor connections to Botnet servers or disable Botnet scanning.
schedule
-
Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name.
schedule-timeout
-
    Choices:
  • enable
  • disable
Enable to force current sessions to end when the schedule object times out. Disable allows them to end from inactivity.
send-deny-packet
-
    Choices:
  • disable
  • enable
Enable to send a reply when a session is denied or blocked by a firewall policy.
service
-
Service and service group names.
name
- / required
Service and service group names. Source firewall.service.custom.name firewall.service.group.name.
service-negate
-
    Choices:
  • enable
  • disable
When enabled service specifies what the service must NOT be.
session-ttl
-
TTL in seconds for sessions accepted by this policy (0 means use the system default session TTL).
spamfilter-profile
-
Name of an existing Spam filter profile. Source spamfilter.profile.name.
srcaddr
-
Source address and address group names.
name
- / required
Address name. Source firewall.address.name firewall.addrgrp.name.
srcaddr-negate
-
    Choices:
  • enable
  • disable
When enabled srcaddr specifies what the source address must NOT be.
srcintf
-
Incoming (ingress) interface.
name
- / required
Interface name. Source system.interface.name system.zone.name.
ssh-filter-profile
-
Name of an existing SSH filter profile. Source ssh-filter.profile.name.
ssl-mirror
-
    Choices:
  • enable
  • disable
Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring).
ssl-mirror-intf
-
SSL mirror interface name.
name
- / required
Mirror Interface name. Source system.interface.name system.zone.name.
ssl-ssh-profile
-
Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name.
state
-
    Choices:
  • present
  • absent
Indicates whether to create or remove the object
status
-
    Choices:
  • enable
  • disable
Enable or disable this policy.
tcp-mss-receiver
-
Receiver TCP maximum segment size (MSS).
tcp-mss-sender
-
Sender TCP maximum segment size (MSS).
tcp-session-without-syn
-
    Choices:
  • all
  • data-only
  • disable
Enable/disable creation of TCP session without SYN flag.
timeout-send-rst
-
    Choices:
  • enable
  • disable
Enable/disable sending RST packets when TCP sessions expire.
traffic-shaper
-
Traffic shaper. Source firewall.shaper.traffic-shaper.name.
traffic-shaper-reverse
-
Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name.
url-category
-
URL category ID list.
id
- / required
URL category ID.
users
-
Names of individual users that can authenticate with this policy.
name
- / required
Names of individual users that can authenticate with this policy. Source user.local.name.
utm-status
-
    Choices:
  • enable
  • disable
Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy.
uuid
-
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
vlan-cos-fwd
-
VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest.
vlan-cos-rev
-
VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest..
vlan-filter
-
Set VLAN filters.
voip-profile
-
Name of an existing VoIP profile. Source voip.profile.name.
vpntunnel
-
Policy-based IPsec VPN: name of the IPsec VPN Phase 1. Source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name.
waf-profile
-
Name of an existing Web application firewall profile. Source waf.profile.name.
wanopt
-
    Choices:
  • enable
  • disable
Enable/disable WAN optimization.
wanopt-detection
-
    Choices:
  • active
  • passive
  • no
WAN optimization auto-detection mode.
wanopt-passive-opt
-
    Choices:
  • default
  • transparent
  • non-transparent
WAN optimization passive mode options. This option decides what IP address will be used to connect server.
wanopt-peer
-
WAN optimization peer. Source wanopt.peer.peer-host-id.
wanopt-profile
-
WAN optimization profile. Source wanopt.profile.name.
wccp
-
    Choices:
  • enable
  • disable
Enable/disable forwarding traffic matching this policy to a configured WCCP server.
webcache
-
    Choices:
  • enable
  • disable
Enable/disable web cache.
webcache-https
-
    Choices:
  • disable
  • enable
Enable/disable web cache for HTTPS.
webfilter-profile
-
Name of an existing Web filter profile. Source webfilter.profile.name.
wsso
-
    Choices:
  • enable
  • disable
Enable/disable WiFi Single Sign On (WSSO).
host
- / required
FortiOS or FortiGate ip address.
https
boolean
    Choices:
  • no ←
  • yes
Indicates if the requests towards FortiGate must use HTTPS protocol
password
-
Default:
""
FortiOS or FortiGate password.
username
- / required
FortiOS or FortiGate username.
vdom
-
Default:
"root"
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.

Notes

Note

  • Requires fortiosapi library developed by Fortinet

  • Run as a local_action in your playbook

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure IPv4 policies.
    fortios_firewall_policy:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_policy:
        state: "present"
        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)"
        auth-cert: "<your_own_value> (source vpn.certificate.local.name)"
        auth-path: "enable"
        auth-redirect-addr: "<your_own_value>"
        av-profile: "<your_own_value> (source antivirus.profile.name)"
        block-notification: "enable"
        captive-portal-exempt: "enable"
        capture-packet: "enable"
        comments: "<your_own_value>"
        custom-log-fields:
         -
            field-id: "<your_own_value> (source log.custom-field.id)"
        delay-tcp-npu-session: "enable"
        devices:
         -
            name: "default_name_23 (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>"
        disclaimer: "enable"
        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_36 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name)"
        dstaddr-negate: "enable"
        dstintf:
         -
            name: "default_name_39 (source system.interface.name system.zone.name)"
        firewall-session-dirty: "check-all"
        fixedport: "enable"
        fsso: "enable"
        fsso-agent-for-ntlm: "<your_own_value> (source user.fsso.name)"
        global-label: "<your_own_value>"
        groups:
         -
            name: "default_name_46 (source user.group.name)"
        icap-profile: "<your_own_value> (source icap.profile.name)"
        identity-based-route: "<your_own_value> (source firewall.identity-based-route.name)"
        inbound: "enable"
        internet-service: "enable"
        internet-service-custom:
         -
            name: "default_name_52 (source firewall.internet-service-custom.name)"
        internet-service-id:
         -
            id:  "54 (source firewall.internet-service.id)"
        internet-service-negate: "enable"
        internet-service-src: "enable"
        internet-service-src-custom:
         -
            name: "default_name_58 (source firewall.internet-service-custom.name)"
        internet-service-src-id:
         -
            id:  "60 (source firewall.internet-service.id)"
        internet-service-src-negate: "enable"
        ippool: "enable"
        ips-sensor: "<your_own_value> (source ips.sensor.name)"
        label: "<your_own_value>"
        learning-mode: "enable"
        logtraffic: "all"
        logtraffic-start: "enable"
        match-vip: "enable"
        name: "default_name_69"
        nat: "enable"
        natinbound: "enable"
        natip: "<your_own_value>"
        natoutbound: "enable"
        ntlm: "enable"
        ntlm-enabled-browsers:
         -
            user-agent-string: "<your_own_value>"
        ntlm-guest: "enable"
        outbound: "enable"
        per-ip-shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
        permit-any-host: "enable"
        permit-stun-host: "enable"
        policyid: "82"
        poolname:
         -
            name: "default_name_84 (source firewall.ippool.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"
        radius-mac-auth-bypass: "enable"
        redirect-url: "<your_own_value>"
        replacemsg-override-group: "<your_own_value> (source system.replacemsg-group.name)"
        rsso: "enable"
        rtp-addr:
         -
            name: "default_name_93 (source firewall.address.name firewall.addrgrp.name)"
        rtp-nat: "disable"
        scan-botnet-connections: "disable"
        schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
        schedule-timeout: "enable"
        send-deny-packet: "disable"
        service:
         -
            name: "default_name_100 (source firewall.service.custom.name firewall.service.group.name)"
        service-negate: "enable"
        session-ttl: "102"
        spamfilter-profile: "<your_own_value> (source spamfilter.profile.name)"
        srcaddr:
         -
            name: "default_name_105 (source firewall.address.name firewall.addrgrp.name)"
        srcaddr-negate: "enable"
        srcintf:
         -
            name: "default_name_108 (source system.interface.name system.zone.name)"
        ssh-filter-profile: "<your_own_value> (source ssh-filter.profile.name)"
        ssl-mirror: "enable"
        ssl-mirror-intf:
         -
            name: "default_name_112 (source system.interface.name system.zone.name)"
        ssl-ssh-profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
        status: "enable"
        tcp-mss-receiver: "115"
        tcp-mss-sender: "116"
        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:  "122"
        users:
         -
            name: "default_name_124 (source user.local.name)"
        utm-status: "enable"
        uuid: "<your_own_value>"
        vlan-cos-fwd: "127"
        vlan-cos-rev: "128"
        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)"
        wanopt: "enable"
        wanopt-detection: "active"
        wanopt-passive-opt: "default"
        wanopt-peer: "<your_own_value> (source wanopt.peer.peer-host-id)"
        wanopt-profile: "<your_own_value> (source wanopt.profile.name)"
        wccp: "enable"
        webcache: "enable"
        webcache-https: "disable"
        webfilter-profile: "<your_own_value> (source webfilter.profile.name)"
        wsso: "enable"

Return Values

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

Key Returned Description
build
string
 always
Build number of the fortigate image

Sample:
1547
http_method
string
 always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
 always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
 success
Master key (id) used in the last call to FortiGate

Sample:
key1
name
string
 always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
 always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
 always
Internal revision number

Sample:
17.0.2.10658
serial
string
 always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
 always
Indication of the operation's result

Sample:
success
vdom
string
 always
Virtual domain used

Sample:
root
version
string
 always
Version of the FortiGate

Sample:
v5.6.3


Status

Authors

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.