fmgr_pkg_footer_policy – Configure IPv4/IPv6 policies.¶
New in version 2.10.
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_footer_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
- pkg - The parameter in requested url type: str required: true
- pkg_footer_policy - no description type: dict
- action - No description for the parameter type: str choices: [deny, accept, ipsec, ssl-vpn, redirect, isolate] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0action True True True True True True True True True - active-auth-method - No description for the parameter type: str choices: [ntlm, basic, digest, form] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0active-auth-method True True True True True True True True True - anti-replay - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0anti-replay True True True True True True True True True - app-category - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0app-category True True True True False False False False False - app-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0app-group True True True True False False False False False - application - No description for the parameter type: int more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0application True True True True False False False False False - application-charts - No description for the parameter type: array choices: [top10-app, top10-p2p-user, top10-media-user] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0application-charts True True True True True True True True True - application-list - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0application-list True True True True True True True True True - auth-cert - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0auth-cert True True True True True True True True True - auth-method - No description for the parameter type: str choices: [basic, digest, ntlm, fsae, form, fsso, rsso] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0auth-method True True True True True True True True True - auth-path - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0auth-path True True True True True True True True True - auth-portal - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0auth-portal True True True True True True True True True - auth-redirect-addr - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0auth-redirect-addr True True True True True True True True True - auto-asic-offload - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0auto-asic-offload True True True True True True True True True - av-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0av-profile True True True True True True True True True - bandwidth - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0bandwidth True True True True True True True True True - block-notification - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0block-notification True True True True True True True True True - captive-portal-exempt - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0captive-portal-exempt True True True True True True True True True - capture-packet - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0capture-packet True True True True True True True True True - casi-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0casi-profile True True True True True True True True True - central-nat - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0central-nat True True True True True True True True True - cifs-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0cifs-profile True True True True True True True True True - client-reputation - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0client-reputation True True True True True True True True True - client-reputation-mode - No description for the parameter type: str choices: [learning, monitoring] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0client-reputation-mode True True True True True True True True True - comments - No description for the parameter type: str
- custom-log-fields - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0custom-log-fields True True True True True True True True True - deep-inspection-options - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0deep-inspection-options True True True True True True True True True - delay-tcp-npu-session - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0delay-tcp-npu-session True True True True True True True True True - delay-tcp-npu-sessoin - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0delay-tcp-npu-sessoin True True True True True True True True True - device-detection-portal - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0device-detection-portal True True True True True True True True True - devices - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0devices True False False False True True True True True - diffserv-forward - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0diffserv-forward True True True True True True True True True - diffserv-reverse - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0diffserv-reverse True True True True True True True True True - diffservcode-forward - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0diffservcode-forward True True True True True True True True True - diffservcode-rev - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0diffservcode-rev True True True True True True True True True - disclaimer - No description for the parameter type: str choices: [disable, enable, user, domain, policy] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0disclaimer True True True True True True True True True - dlp-sensor - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dlp-sensor True True True True True True True True True - dnsfilter-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dnsfilter-profile True True True True True True True True True - dponly - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dponly True True True True True True True True True - dscp-match - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dscp-match True True True True True True True True True - dscp-negate - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dscp-negate True True True True True True True True True - dscp-value - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dscp-value True True True True True True True True True - dsri - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dsri True True True True True True True True True - dstaddr - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dstaddr True True True True True True True True True - dstaddr-negate - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dstaddr-negate True True True True True True True True True - dstaddr6 - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dstaddr6 True True True True True True True True True - dstintf - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dstintf True True True True True True True True True - dynamic-profile - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dynamic-profile True True True True True True True True True - dynamic-profile-access - No description for the parameter type: array choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, ftps, ssh] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dynamic-profile-access True True True True True True True True True - dynamic-profile-fallthrough - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dynamic-profile-fallthrough True True True True True True True True True - dynamic-profile-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dynamic-profile-group True True True True True True True True True - email-collect - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0email-collect True True True True True True True True True - email-collection-portal - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0email-collection-portal True True True True True True True True True - emailfilter-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0emailfilter-profile True True True True True True True True True - endpoint-check - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0endpoint-check True True True True True True True True True - endpoint-compliance - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0endpoint-compliance True True True True True True True True True - endpoint-keepalive-interface - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0endpoint-keepalive-interface True True True True True True True True True - endpoint-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0endpoint-profile True True True True True True True True True - failed-connection - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0failed-connection True True True True True True True True True - fall-through-unauthenticated - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0fall-through-unauthenticated True True True True True True True True True - firewall-session-dirty - No description for the parameter type: str choices: [check-all, check-new] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0firewall-session-dirty True True True True True True True True True - fixedport - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0fixedport True True True True True True True True True - forticlient-compliance-devices - No description for the parameter type: array choices: [windows-pc, mac, iphone-ipad, android] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0forticlient-compliance-devices True True True True True True True True True - forticlient-compliance-enforcement-portal - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0forticlient-compliance-enforcement-portal True True True True True True True True True - fsae - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0fsae True True True True True True True True True - fsae-server-for-ntlm - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0fsae-server-for-ntlm True True True True True True True True True - fsso - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0fsso True True True True True True True True True - fsso-agent-for-ntlm - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0fsso-agent-for-ntlm True True True True True True True True True - geo-location - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0geo-location True True True True True True True True True - geoip-anycast - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0geoip-anycast True True True True True True True True True - global-label - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0global-label True True True True True True True True True - groups - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0groups True True True True True True True True True - gtp-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0gtp-profile True True True True True True True True True - http-policy-redirect - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0http-policy-redirect True True True True True True True True True - icap-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0icap-profile True True True True True True True True True - identity-based - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0identity-based True True True True True True True True True - identity-based-policy - No description for the parameter type: array
more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0identity-based-policy True False False False False False False False False - action - No description for the parameter type: str choices: [deny, accept] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0action True False False False False False False False False - application-charts - No description for the parameter type: array choices: [top10-app, top10-p2p-user, top10-media-user] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0application-charts True False False False False False False False False - application-list - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0application-list True False False False False False False False False - av-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0av-profile True False False False False False False False False - capture-packet - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0capture-packet True False False False False False False False False - deep-inspection-options - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0deep-inspection-options True False False False False False False False False - devices - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0devices True False False False False False False False False - dlp-sensor - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dlp-sensor True False False False False False False False False - dstaddr - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dstaddr True False False False False False False False False - dstaddr-negate - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0dstaddr-negate True False False False False False False False False - endpoint-compliance - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0endpoint-compliance True False False False False False False False False - groups - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0groups True False False False False False False False False - icap-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0icap-profile True False False False False False False False False - id - No description for the parameter type: int more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0id True False False False False False False False False - ips-sensor - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ips-sensor True False False False False False False False False - logtraffic - No description for the parameter type: str choices: [disable, enable, all, utm] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0logtraffic True False False False False False False False False - logtraffic-app - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0logtraffic-app True False False False False False False False False - logtraffic-start - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0logtraffic-start True False False False False False False False False - mms-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0mms-profile True False False False False False False False False - per-ip-shaper - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0per-ip-shaper True False False False False False False False False - profile-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0profile-group True False False False False False False False False - profile-protocol-options - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0profile-protocol-options True False False False False False False False False - profile-type - No description for the parameter type: str choices: [single, group] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0profile-type True False False False False False False False False - replacemsg-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0replacemsg-group True False False False False False False False False - schedule - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0schedule True False False False False False False False False - send-deny-packet - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0send-deny-packet True False False False False False False False False - service - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0service True False False False False False False False False - service-negate - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0service-negate True False False False False False False False False - spamfilter-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0spamfilter-profile True False False False False False False False False - sslvpn-portal - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0sslvpn-portal True False False False False False False False False - sslvpn-realm - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0sslvpn-realm True False False False False False False False False - traffic-shaper - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0traffic-shaper True False False False False False False False False - traffic-shaper-reverse - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0traffic-shaper-reverse True False False False False False False False False - users - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0users True False False False False False False False False - utm-status - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0utm-status True False False False False False False False False - voip-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0voip-profile True False False False False False False False False - webfilter-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0webfilter-profile True False False False False False False False False
- action - No description for the parameter type: str choices: [deny, accept] more...
- identity-based-route - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0identity-based-route True True True True True True True True True - identity-from - No description for the parameter type: str choices: [auth, device] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0identity-from True True True True True True True True True - inbound - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0inbound True True True True True True True True True - inspection-mode - No description for the parameter type: str choices: [proxy, flow] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0inspection-mode True True True True True True True True True - internet-service - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service True True True True True True True True True - internet-service-custom - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-custom True True True True True True True True True - internet-service-custom-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-custom-group True True True True True True True True True - internet-service-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-group True True True True True True True True True - internet-service-id - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-id True True True True True True True True True - internet-service-negate - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-negate True True True True True True True True True - internet-service-src - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-src True True True True True True True True True - internet-service-src-custom - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-src-custom True True True True True True True True True - internet-service-src-custom-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-src-custom-group True True True True True True True True True - internet-service-src-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-src-group True True True True True True True True True - internet-service-src-id - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-src-id True True True True True True True True True - internet-service-src-negate - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0internet-service-src-negate True True True True True True True True True - ip-based - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ip-based True True True True True True True True True - ippool - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ippool True True True True True True True True True - ips-sensor - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ips-sensor True True True True True True True True True - label - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0label True True True True True True True True True - learning-mode - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0learning-mode True True True True True True True True True - log-unmatched-traffic - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0log-unmatched-traffic True True True True True True True True True - logtraffic - No description for the parameter type: str choices: [disable, enable, all, utm] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0logtraffic True True True True True True True True True - logtraffic-app - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0logtraffic-app True True True True True True True True True - logtraffic-start - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0logtraffic-start True True True True True True True True True - match-vip - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0match-vip True True True True True True True True True - mms-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0mms-profile True True True True True True True True True - name - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0name True True True True True True True True True - nat - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0nat True True True True True True True True True - natinbound - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0natinbound True True True True True True True True True - natip - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0natip True True True True True True True True True - natoutbound - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0natoutbound True True True True True True True True True - np-acceleration - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0np-acceleration True True True True True True True True True - ntlm - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ntlm True True True True True True True True True - ntlm-enabled-browsers - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ntlm-enabled-browsers True True True True True True True True True - ntlm-guest - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ntlm-guest True True True True True True True True True - outbound - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0outbound True True True True True True True True True - per-ip-shaper - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0per-ip-shaper True True True True True True True True True - permit-any-host - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0permit-any-host True True True True True True True True True - permit-stun-host - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0permit-stun-host True True True True True True True True True - policyid - No description for the parameter type: int more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0policyid True True True True True True True True True - poolname - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0poolname True True True True True True True True True - profile-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0profile-group True True True True True True True True True - profile-protocol-options - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0profile-protocol-options True True True True True True True True True - profile-type - No description for the parameter type: str choices: [single, group] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0profile-type True True True True True True True True True - radius-mac-auth-bypass - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0radius-mac-auth-bypass True True True True True True True True True - redirect-url - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0redirect-url True True True True True True True True True - replacemsg-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0replacemsg-group True True True True True True True True True - replacemsg-override-group - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0replacemsg-override-group True True True True True True True True True - reputation-direction - No description for the parameter type: str choices: [source, destination] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0reputation-direction True True True True True True True True True - reputation-minimum - No description for the parameter type: int more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0reputation-minimum True True True True True True True True True - require-tfa - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0require-tfa True True True True True True True True True - rsso - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0rsso True True True True True True True True True - rtp-addr - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0rtp-addr True True True True True True True True True - rtp-nat - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0rtp-nat True True True True True True True True True - scan-botnet-connections - No description for the parameter type: str choices: [disable, block, monitor] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0scan-botnet-connections True True True True True True True True True - schedule - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0schedule True True True True True True True True True - schedule-timeout - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0schedule-timeout True True True True True True True True True - send-deny-packet - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0send-deny-packet True True True True True True True True True - service - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0service True True True True True True True True True - service-negate - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0service-negate True True True True True True True True True - session-ttl - No description for the parameter type: int more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0session-ttl True True True True True True True True True - sessions - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0sessions True True True True True True True True True - spamfilter-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0spamfilter-profile True True True True True True True True True - srcaddr - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0srcaddr True True True True True True True True True - srcaddr-negate - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0srcaddr-negate True True True True True True True True True - srcaddr6 - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0srcaddr6 True True True True True True True True True - srcintf - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0srcintf True True True True True True True True True - ssh-filter-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ssh-filter-profile True True True True True True True True True - ssh-policy-redirect - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ssh-policy-redirect True True True True True True True True True - ssl-mirror - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ssl-mirror True True True True True True True True True - ssl-mirror-intf - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ssl-mirror-intf True True True True True True True True True - ssl-ssh-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0ssl-ssh-profile True True True True True True True True True - sslvpn-auth - No description for the parameter type: str choices: [any, local, radius, ldap, tacacs+] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0sslvpn-auth True True True True True True True True True - sslvpn-ccert - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0sslvpn-ccert True True True True True True True True True - sslvpn-cipher - No description for the parameter type: str choices: [any, high, medium] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0sslvpn-cipher True True True True True True True True True - sso-auth-method - No description for the parameter type: str choices: [fsso, rsso] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0sso-auth-method True True True True True True True True True - status - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0status True True True True True True True True True - tags - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0tags True True True True True True True True True - tcp-mss-receiver - No description for the parameter type: int more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0tcp-mss-receiver True True True True True True True True True - tcp-mss-sender - No description for the parameter type: int more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0tcp-mss-sender True True True True True True True True True - tcp-reset - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0tcp-reset True True True True True True True True True - tcp-session-without-syn - No description for the parameter type: str choices: [all, data-only, disable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0tcp-session-without-syn True True True True True True True True True - timeout-send-rst - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0timeout-send-rst True True True True True True True True True - tos - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0tos True True True True True True True True True - tos-mask - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0tos-mask True True True True True True True True True - tos-negate - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0tos-negate True True True True True True True True True - traffic-shaper - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0traffic-shaper True True True True True True True True True - traffic-shaper-reverse - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0traffic-shaper-reverse True True True True True True True True True - transaction-based - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0transaction-based True True True True True True True True True - url-category - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0url-category True True True True False False False False False - users - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0users True True True True True True True True True - utm-inspection-mode - No description for the parameter type: str choices: [proxy, flow] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0utm-inspection-mode True True True True True True True True True - utm-status - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0utm-status True True True True True True True True True - uuid - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0uuid True True True True True True True True True - vlan-cos-fwd - No description for the parameter type: int more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0vlan-cos-fwd True True True True True True True True True - vlan-cos-rev - No description for the parameter type: int more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0vlan-cos-rev True True True True True True True True True - vlan-filter - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0vlan-filter True True True True True True True True True - voip-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0voip-profile True True True True True True True True True - vpntunnel - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0vpntunnel True True True True True True True True True - waf-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0waf-profile True True True True True True True True True - wanopt - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0wanopt True True True True True True True True True - wanopt-detection - No description for the parameter type: str choices: [active, passive, off] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0wanopt-detection True True True True True True True True True - wanopt-passive-opt - No description for the parameter type: str choices: [default, transparent, non-transparent] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0wanopt-passive-opt True True True True True True True True True - wanopt-peer - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0wanopt-peer True True True True True True True True True - wanopt-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0wanopt-profile True True True True True True True True True - wccp - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0wccp True True True True True True True True True - web-auth-cookie - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0web-auth-cookie True True True True True True True True True - webcache - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0webcache True True True True True True True True True - webcache-https - No description for the parameter type: str choices: [disable, ssl-server, any, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0webcache-https True True True True True True True True True - webfilter-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0webfilter-profile True True True True True True True True True - webproxy-forward-server - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0webproxy-forward-server True True True True True True True True True - webproxy-profile - No description for the parameter type: str more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0webproxy-profile True True True True True True True True True - wsso - No description for the parameter type: str choices: [disable, enable] more...
6.0.06.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0wsso True True True True True True True True True - fsso-groups - No description for the parameter type: str more...
6.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0fsso-groups True True True True True True True True - match-vip-only - No description for the parameter type: str choices: [disable, enable] more...
6.2.16.2.36.2.56.4.06.4.26.4.57.0.07.2.0match-vip-only True True True True True True True True - best-route - No description for the parameter type: str choices: [disable, enable] more...
6.2.36.2.56.4.06.4.26.4.57.0.07.2.0best-route True True True True True True True - decrypted-traffic-mirror - No description for the parameter type: str more...
6.4.06.4.26.4.57.0.07.2.0decrypted-traffic-mirror True True True True True - geoip-match - No description for the parameter type: str choices: [physical-location, registered-location] more...
6.4.06.4.26.4.57.0.07.2.0geoip-match True True True True True - internet-service-name - No description for the parameter type: str more...
6.4.06.4.26.4.57.0.07.2.0internet-service-name True True True True True - internet-service-src-name - No description for the parameter type: str more...
6.4.06.4.26.4.57.0.07.2.0internet-service-src-name True True True True True - poolname6 - No description for the parameter type: str more...
6.4.06.4.26.4.57.0.07.2.0poolname6 True True True True True - src-vendor-mac - No description for the parameter type: str more...
6.4.06.4.26.4.57.0.07.2.0src-vendor-mac True True True True True - vendor-mac - No description for the parameter type: str more...
6.4.06.4.26.4.57.0.07.2.0vendor-mac True True True True True - file-filter-profile - No description for the parameter type: str more...
6.4.26.4.57.0.07.2.0file-filter-profile True True True True - cgn-eif - No description for the parameter type: str choices: [disable, enable] more...
6.4.57.0.07.2.0cgn-eif True True True - cgn-eim - No description for the parameter type: str choices: [disable, enable] more...
6.4.57.0.07.2.0cgn-eim True True True - cgn-log-server-grp - No description for the parameter type: str more...
6.4.57.0.07.2.0cgn-log-server-grp True True True - cgn-resource-quota - No description for the parameter type: int more...
6.4.57.0.07.2.0cgn-resource-quota True True True - cgn-session-quota - No description for the parameter type: int more...
6.4.57.0.07.2.0cgn-session-quota True True True - policy-offload - No description for the parameter type: str choices: [disable, enable] more...
6.4.57.0.07.2.0policy-offload True True True - dynamic-shaping - Enable/disable dynamic RADIUS defined traffic shaping. type: str choices: [disable, enable] more...
7.0.07.2.0dynamic-shaping True True - passive-wan-health-measurement - Enable/disable passive WAN health measurement. type: str choices: [disable, enable] more...
7.0.07.2.0passive-wan-health-measurement True True - videofilter-profile - Name of an existing VideoFilter profile. type: str more...
7.0.07.2.0videofilter-profile True True - ztna-ems-tag - Source ztna-ems-tag names. type: str more...
7.0.07.2.0ztna-ems-tag True True - ztna-geo-tag - Source ztna-geo-tag names. type: str more...
7.0.07.2.0ztna-geo-tag True True - ztna-status - Enable/disable zero trust access. type: str choices: [disable, enable] more...
7.0.07.2.0ztna-status True True - access-proxy - No description for the parameter type: str more...
7.2.0access-proxy True - dlp-profile - Name of an existing DLP profile. type: str more...
7.2.0dlp-profile True - dynamic-bypass - No description for the parameter type: str choices: [disable, enable] more...
7.2.0dynamic-bypass True - fec - Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. type: str choices: [disable, enable] more...
7.2.0fec True - force-proxy - No description for the parameter type: str choices: [disable, enable] more...
7.2.0force-proxy True - http-tunnel-auth - No description for the parameter type: str choices: [disable, enable] more...
7.2.0http-tunnel-auth True - ia-profile - No description for the parameter type: str more...
7.2.0ia-profile True - isolator-server - No description for the parameter type: str more...
7.2.0isolator-server True - log-http-transaction - No description for the parameter type: str choices: [disable, enable] more...
7.2.0log-http-transaction True - max-session-per-user - No description for the parameter type: int more...
7.2.0max-session-per-user True - nat46 - Enable/disable NAT46. type: str choices: [disable, enable] more...
7.2.0nat46 True - nat64 - Enable/disable NAT64. type: str choices: [disable, enable] more...
7.2.0nat64 True - pass-through - No description for the parameter type: str choices: [disable, enable] more...
7.2.0pass-through True - pfcp-profile - PFCP profile. type: str more...
7.2.0pfcp-profile True - policy-expiry - Enable/disable policy expiry. type: str choices: [disable, enable] more...
7.2.0policy-expiry True - policy-expiry-date - Policy expiry date (YYYY-MM-DD HH:MM:SS). type: str more...
7.2.0policy-expiry-date True - reverse-cache - No description for the parameter type: str choices: [disable, enable] more...
7.2.0reverse-cache True - sctp-filter-profile - Name of an existing SCTP filter profile. type: str more...
7.2.0sctp-filter-profile True - sgt - No description for the parameter type: int more...
7.2.0sgt True - sgt-check - Enable/disable security group tags (SGT) check. type: str choices: [disable, enable] more...
7.2.0sgt-check True - tcp-timeout-pid - No description for the parameter type: str more...
7.2.0tcp-timeout-pid True - transparent - No description for the parameter type: str choices: [disable, enable] more...
7.2.0transparent True - type - No description for the parameter type: str choices: [explicit-web, transparent, explicit-ftp, ssh-tunnel, ssh, wanopt, access-proxy] more...
7.2.0type True - udp-timeout-pid - No description for the parameter type: str more...
7.2.0udp-timeout-pid True - ztna-tags-match-logic - No description for the parameter type: str choices: [or, and] more...
7.2.0ztna-tags-match-logic True
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¶
- 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 footer policies
fmgr_fact:
facts:
selector: 'pkg_footer_policy'
params:
pkg: 'ansible'
policy: 'your_value'
- 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 footer policies.
fmgr_pkg_footer_policy:
bypass_validation: False
pkg: ansible
state: present
pkg_footer_policy:
action: accept #<value in [deny, accept, ipsec, ...]>
dstaddr: gall
dstintf: any
name: ansible-test-footer
policyid: 1074741836 # must larger than 2^30(1074741824), since header/footer policy is a special policy
schedule: galways
service: gALL
srcaddr: gall
srcintf: any
status: enable
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