fmgr_pkg_firewall_policy – Configure IPv4 policies.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [add, get, set, update] the following FortiManager json-rpc urls.
- /pm/config/adom/{adom}/pkg/{pkg}/firewall/policy
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way 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 dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- pkg - the object name type: str
- parameters for method: [add, set, update] - Configure IPv4 policies.
- data - No description for the parameter type: array
- action - Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec, ssl-vpn]
- app-category - Application category ID list. type: str
- application - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- application-list - Name of an existing Application list. type: str
- auth-cert - HTTPS server certificate for policy authentication. type: str
- auth-path - Enable/disable authentication-based routing. type: str choices: [disable, enable]
- auth-redirect-addr - HTTP-to-HTTPS redirect address for firewall authentication. type: str
- auto-asic-offload - Enable/disable offloading security profile processing to CP processors. type: str choices: [disable, enable]
- av-profile - Name of an existing Antivirus profile. type: str
- block-notification - Enable/disable block notification. type: str choices: [disable, enable]
- captive-portal-exempt - Enable to exempt some users from the captive portal. type: str choices: [disable, enable]
- capture-packet - Enable/disable capture packets. type: str choices: [disable, enable]
- comments - No description for the parameter type: str
- custom-log-fields - Custom fields to append to log messages for this policy. type: str
- delay-tcp-npu-session - Enable TCP NPU session delay to guarantee packet order of 3-way handshake. type: str choices: [disable, enable]
- devices - Names of devices or device groups that can be matched by the policy. type: str
- diffserv-forward - Enable to change packets DiffServ values to the specified diffservcode-forward value. type: str choices: [disable, enable]
- diffserv-reverse - Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: [disable, enable]
- diffservcode-forward - Change packets DiffServ to this value. type: str
- diffservcode-rev - Change packets reverse (reply) DiffServ to this value. type: str
- disclaimer - Enable/disable user authentication disclaimer. type: str choices: [disable, enable]
- dlp-sensor - Name of an existing DLP sensor. type: str
- dnsfilter-profile - Name of an existing DNS filter profile. type: str
- dscp-match - Enable DSCP check. type: str choices: [disable, enable]
- dscp-negate - Enable negated DSCP match. type: str choices: [disable, enable]
- dscp-value - DSCP value. type: str
- dsri - Enable DSRI to ignore HTTP server responses. type: str choices: [disable, enable]
- dstaddr - Destination address and address group names. type: str
- dstaddr-negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: [disable, enable]
- dstintf - Outgoing (egress) interface. type: str
- 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 sessions source port. type: str choices: [disable, enable]
- fsso - Enable/disable Fortinet Single Sign-On. type: str choices: [disable, enable]
- fsso-agent-for-ntlm - FSSO agent to use for NTLM authentication. type: str
- 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: str
- gtp-profile - GTP profile. type: str
- icap-profile - Name of an existing ICAP profile. type: str
- identity-based-route - Name of identity-based routing rule. type: str
- inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: [disable, enable]
- internet-service - Enable/disable use of Internet Services for this policy. type: str choices: [disable, enable]
- internet-service-custom - Custom Internet Service Name. type: str
- internet-service-id - Internet Service ID. type: str
- internet-service-negate - When enabled internet-service specifies what the service must NOT be. type: str choices: [disable, enable]
- ippool - Enable to use IP Pools for source NAT. type: str choices: [disable, enable]
- ips-sensor - Name of an existing IPS sensor. type: str
- label - Label for the policy that appears when the GUI is in Section View mode. type: str
- learning-mode - Enable to allow everything, but log all of the meaningful data for security information gathering. type: str choices: [disable, enable]
- logtraffic - Enable or disable logging. type: str choices: [disable, enable, all, utm]
- logtraffic-start - Record logs when a session starts and ends. type: str choices: [disable, enable]
- match-vip - Enable to match packets that have had their destination addresses changed by a VIP. type: str choices: [disable, enable]
- mms-profile - Name of an existing MMS profile. type: str
- name - Policy name. type: str
- nat - Enable/disable source NAT. type: str choices: [disable, enable]
- natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: [disable, enable]
- natip - Policy-based IPsec VPN: source NAT IP address for outgoing traffic. type: str
- natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: [disable, enable]
- ntlm - Enable/disable NTLM authentication. type: str choices: [disable, enable]
- ntlm-enabled-browsers - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- ntlm-guest - Enable/disable NTLM guest user access. type: str choices: [disable, enable]
- outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: [disable, enable]
- per-ip-shaper - Per-IP traffic shaper. type: str
- permit-any-host - Accept UDP packets from any host. type: str choices: [disable, enable]
- permit-stun-host - Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. type: str choices: [disable, enable]
- policyid - Policy ID. type: int
- poolname - IP Pool names. type: str
- profile-group - Name of profile group. type: str
- profile-protocol-options - Name of an existing Protocol options profile. type: str
- profile-type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: [single, group]
- radius-mac-auth-bypass - Enable MAC authentication bypass. type: str choices: [disable, enable]
- redirect-url - URL users are directed to after seeing and accepting the disclaimer or authenticating. type: str
- replacemsg-override-group - Override the default replacement message group for this policy. type: str
- rsso - Enable/disable RADIUS single sign-on (RSSO). type: str choices: [disable, enable]
- rtp-addr - Address names if this is an RTP NAT policy. type: str
- rtp-nat - Enable Real Time Protocol (RTP) NAT. type: str choices: [disable, enable]
- scan-botnet-connections - Block or monitor connections to Botnet servers or disable Botnet scanning. type: str choices: [disable, block, monitor]
- schedule - Schedule name. type: str
- schedule-timeout - Enable to force current sessions to end when the schedule object times out. type: str choices: [disable, enable]
- send-deny-packet - Enable to send a reply when a session is denied or blocked by a firewall policy. type: str choices: [disable, enable]
- service - Service and service group names. type: str
- service-negate - When enabled service specifies what the service must NOT be. type: str choices: [disable, enable]
- session-ttl - Session TTL in seconds for sessions accepted by this policy. type: int
- spamfilter-profile - Name of an existing Spam filter profile. type: str
- srcaddr - Source address and address group names. type: str
- srcaddr-negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: [disable, enable]
- srcintf - Incoming (ingress) interface. type: str
- ssl-mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str choices: [disable, enable]
- ssl-mirror-intf - SSL mirror interface name. type: str
- ssl-ssh-profile - Name of an existing SSL SSH profile. type: str
- status - Enable or disable this policy. type: str choices: [disable, enable]
- tags - Names of object-tags applied to this policy. type: str
- 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: [disable, enable]
- traffic-shaper - Traffic shaper. type: str
- traffic-shaper-reverse - Reverse traffic shaper. type: str
- url-category - URL category ID list. type: str
- users - Names of individual users that can authenticate with this policy. type: str
- utm-status - Enable to add one or more security profiles (AV, IPS, etc. type: str choices: [disable, enable]
- 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
- voip-profile - Name of an existing VoIP profile. type: str
- vpn_dst_node - No description for the parameter type: array
- host - No description for the parameter type: str
- seq - No description for the parameter type: int
- subnet - No description for the parameter type: str
- vpn_src_node - No description for the parameter type: array
- host - No description for the parameter type: str
- seq - No description for the parameter type: int
- subnet - No description for the parameter type: str
- vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. type: str
- waf-profile - Name of an existing Web application firewall profile. type: str
- wanopt - Enable/disable WAN optimization. type: str choices: [disable, enable]
- wanopt-detection - WAN optimization auto-detection mode. type: str choices: [active, passive, off]
- wanopt-passive-opt - WAN optimization passive mode options. type: str choices: [default, transparent, non-transparent]
- wanopt-peer - WAN optimization peer. type: str
- wanopt-profile - WAN optimization profile. type: str
- wccp - Enable/disable forwarding traffic matching this policy to a configured WCCP server. type: str choices: [disable, enable]
- webcache - Enable/disable web cache. type: str choices: [disable, enable]
- webcache-https - Enable/disable web cache for HTTPS. type: str choices: [disable, ssl-server, any, enable]
- webfilter-profile - Name of an existing Web filter profile. type: str
- wsso - Enable/disable WiFi Single Sign On (WSSO). type: str choices: [disable, enable]
- parameters for method: [get] - Configure IPv4 policies.
- attr - The name of the attribute to retrieve its datasource. type: str
- fields - No description for the parameter type: array
- {no-name} - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [action, app-category, application, application-list, auth-cert, auth-path, auth-redirect-addr, auto-asic-offload, av-profile, block-notification, captive-portal-exempt, capture-packet, custom-log-fields, delay-tcp-npu-session, devices, diffserv-forward, diffserv-reverse, diffservcode-forward, diffservcode-rev, disclaimer, dlp-sensor, dnsfilter-profile, dscp-match, dscp-negate, dscp-value, dsri, dstaddr, dstaddr-negate, dstintf, firewall-session-dirty, fixedport, fsso, fsso-agent-for-ntlm, global-label, groups, gtp-profile, icap-profile, identity-based-route, inbound, internet-service, internet-service-custom, internet-service-id, internet-service-negate, ippool, ips-sensor, label, learning-mode, logtraffic, logtraffic-start, match-vip, mms-profile, name, nat, natinbound, natip, natoutbound, ntlm, ntlm-enabled-browsers, ntlm-guest, outbound, per-ip-shaper, permit-any-host, permit-stun-host, policyid, poolname, profile-group, profile-protocol-options, profile-type, radius-mac-auth-bypass, redirect-url, replacemsg-override-group, rsso, rtp-addr, rtp-nat, scan-botnet-connections, schedule, schedule-timeout, send-deny-packet, service, service-negate, session-ttl, spamfilter-profile, srcaddr, srcaddr-negate, srcintf, ssl-mirror, ssl-mirror-intf, ssl-ssh-profile, status, tags, tcp-mss-receiver, tcp-mss-sender, tcp-session-without-syn, timeout-send-rst, traffic-shaper, traffic-shaper-reverse, url-category, users, utm-status, uuid, vlan-cos-fwd, vlan-cos-rev, voip-profile, vpntunnel, waf-profile, wanopt, wanopt-detection, wanopt-passive-opt, wanopt-peer, wanopt-profile, wccp, webcache, webcache-https, webfilter-profile, wsso]
- {no-name} - No description for the parameter type: array
- filter - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- get used - No description for the parameter type: int
- loadsub - Enable or disable the return of any sub-objects. type: int
- option - Set fetch option for the request. type: str choices: [count, object member, datasrc, get reserved, syntax]
- range - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- sortings - No description for the parameter type: array
- {attr_name} - No description for the parameter type: int choices: [1, -1]
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
Examples¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: REQUESTING /PM/CONFIG/PKG/{PKG}/FIREWALL/POLICY
fmgr_pkg_firewall_policy:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [add, set, update]>
url_params:
adom: <value in [none, global, custom dom]>
pkg: <value of string>
params:
-
data:
-
action: <value in [deny, accept, ipsec, ...]>
app-category: <value of string>
application:
- <value of integer>
application-list: <value of string>
auth-cert: <value of string>
auth-path: <value in [disable, enable]>
auth-redirect-addr: <value of string>
auto-asic-offload: <value in [disable, enable]>
av-profile: <value of string>
block-notification: <value in [disable, enable]>
captive-portal-exempt: <value in [disable, enable]>
capture-packet: <value in [disable, enable]>
comments: <value of string>
custom-log-fields: <value of string>
delay-tcp-npu-session: <value in [disable, enable]>
devices: <value of string>
diffserv-forward: <value in [disable, enable]>
diffserv-reverse: <value in [disable, enable]>
diffservcode-forward: <value of string>
diffservcode-rev: <value of string>
disclaimer: <value in [disable, enable]>
dlp-sensor: <value of string>
dnsfilter-profile: <value of string>
dscp-match: <value in [disable, enable]>
dscp-negate: <value in [disable, enable]>
dscp-value: <value of string>
dsri: <value in [disable, enable]>
dstaddr: <value of string>
dstaddr-negate: <value in [disable, enable]>
dstintf: <value of string>
firewall-session-dirty: <value in [check-all, check-new]>
fixedport: <value in [disable, enable]>
fsso: <value in [disable, enable]>
fsso-agent-for-ntlm: <value of string>
global-label: <value of string>
groups: <value of string>
gtp-profile: <value of string>
icap-profile: <value of string>
identity-based-route: <value of string>
inbound: <value in [disable, enable]>
internet-service: <value in [disable, enable]>
internet-service-custom: <value of string>
internet-service-id: <value of string>
internet-service-negate: <value in [disable, enable]>
ippool: <value in [disable, enable]>
ips-sensor: <value of string>
label: <value of string>
learning-mode: <value in [disable, enable]>
logtraffic: <value in [disable, enable, all, ...]>
logtraffic-start: <value in [disable, enable]>
match-vip: <value in [disable, enable]>
mms-profile: <value of string>
name: <value of string>
nat: <value in [disable, enable]>
natinbound: <value in [disable, enable]>
natip: <value of string>
natoutbound: <value in [disable, enable]>
ntlm: <value in [disable, enable]>
ntlm-enabled-browsers:
- <value of string>
ntlm-guest: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per-ip-shaper: <value of string>
permit-any-host: <value in [disable, enable]>
permit-stun-host: <value in [disable, enable]>
policyid: <value of integer>
poolname: <value of string>
profile-group: <value of string>
profile-protocol-options: <value of string>
profile-type: <value in [single, group]>
radius-mac-auth-bypass: <value in [disable, enable]>
redirect-url: <value of string>
replacemsg-override-group: <value of string>
rsso: <value in [disable, enable]>
rtp-addr: <value of string>
rtp-nat: <value in [disable, enable]>
scan-botnet-connections: <value in [disable, block, monitor]>
schedule: <value of string>
schedule-timeout: <value in [disable, enable]>
send-deny-packet: <value in [disable, enable]>
service: <value of string>
service-negate: <value in [disable, enable]>
session-ttl: <value of integer>
spamfilter-profile: <value of string>
srcaddr: <value of string>
srcaddr-negate: <value in [disable, enable]>
srcintf: <value of string>
ssl-mirror: <value in [disable, enable]>
ssl-mirror-intf: <value of string>
ssl-ssh-profile: <value of string>
status: <value in [disable, enable]>
tags: <value of string>
tcp-mss-receiver: <value of integer>
tcp-mss-sender: <value of integer>
tcp-session-without-syn: <value in [all, data-only, disable]>
timeout-send-rst: <value in [disable, enable]>
traffic-shaper: <value of string>
traffic-shaper-reverse: <value of string>
url-category: <value of string>
users: <value of string>
utm-status: <value in [disable, enable]>
uuid: <value of string>
vlan-cos-fwd: <value of integer>
vlan-cos-rev: <value of integer>
voip-profile: <value of string>
vpn_dst_node:
-
host: <value of string>
seq: <value of integer>
subnet: <value of string>
vpn_src_node:
-
host: <value of string>
seq: <value of integer>
subnet: <value of string>
vpntunnel: <value of string>
waf-profile: <value of string>
wanopt: <value in [disable, enable]>
wanopt-detection: <value in [active, passive, off]>
wanopt-passive-opt: <value in [default, transparent, non-transparent]>
wanopt-peer: <value of string>
wanopt-profile: <value of string>
wccp: <value in [disable, enable]>
webcache: <value in [disable, enable]>
webcache-https: <value in [disable, ssl-server, any, ...]>
webfilter-profile: <value of string>
wsso: <value in [disable, enable]>
- name: REQUESTING /PM/CONFIG/PKG/{PKG}/FIREWALL/POLICY
fmgr_pkg_firewall_policy:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
pkg: <value of string>
params:
-
attr: <value of string>
fields:
-
- <value in [action, app-category, application, ...]>
filter:
- <value of string>
get used: <value of integer>
loadsub: <value of integer>
option: <value in [count, object member, datasrc, ...]>
range:
- <value of integer>
sortings:
-
varidic.attr_name: <value in [1, -1]>
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:
- return values for method: [add, set, update]
- data
- No description for the parameter type: array
- policyid - Policy ID. type: int
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/pkg/{pkg}/firewall/policy
- return values for method: [get]
- data
- No description for the parameter type: array
- action - Policy action (allow/deny/ipsec). type: str
- app-category - Application category ID list. type: str
- application - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- application-list - Name of an existing Application list. type: str
- auth-cert - HTTPS server certificate for policy authentication. type: str
- auth-path - Enable/disable authentication-based routing. type: str
- auth-redirect-addr - HTTP-to-HTTPS redirect address for firewall authentication. type: str
- auto-asic-offload - Enable/disable offloading security profile processing to CP processors. type: str
- av-profile - Name of an existing Antivirus profile. type: str
- block-notification - Enable/disable block notification. type: str
- captive-portal-exempt - Enable to exempt some users from the captive portal. type: str
- capture-packet - Enable/disable capture packets. type: str
- comments - No description for the parameter type: str
- custom-log-fields - Custom fields to append to log messages for this policy. type: str
- delay-tcp-npu-session - Enable TCP NPU session delay to guarantee packet order of 3-way handshake. type: str
- devices - Names of devices or device groups that can be matched by the policy. type: str
- diffserv-forward - Enable to change packets DiffServ values to the specified diffservcode-forward value. type: str
- diffserv-reverse - Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str
- diffservcode-forward - Change packets DiffServ to this value. type: str
- diffservcode-rev - Change packets reverse (reply) DiffServ to this value. type: str
- disclaimer - Enable/disable user authentication disclaimer. type: str
- dlp-sensor - Name of an existing DLP sensor. type: str
- dnsfilter-profile - Name of an existing DNS filter profile. type: str
- dscp-match - Enable DSCP check. type: str
- dscp-negate - Enable negated DSCP match. type: str
- dscp-value - DSCP value. type: str
- dsri - Enable DSRI to ignore HTTP server responses. type: str
- dstaddr - Destination address and address group names. type: str
- dstaddr-negate - When enabled dstaddr specifies what the destination address must NOT be. type: str
- dstintf - Outgoing (egress) interface. type: str
- firewall-session-dirty - How to handle sessions if the configuration of this firewall policy changes. type: str
- fixedport - Enable to prevent source NAT from changing a sessions source port. type: str
- fsso - Enable/disable Fortinet Single Sign-On. type: str
- fsso-agent-for-ntlm - FSSO agent to use for NTLM authentication. type: str
- 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: str
- gtp-profile - GTP profile. type: str
- icap-profile - Name of an existing ICAP profile. type: str
- identity-based-route - Name of identity-based routing rule. type: str
- inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str
- internet-service - Enable/disable use of Internet Services for this policy. type: str
- internet-service-custom - Custom Internet Service Name. type: str
- internet-service-id - Internet Service ID. type: str
- internet-service-negate - When enabled internet-service specifies what the service must NOT be. type: str
- ippool - Enable to use IP Pools for source NAT. type: str
- ips-sensor - Name of an existing IPS sensor. type: str
- label - Label for the policy that appears when the GUI is in Section View mode. type: str
- learning-mode - Enable to allow everything, but log all of the meaningful data for security information gathering. type: str
- logtraffic - Enable or disable logging. type: str
- logtraffic-start - Record logs when a session starts and ends. type: str
- match-vip - Enable to match packets that have had their destination addresses changed by a VIP. type: str
- mms-profile - Name of an existing MMS profile. type: str
- name - Policy name. type: str
- nat - Enable/disable source NAT. type: str
- natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str
- natip - Policy-based IPsec VPN: source NAT IP address for outgoing traffic. type: str
- natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str
- ntlm - Enable/disable NTLM authentication. type: str
- ntlm-enabled-browsers - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- ntlm-guest - Enable/disable NTLM guest user access. type: str
- outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str
- per-ip-shaper - Per-IP traffic shaper. type: str
- permit-any-host - Accept UDP packets from any host. type: str
- permit-stun-host - Accept UDP packets from any Session Traversal Utilities for NAT (STUN) host. type: str
- policyid - Policy ID. type: int
- poolname - IP Pool names. type: str
- profile-group - Name of profile group. type: str
- profile-protocol-options - Name of an existing Protocol options profile. type: str
- profile-type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str
- radius-mac-auth-bypass - Enable MAC authentication bypass. type: str
- redirect-url - URL users are directed to after seeing and accepting the disclaimer or authenticating. type: str
- replacemsg-override-group - Override the default replacement message group for this policy. type: str
- rsso - Enable/disable RADIUS single sign-on (RSSO). type: str
- rtp-addr - Address names if this is an RTP NAT policy. type: str
- rtp-nat - Enable Real Time Protocol (RTP) NAT. type: str
- scan-botnet-connections - Block or monitor connections to Botnet servers or disable Botnet scanning. type: str
- schedule - Schedule name. type: str
- schedule-timeout - Enable to force current sessions to end when the schedule object times out. type: str
- send-deny-packet - Enable to send a reply when a session is denied or blocked by a firewall policy. type: str
- service - Service and service group names. type: str
- service-negate - When enabled service specifies what the service must NOT be. type: str
- session-ttl - Session TTL in seconds for sessions accepted by this policy. type: int
- spamfilter-profile - Name of an existing Spam filter profile. type: str
- srcaddr - Source address and address group names. type: str
- srcaddr-negate - When enabled srcaddr specifies what the source address must NOT be. type: str
- srcintf - Incoming (ingress) interface. type: str
- ssl-mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str
- ssl-mirror-intf - SSL mirror interface name. type: str
- ssl-ssh-profile - Name of an existing SSL SSH profile. type: str
- status - Enable or disable this policy. type: str
- tags - Names of object-tags applied to this policy. type: str
- 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
- timeout-send-rst - Enable/disable sending RST packets when TCP sessions expire. type: str
- traffic-shaper - Traffic shaper. type: str
- traffic-shaper-reverse - Reverse traffic shaper. type: str
- url-category - URL category ID list. type: str
- users - Names of individual users that can authenticate with this policy. type: str
- utm-status - Enable to add one or more security profiles (AV, IPS, etc. type: str
- 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
- voip-profile - Name of an existing VoIP profile. type: str
- vpn_dst_node - No description for the parameter type: array
- host - No description for the parameter type: str
- seq - No description for the parameter type: int
- subnet - No description for the parameter type: str
- vpn_src_node - No description for the parameter type: array
- host - No description for the parameter type: str
- seq - No description for the parameter type: int
- subnet - No description for the parameter type: str
- vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. type: str
- waf-profile - Name of an existing Web application firewall profile. type: str
- wanopt - Enable/disable WAN optimization. type: str
- wanopt-detection - WAN optimization auto-detection mode. type: str
- wanopt-passive-opt - WAN optimization passive mode options. type: str
- wanopt-peer - WAN optimization peer. type: str
- wanopt-profile - WAN optimization profile. type: str
- wccp - Enable/disable forwarding traffic matching this policy to a configured WCCP server. type: str
- webcache - Enable/disable web cache. type: str
- webcache-https - Enable/disable web cache for HTTPS. type: str
- webfilter-profile - Name of an existing Web filter profile. type: str
- wsso - Enable/disable WiFi Single Sign On (WSSO). type: str
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/pkg/{pkg}/firewall/policy