fmgr_pkg_firewall_policy – Configure IPv4 policies.¶

New in version 2.10.

Synopsis
Requirements
FortiManager Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements ¶

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

ansible>=2.9.0

FortiManager Version Compatibility ¶

	`6.0.0`	`6.2.1`	`6.2.3`	`6.2.5`	`6.4.0`	`6.4.2`	`6.4.5`	`7.0.0`	`7.2.0`
pkg_firewall_policy	yes	yes	yes	yes	yes	yes	yes	yes	yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
state - The directive to create, update or delete an object type: str required: true choices: present, absent
adom - The parameter in requested url type: str required: true
pkg - The parameter in requested url type: str required: true
pkg_firewall_policy - no description type: dict

action - Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec, ssl-vpn, redirect, isolate] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

action True True True True True True True True True
app-category - Application category ID list. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

app-category True True True True False False False False False
application - Application ID list. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

application True True True True False False False False False
application-list - Name of an existing Application list. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

application-list True True True True True True True True True
auth-cert - HTTPS server certificate for policy authentication. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

auth-cert True True True True True True True True True
auth-path - Enable/disable authentication-based routing. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

auth-path True True True True True True True True True
auth-redirect-addr - HTTP-to-HTTPS redirect address for firewall authentication. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

auth-redirect-addr True True True True True True True True True
auto-asic-offload - Enable/disable offloading security profile processing to CP processors. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

auto-asic-offload True True True True True True True True True
av-profile - Name of an existing Antivirus profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

av-profile True True True True True True True True True
block-notification - Enable/disable block notification. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

block-notification True True True True True True True True True
captive-portal-exempt - Enable to exempt some users from the captive portal. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

captive-portal-exempt True True True True True True True True True
capture-packet - Enable/disable capture packets. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

capture-packet True True True True True True True True True
comments - No description for the parameter type: str
custom-log-fields - Custom fields to append to log messages for this policy. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

custom-log-fields True True True True True True True True True
delay-tcp-npu-session - Enable TCP NPU session delay to guarantee packet order of 3-way handshake. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

delay-tcp-npu-session True True True True True True True True True
devices - Names of devices or device groups that can be matched by the policy. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

devices True False False False False False False False False
diffserv-forward - Enable to change packets DiffServ values to the specified diffservcode-forward value. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

diffserv-forward True True True True True True True True True
diffserv-reverse - Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

diffserv-reverse True True True True True True True True True
diffservcode-forward - Change packets DiffServ to this value. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

diffservcode-forward True True True True True True True True True
diffservcode-rev - Change packets reverse (reply) DiffServ to this value. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

diffservcode-rev True True True True True True True True True
disclaimer - Enable/disable user authentication disclaimer. type: str choices: [disable, enable, user, domain, policy] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

disclaimer True True True True True True True True True
dlp-sensor - Name of an existing DLP sensor. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dlp-sensor True True True True True True True True False
dnsfilter-profile - Name of an existing DNS filter profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dnsfilter-profile True True True True True True True True True
dscp-match - Enable DSCP check. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dscp-match True False False False False False False False False
dscp-negate - Enable negated DSCP match. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dscp-negate True False False False False False False False False
dscp-value - DSCP value. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dscp-value True False False False False False False False False
dsri - Enable DSRI to ignore HTTP server responses. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dsri True True True True True True True True True
dstaddr - Destination address and address group names. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dstaddr True True True True True True True True True
dstaddr-negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dstaddr-negate True True True True True True True True True
dstintf - Outgoing (egress) interface. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dstintf True True True True True True True True True
firewall-session-dirty - How to handle sessions if the configuration of this firewall policy changes. type: str choices: [check-all, check-new] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

firewall-session-dirty True True True True True True True True True
fixedport - Enable to prevent source NAT from changing a sessions source port. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

fixedport True True True True True True True True True
fsso - Enable/disable Fortinet Single Sign-On. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

fsso True True True True False False False False False
fsso-agent-for-ntlm - FSSO agent to use for NTLM authentication. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

fsso-agent-for-ntlm True True True True True True True True True
global-label - Label for the policy that appears when the GUI is in Global View mode. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

global-label True True True True True True True True True
groups - Names of user groups that can authenticate with this policy. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

groups True True True True True True True True True
gtp-profile - GTP profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

gtp-profile True True True True True True True True True
icap-profile - Name of an existing ICAP profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

icap-profile True True True True True True True True True
identity-based-route - Name of identity-based routing rule. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

identity-based-route True True True True True True True True True
inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

inbound True True True True True True True True True
internet-service - Enable/disable use of Internet Services for this policy. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service True True True True True True True True True
internet-service-custom - Custom Internet Service Name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-custom True True True True True True True True True
internet-service-id - Internet Service ID. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-id True True True True False False False False False
internet-service-negate - When enabled internet-service specifies what the service must NOT be. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-negate True True True True True True True True True
ippool - Enable to use IP Pools for source NAT. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ippool True True True True True True True True True
ips-sensor - Name of an existing IPS sensor. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ips-sensor True True True True True True True True True
label - Label for the policy that appears when the GUI is in Section View mode. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

label True True True True True True True True True
learning-mode - Enable to allow everything, but log all of the meaningful data for security information gathering. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

learning-mode True False False False False False False False False
logtraffic - Enable or disable logging. type: str choices: [disable, enable, all, utm] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

logtraffic True True True True True True True True True
logtraffic-start - Record logs when a session starts and ends. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

logtraffic-start True True True True True True True True True
match-vip - Enable to match packets that have had their destination addresses changed by a VIP. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

match-vip True True True True True True True True True
mms-profile - Name of an existing MMS profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

mms-profile True True True True False False False False False
name - Policy name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

name True True True True True True True True True
nat - Enable/disable source NAT. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

nat True True True True True True True True True
natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

natinbound True True True True True True True True True
natip - Policy-based IPsec VPN: source NAT IP address for outgoing traffic. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

natip True True True True True True True True True
natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

natoutbound True True True True True True True True True
ntlm - Enable/disable NTLM authentication. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ntlm True True True True True True True True True
ntlm-enabled-browsers - HTTP-User-Agent value of supported browsers. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ntlm-enabled-browsers True True True True True True True True True
ntlm-guest - Enable/disable NTLM guest user access. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ntlm-guest True True True True True True True True True
outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

outbound True True True True True True True True True
per-ip-shaper - Per-IP traffic shaper. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

per-ip-shaper True True True True True True True True True
permit-any-host - Accept UDP packets from any host. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

permit-any-host True True True True True True True True True
permit-stun-host - Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

permit-stun-host True True True True True True True True True
policyid - Policy ID. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

policyid True True True True True True True True True
poolname - IP Pool names. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

poolname True True True True True True True True True
profile-group - Name of profile group. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

profile-group True True True True True True True True True
profile-protocol-options - Name of an existing Protocol options profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

profile-protocol-options True True True True True True True True True
profile-type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: [single, group] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

profile-type True True True True True True True True True
radius-mac-auth-bypass - Enable MAC authentication bypass. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

radius-mac-auth-bypass True True True True True True True True True
redirect-url - URL users are directed to after seeing and accepting the disclaimer or authenticating. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

redirect-url True True True True True True True True True
replacemsg-override-group - Override the default replacement message group for this policy. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

replacemsg-override-group True True True True True True True True True
rsso - Enable/disable RADIUS single sign-on (RSSO). type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

rsso True True True True False False False False False
rtp-addr - Address names if this is an RTP NAT policy. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

rtp-addr True True True True True True True True True
rtp-nat - Enable Real Time Protocol (RTP) NAT. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

rtp-nat True True True True True True True True True
scan-botnet-connections - Block or monitor connections to Botnet servers or disable Botnet scanning. type: str choices: [disable, block, monitor] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

scan-botnet-connections True False False False False False False False False
schedule - Schedule name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

schedule True True True True True True True True True
schedule-timeout - Enable to force current sessions to end when the schedule object times out. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

schedule-timeout True True True True True True True True True
send-deny-packet - Enable to send a reply when a session is denied or blocked by a firewall policy. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

send-deny-packet True True True True True True True True True
service - Service and service group names. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

service True True True True True True True True True
service-negate - When enabled service specifies what the service must NOT be. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

service-negate True True True True True True True True True
session-ttl - Session TTL in seconds for sessions accepted by this policy. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

session-ttl True True True True True True True True True
spamfilter-profile - Name of an existing Spam filter profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

spamfilter-profile True False False False False False False False False
srcaddr - Source address and address group names. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

srcaddr True True True True True True True True True
srcaddr-negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

srcaddr-negate True True True True True True True True True
srcintf - Incoming (ingress) interface. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

srcintf True True True True True True True True True
ssl-mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ssl-mirror True True True True False False False False False
ssl-mirror-intf - SSL mirror interface name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ssl-mirror-intf True True True True False False False False False
ssl-ssh-profile - Name of an existing SSL SSH profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ssl-ssh-profile True True True True True True True True True
status - Enable or disable this policy. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

status True True True True True True True True True
tags - Names of object-tags applied to this policy. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tags True False False False False False False False False
tcp-mss-receiver - Receiver TCP maximum segment size (MSS). type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tcp-mss-receiver True True True True True True True True True
tcp-mss-sender - Sender TCP maximum segment size (MSS). type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tcp-mss-sender True True True True True True True True True
tcp-session-without-syn - Enable/disable creation of TCP session without SYN flag. type: str choices: [all, data-only, disable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tcp-session-without-syn True True True True True True True True True
timeout-send-rst - Enable/disable sending RST packets when TCP sessions expire. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

timeout-send-rst True True True True True True True True True
traffic-shaper - Traffic shaper. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

traffic-shaper True True True True True True True True True
traffic-shaper-reverse - Reverse traffic shaper. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

traffic-shaper-reverse True True True True True True True True True
url-category - URL category ID list. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

url-category True True True True False False False False False
users - Names of individual users that can authenticate with this policy. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

users True True True True True True True True True
utm-status - Enable to add one or more security profiles (AV, IPS, etc. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

utm-status True True True True True True True True True
uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

uuid True True True True True True True True True
vlan-cos-fwd - VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

vlan-cos-fwd True True True True True True True True True
vlan-cos-rev - VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

vlan-cos-rev True True True True True True True True True
voip-profile - Name of an existing VoIP profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

voip-profile True True True True True True True True True
vpn_dst_node - Vpn_Dst_Node. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

vpn_dst_node True True True True True True True True False
- host - Host. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  host True True True True True True True True False
- seq - Seq. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  seq True True True True True True True True False
- subnet - Subnet. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  subnet True True True True True True True True False
vpn_src_node - Vpn_Src_Node. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

vpn_src_node True True True True True True True True False
- host - Host. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  host True True True True True True True True False
- seq - Seq. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  seq True True True True True True True True False
- subnet - Subnet. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  subnet True True True True True True True True False
vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

vpntunnel True True True True True True True True True
waf-profile - Name of an existing Web application firewall profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

waf-profile True True True True True True True True True
wanopt - Enable/disable WAN optimization. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

wanopt True True True True True True True True True
wanopt-detection - WAN optimization auto-detection mode. type: str choices: [active, passive, off] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

wanopt-detection True True True True True True True True True
wanopt-passive-opt - WAN optimization passive mode options. type: str choices: [default, transparent, non-transparent] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

wanopt-passive-opt True True True True True True True True True
wanopt-peer - WAN optimization peer. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

wanopt-peer True True True True True True True True True
wanopt-profile - WAN optimization profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

wanopt-profile True True True True True True True True True
wccp - Enable/disable forwarding traffic matching this policy to a configured WCCP server. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

wccp True True True True True True True True True
webcache - Enable/disable web cache. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

webcache True True True True True True True True True
webcache-https - Enable/disable web cache for HTTPS. type: str choices: [disable, ssl-server, any, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

webcache-https True True True True True True True True True
webfilter-profile - Name of an existing Web filter profile. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

webfilter-profile True True True True True True True True True
wsso - Enable/disable WiFi Single Sign On (WSSO). type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

wsso True True True True False False False False False
anti-replay - Enable/disable anti-replay check. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

anti-replay True True True True True True True True
app-group - Application group names. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

app-group True True True False False False False False
cifs-profile - Name of an existing CIFS profile. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

cifs-profile True True True True True True True True
email-collect - Enable/disable email collection. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

email-collect True True True True True True True True
emailfilter-profile - Name of an existing email filter profile. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

emailfilter-profile True True True True True True True True
fsso-groups - Names of FSSO groups. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

fsso-groups True True True True True True True True
geoip-anycast - Enable/disable recognition of anycast IP addresses using the geography IP database. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

geoip-anycast True True True True True True True True
http-policy-redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

http-policy-redirect True True True True True True True True
inspection-mode - Policy inspection mode (Flow/proxy). type: str choices: [proxy, flow] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

inspection-mode True True True True True True True True
internet-service-custom-group - Custom Internet Service group name. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-custom-group True True True True True True True True
internet-service-group - Internet Service group name. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-group True True True True True True True True
internet-service-src - Enable/disable use of Internet Services in source for this policy. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-src True True True True True True True True
internet-service-src-custom - Custom Internet Service source name. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-src-custom True True True True True True True True
internet-service-src-custom-group - Custom Internet Service source group name. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-src-custom-group True True True True True True True True
internet-service-src-group - Internet Service source group name. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-src-group True True True True True True True True
internet-service-src-id - Internet Service source ID. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-src-id True True True False False False False False
internet-service-src-negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-src-negate True True True True True True True True
match-vip-only - Enable/disable matching of only those packets that have had their destination addresses changed by a VIP. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

match-vip-only True True True True True True True True
np-acceleration - Enable/disable UTM Network Processor acceleration. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

np-acceleration True True True True True True True True
reputation-direction - Direction of the initial traffic for reputation to take effect. type: str choices: [source, destination] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

reputation-direction True True True True True True True True
reputation-minimum - Minimum Reputation to take action. type: int more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

reputation-minimum True True True True True True True True
ssh-filter-profile - Name of an existing SSH filter profile. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ssh-filter-profile True True True True True True True True
ssh-policy-redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ssh-policy-redirect True True True True True True True True
tos - ToS (Type of Service) value used for comparison. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tos True True True True True True True True
tos-mask - Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tos-mask True True True True True True True True
tos-negate - Enable negated TOS match. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tos-negate True True True True True True True True
vlan-filter - Set VLAN filters. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

vlan-filter True True True True True True True True
webproxy-forward-server - Webproxy forward server name. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

webproxy-forward-server True True True True True True True True
webproxy-profile - Webproxy profile name. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

webproxy-profile True True True True True True True True
best-route - Enable/disable the use of best route. type: str choices: [disable, enable] more...

6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

best-route True True False False False False False
decrypted-traffic-mirror - Decrypted traffic mirror. type: str more...

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

decrypted-traffic-mirror True True True True True
dstaddr6 - Destination IPv6 address name and address group names. type: str more...

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dstaddr6 True True True True True
geoip-match - Match geography address based either on its physical location or registered location. type: str choices: [physical-location, registered-location] more...

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

geoip-match True True True True True
internet-service-name - Internet Service name. type: str more...

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-name True True True True True
internet-service-src-name - Internet Service source name. type: str more...

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

internet-service-src-name True True True True True
poolname6 - IPv6 pool names. type: str more...

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

poolname6 True True True True True
src-vendor-mac - Vendor MAC source ID. type: str more...

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

src-vendor-mac True True True True True
srcaddr6 - Source IPv6 address name and address group names. type: str more...

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

srcaddr6 True True True True True
file-filter-profile - Name of an existing file-filter profile. type: str more...

6.4.2 6.4.5 7.0.0 7.2.0

file-filter-profile True True True True
dynamic-shaping - Enable/disable dynamic RADIUS defined traffic shaping. type: str choices: [disable, enable] more...

7.0.0 7.2.0

dynamic-shaping True True
passive-wan-health-measurement - Enable/disable passive WAN health measurement. type: str choices: [disable, enable] more...

7.0.0 7.2.0

passive-wan-health-measurement True True
videofilter-profile - Name of an existing VideoFilter profile. type: str more...

7.0.0 7.2.0

videofilter-profile True True
ztna-ems-tag - Source ztna-ems-tag names. type: str more...

7.0.0 7.2.0

ztna-ems-tag True True
ztna-geo-tag - Source ztna-geo-tag names. type: str more...

7.0.0 7.2.0

ztna-geo-tag True True
ztna-status - Enable/disable zero trust access. type: str choices: [disable, enable] more...

7.0.0 7.2.0

ztna-status True True
_policy_block - Assigned policy block. type: int more...

7.2.0

_policy_block True
dlp-profile - Name of an existing DLP profile. type: str more...

7.2.0

dlp-profile True
fec - Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. type: str choices: [disable, enable] more...

7.2.0

fec True
nat46 - Enable/disable NAT46. type: str choices: [disable, enable] more...

7.2.0

nat46 True
nat64 - Enable/disable NAT64. type: str choices: [disable, enable] more...

7.2.0

nat64 True
pfcp-profile - PFCP profile. type: str more...

7.2.0

pfcp-profile True
policy-expiry - Enable/disable policy expiry. type: str choices: [disable, enable] more...

7.2.0

policy-expiry True
policy-expiry-date - Policy expiry date (YYYY-MM-DD HH:MM:SS). type: str more...

7.2.0

policy-expiry-date True
sctp-filter-profile - Name of an existing SCTP filter profile. type: str more...

7.2.0

sctp-filter-profile True
sgt - No description for the parameter type: int more...

7.2.0

sgt True
sgt-check - Enable/disable security group tags (SGT) check. type: str choices: [disable, enable] more...

7.2.0

sgt-check True
object position - No description for the parameter type: list

Notes ¶

Note

Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state: present directive.
To delete an object, use state: absent directive
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples ¶

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv4 policies.
     fmgr_pkg_firewall_policy:
        bypass_validation: False
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_policy:
           action: accept #<value in [deny, accept, ipsec, ...]>
           comments: ansible-comment
           dstaddr: all
           dstintf: any
           #name: ansible-test-policy
           nat: disable
           policyid: 1
           schedule: always
           service: ALL
           srcaddr: all
           srcintf: any
           status: disable

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the IPv4 policies
     fmgr_fact:
       facts:
           selector: 'pkg_firewall_policy'
           params:
               adom: 'ansible'
               pkg: 'ansible' # package name
               policy: 'your_value'

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:

request_url - The full url requested returned: always type: str sample: /sys/login/user
response_code - The status of api request returned: always type: int sample: 0
response_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

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