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