Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_header_policy
.
New in version 2.10: of fortinet.fortimanager
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
enable_log boolean |
| Enable/Disable logging for task | ||
pkg string / required | the parameter (pkg) in requested url | |||
pkg_header_policy dictionary | the top level parameters set | |||
action string |
| no description | ||
active-auth-method string |
| no description | ||
anti-replay string |
| no description | ||
app-category string | no description | |||
app-group string | no description | |||
application integer | no description | |||
application-charts list / elements=string |
| no description | ||
application-list string | no description | |||
auth-cert string | no description | |||
auth-method string |
| no description | ||
auth-path string |
| no description | ||
auth-portal string |
| no description | ||
auth-redirect-addr string | no description | |||
auto-asic-offload string |
| no description | ||
av-profile string | no description | |||
bandwidth string |
| no description | ||
best-route string |
| no description | ||
block-notification string |
| no description | ||
captive-portal-exempt string |
| no description | ||
capture-packet string |
| no description | ||
casi-profile string | no description | |||
central-nat string |
| no description | ||
cgn-eif string |
| no description | ||
cgn-eim string |
| no description | ||
cgn-log-server-grp string | no description | |||
cgn-resource-quota integer | no description | |||
cgn-session-quota integer | no description | |||
cifs-profile string | no description | |||
client-reputation string |
| no description | ||
client-reputation-mode string |
| no description | ||
comments string | no description | |||
custom-log-fields string | no description | |||
decrypted-traffic-mirror string | no description | |||
deep-inspection-options string | no description | |||
delay-tcp-npu-session string |
| no description | ||
delay-tcp-npu-sessoin string |
| no description | ||
device-detection-portal string |
| no description | ||
devices string | no description | |||
diffserv-forward string |
| no description | ||
diffserv-reverse string |
| no description | ||
diffservcode-forward string | no description | |||
diffservcode-rev string | no description | |||
disclaimer string |
| no description | ||
dlp-sensor string | no description | |||
dnsfilter-profile string | no description | |||
dponly string |
| no description | ||
dscp-match string |
| no description | ||
dscp-negate string |
| no description | ||
dscp-value string | no description | |||
dsri string |
| no description | ||
dstaddr string | no description | |||
dstaddr-negate string |
| no description | ||
dstaddr6 string | no description | |||
dstintf string | no description | |||
dynamic-profile string |
| no description | ||
dynamic-profile-access list / elements=string |
| no description | ||
dynamic-profile-fallthrough string |
| no description | ||
dynamic-profile-group string | no description | |||
dynamic-shaping string |
| Enable/disable dynamic RADIUS defined traffic shaping. | ||
email-collect string |
| no description | ||
email-collection-portal string |
| no description | ||
emailfilter-profile string | no description | |||
endpoint-check string |
| no description | ||
endpoint-compliance string |
| no description | ||
endpoint-keepalive-interface string | no description | |||
endpoint-profile string | no description | |||
failed-connection string |
| no description | ||
fall-through-unauthenticated string |
| no description | ||
file-filter-profile string | no description | |||
firewall-session-dirty string |
| no description | ||
fixedport string |
| no description | ||
forticlient-compliance-devices list / elements=string |
| no description | ||
forticlient-compliance-enforcement-portal string |
| no description | ||
fsae string |
| no description | ||
fsae-server-for-ntlm string | no description | |||
fsso string |
| no description | ||
fsso-agent-for-ntlm string | no description | |||
fsso-groups string | no description | |||
geo-location string |
| no description | ||
geoip-anycast string |
| no description | ||
geoip-match string |
| no description | ||
global-label string | no description | |||
groups string | no description | |||
gtp-profile string | no description | |||
http-policy-redirect string |
| no description | ||
icap-profile string | no description | |||
identity-based string |
| no description | ||
identity-based-policy list / elements=string | no description | |||
action string |
| no description | ||
application-charts list / elements=string |
| no description | ||
application-list string | no description | |||
av-profile string | no description | |||
capture-packet string |
| no description | ||
deep-inspection-options string | no description | |||
devices string | no description | |||
dlp-sensor string | no description | |||
dstaddr string | no description | |||
dstaddr-negate string |
| no description | ||
endpoint-compliance string |
| no description | ||
groups string | no description | |||
icap-profile string | no description | |||
id integer | no description | |||
ips-sensor string | no description | |||
logtraffic string |
| no description | ||
logtraffic-app string |
| no description | ||
logtraffic-start string |
| no description | ||
mms-profile string | no description | |||
per-ip-shaper string | no description | |||
profile-group string | no description | |||
profile-protocol-options string | no description | |||
profile-type string |
| no description | ||
replacemsg-group string | no description | |||
schedule string | no description | |||
send-deny-packet string |
| no description | ||
service string | no description | |||
service-negate string |
| no description | ||
spamfilter-profile string | no description | |||
sslvpn-portal string | no description | |||
sslvpn-realm string | no description | |||
traffic-shaper string | no description | |||
traffic-shaper-reverse string | no description | |||
users string | no description | |||
utm-status string |
| no description | ||
voip-profile string | no description | |||
webfilter-profile string | no description | |||
identity-based-route string | no description | |||
identity-from string |
| no description | ||
inbound string |
| no description | ||
inspection-mode string |
| no description | ||
internet-service string |
| no description | ||
internet-service-custom string | no description | |||
internet-service-custom-group string | no description | |||
internet-service-group string | no description | |||
internet-service-id string | no description | |||
internet-service-name string | no description | |||
internet-service-negate string |
| no description | ||
internet-service-src string |
| no description | ||
internet-service-src-custom string | no description | |||
internet-service-src-custom-group string | no description | |||
internet-service-src-group string | no description | |||
internet-service-src-id string | no description | |||
internet-service-src-name string | no description | |||
internet-service-src-negate string |
| no description | ||
ip-based string |
| no description | ||
ippool string |
| no description | ||
ips-sensor string | no description | |||
label string | no description | |||
learning-mode string |
| no description | ||
log-unmatched-traffic string |
| no description | ||
logtraffic string |
| no description | ||
logtraffic-app string |
| no description | ||
logtraffic-start string |
| no description | ||
match-vip string |
| no description | ||
match-vip-only string |
| no description | ||
mms-profile string | no description | |||
name string | no description | |||
nat string |
| no description | ||
natinbound string |
| no description | ||
natip string | no description | |||
natoutbound string |
| no description | ||
np-acceleration string |
| no description | ||
ntlm string |
| no description | ||
ntlm-enabled-browsers string | no description | |||
ntlm-guest string |
| no description | ||
outbound string |
| no description | ||
passive-wan-health-measurement string |
| Enable/disable passive WAN health measurement. When enabled, auto-asic-offload is disabled. | ||
per-ip-shaper string | no description | |||
permit-any-host string |
| no description | ||
permit-stun-host string |
| no description | ||
policy-offload string |
| no description | ||
policyid integer | no description | |||
poolname string | no description | |||
poolname6 string | no description | |||
profile-group string | no description | |||
profile-protocol-options string | no description | |||
profile-type string |
| no description | ||
radius-mac-auth-bypass string |
| no description | ||
redirect-url string | no description | |||
replacemsg-group string | no description | |||
replacemsg-override-group string | no description | |||
reputation-direction string |
| no description | ||
reputation-minimum integer | no description | |||
require-tfa string |
| no description | ||
rsso string |
| no description | ||
rtp-addr string | no description | |||
rtp-nat string |
| no description | ||
scan-botnet-connections string |
| no description | ||
schedule string | no description | |||
schedule-timeout string |
| no description | ||
send-deny-packet string |
| no description | ||
service string | no description | |||
service-negate string |
| no description | ||
session-ttl integer | no description | |||
sessions string |
| no description | ||
spamfilter-profile string | no description | |||
src-vendor-mac string | no description | |||
srcaddr string | no description | |||
srcaddr-negate string |
| no description | ||
srcaddr6 string | no description | |||
srcintf string | no description | |||
ssh-filter-profile string | no description | |||
ssh-policy-redirect string |
| no description | ||
ssl-mirror string |
| no description | ||
ssl-mirror-intf string | no description | |||
ssl-ssh-profile string | no description | |||
sslvpn-auth string |
| no description | ||
sslvpn-ccert string |
| no description | ||
sslvpn-cipher string |
| no description | ||
sso-auth-method string |
| no description | ||
status string |
| no description | ||
tags string | no description | |||
tcp-mss-receiver integer | no description | |||
tcp-mss-sender integer | no description | |||
tcp-reset string |
| no description | ||
tcp-session-without-syn string |
| no description | ||
timeout-send-rst string |
| no description | ||
tos string | no description | |||
tos-mask string | no description | |||
tos-negate string |
| no description | ||
traffic-shaper string | no description | |||
traffic-shaper-reverse string | no description | |||
transaction-based string |
| no description | ||
url-category string | no description | |||
users string | no description | |||
utm-inspection-mode string |
| no description | ||
utm-status string |
| no description | ||
uuid string | no description | |||
vendor-mac string | no description | |||
videofilter-profile string | Name of an existing VideoFilter profile. | |||
vlan-cos-fwd integer | no description | |||
vlan-cos-rev integer | no description | |||
vlan-filter string | no description | |||
voip-profile string | no description | |||
vpntunnel string | no description | |||
waf-profile string | no description | |||
wanopt string |
| no description | ||
wanopt-detection string |
| no description | ||
wanopt-passive-opt string |
| no description | ||
wanopt-peer string | no description | |||
wanopt-profile string | no description | |||
wccp string |
| no description | ||
web-auth-cookie string |
| no description | ||
webcache string |
| no description | ||
webcache-https string |
| no description | ||
webfilter-profile string | no description | |||
webproxy-forward-server string | no description | |||
webproxy-profile string | no description | |||
wsso string |
| no description | ||
ztna-ems-tag string | Source ztna-ems-tag names. | |||
ztna-geo-tag string | Source ztna-geo-tag names. | |||
ztna-status string |
| Enable/disable zero trust access. | ||
proposed_method string |
| The overridden method for the underlying Json RPC request | ||
rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | |||
rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | |||
state string / required |
| the directive to create, update or delete an object | ||
workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | |||
workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock |
Note
- 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: Configure IPv4/IPv6 policies. fmgr_pkg_header_policy: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] pkg: <your own value> state: <value in [present, absent]> pkg_header_policy: action: <value in [deny, accept, ipsec, ...]> active-auth-method: <value in [ntlm, basic, digest, ...]> anti-replay: <value in [disable, enable]> app-category: <value of string> app-group: <value of string> application: <value of integer> application-charts: - top10-app - top10-p2p-user - top10-media-user application-list: <value of string> auth-cert: <value of string> auth-method: <value in [basic, digest, ntlm, ...]> auth-path: <value in [disable, enable]> auth-portal: <value in [disable, enable]> auth-redirect-addr: <value of string> auto-asic-offload: <value in [disable, enable]> av-profile: <value of string> bandwidth: <value in [disable, enable]> block-notification: <value in [disable, enable]> captive-portal-exempt: <value in [disable, enable]> capture-packet: <value in [disable, enable]> casi-profile: <value of string> central-nat: <value in [disable, enable]> cifs-profile: <value of string> client-reputation: <value in [disable, enable]> client-reputation-mode: <value in [learning, monitoring]> comments: <value of string> custom-log-fields: <value of string> deep-inspection-options: <value of string> delay-tcp-npu-session: <value in [disable, enable]> delay-tcp-npu-sessoin: <value in [disable, enable]> device-detection-portal: <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> dponly: <value in [disable, enable]> 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]> dstaddr6: <value of string> dstintf: <value of string> dynamic-profile: <value in [disable, enable]> dynamic-profile-access: - imap - smtp - pop3 - http - ftp - im - nntp - imaps - smtps - pop3s - https - ftps - ssh dynamic-profile-fallthrough: <value in [disable, enable]> dynamic-profile-group: <value of string> email-collect: <value in [disable, enable]> email-collection-portal: <value in [disable, enable]> emailfilter-profile: <value of string> endpoint-check: <value in [disable, enable]> endpoint-compliance: <value in [disable, enable]> endpoint-keepalive-interface: <value of string> endpoint-profile: <value of string> failed-connection: <value in [disable, enable]> fall-through-unauthenticated: <value in [disable, enable]> firewall-session-dirty: <value in [check-all, check-new]> fixedport: <value in [disable, enable]> forticlient-compliance-devices: - windows-pc - mac - iphone-ipad - android forticlient-compliance-enforcement-portal: <value in [disable, enable]> fsae: <value in [disable, enable]> fsae-server-for-ntlm: <value of string> fsso: <value in [disable, enable]> fsso-agent-for-ntlm: <value of string> geo-location: <value in [disable, enable]> geoip-anycast: <value in [disable, enable]> global-label: <value of string> groups: <value of string> gtp-profile: <value of string> http-policy-redirect: <value in [disable, enable]> icap-profile: <value of string> identity-based: <value in [disable, enable]> identity-based-policy: - action: <value in [deny, accept]> application-charts: - top10-app - top10-p2p-user - top10-media-user application-list: <value of string> av-profile: <value of string> capture-packet: <value in [disable, enable]> deep-inspection-options: <value of string> devices: <value of string> dlp-sensor: <value of string> dstaddr: <value of string> dstaddr-negate: <value in [disable, enable]> endpoint-compliance: <value in [disable, enable]> groups: <value of string> icap-profile: <value of string> id: <value of integer> ips-sensor: <value of string> logtraffic: <value in [disable, enable, all, ...]> logtraffic-app: <value in [disable, enable]> logtraffic-start: <value in [disable, enable]> mms-profile: <value of string> per-ip-shaper: <value of string> profile-group: <value of string> profile-protocol-options: <value of string> profile-type: <value in [single, group]> replacemsg-group: <value of string> schedule: <value of string> send-deny-packet: <value in [disable, enable]> service: <value of string> service-negate: <value in [disable, enable]> spamfilter-profile: <value of string> sslvpn-portal: <value of string> sslvpn-realm: <value of string> traffic-shaper: <value of string> traffic-shaper-reverse: <value of string> users: <value of string> utm-status: <value in [disable, enable]> voip-profile: <value of string> webfilter-profile: <value of string> identity-based-route: <value of string> identity-from: <value in [auth, device]> inbound: <value in [disable, enable]> inspection-mode: <value in [proxy, flow]> internet-service: <value in [disable, enable]> internet-service-custom: <value of string> internet-service-custom-group: <value of string> internet-service-group: <value of string> internet-service-id: <value of string> internet-service-negate: <value in [disable, enable]> internet-service-src: <value in [disable, enable]> internet-service-src-custom: <value of string> internet-service-src-custom-group: <value of string> internet-service-src-group: <value of string> internet-service-src-id: <value of string> internet-service-src-negate: <value in [disable, enable]> ip-based: <value in [disable, enable]> ippool: <value in [disable, enable]> ips-sensor: <value of string> label: <value of string> learning-mode: <value in [disable, enable]> log-unmatched-traffic: <value in [disable, enable]> logtraffic: <value in [disable, enable, all, ...]> logtraffic-app: <value in [disable, enable]> 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]> np-acceleration: <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-group: <value of string> replacemsg-override-group: <value of string> reputation-direction: <value in [source, destination]> reputation-minimum: <value of integer> require-tfa: <value in [disable, enable]> 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> sessions: <value in [disable, enable]> spamfilter-profile: <value of string> srcaddr: <value of string> srcaddr-negate: <value in [disable, enable]> srcaddr6: <value of string> srcintf: <value of string> ssh-filter-profile: <value of string> ssh-policy-redirect: <value in [disable, enable]> ssl-mirror: <value in [disable, enable]> ssl-mirror-intf: <value of string> ssl-ssh-profile: <value of string> sslvpn-auth: <value in [any, local, radius, ...]> sslvpn-ccert: <value in [disable, enable]> sslvpn-cipher: <value in [any, high, medium]> sso-auth-method: <value in [fsso, rsso]> status: <value in [disable, enable]> tags: <value of string> tcp-mss-receiver: <value of integer> tcp-mss-sender: <value of integer> tcp-reset: <value in [disable, enable]> tcp-session-without-syn: <value in [all, data-only, disable]> timeout-send-rst: <value in [disable, enable]> tos: <value of string> tos-mask: <value of string> tos-negate: <value in [disable, enable]> traffic-shaper: <value of string> traffic-shaper-reverse: <value of string> transaction-based: <value in [disable, enable]> url-category: <value of string> users: <value of string> utm-inspection-mode: <value in [proxy, flow]> utm-status: <value in [disable, enable]> uuid: <value of string> vlan-cos-fwd: <value of integer> vlan-cos-rev: <value of integer> vlan-filter: <value of string> voip-profile: <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]> web-auth-cookie: <value in [disable, enable]> webcache: <value in [disable, enable]> webcache-https: <value in [disable, ssl-server, any, ...]> webfilter-profile: <value of string> webproxy-forward-server: <value of string> webproxy-profile: <value of string> wsso: <value in [disable, enable]> fsso-groups: <value of string> match-vip-only: <value in [disable, enable]> best-route: <value in [disable, enable]> decrypted-traffic-mirror: <value of string> geoip-match: <value in [physical-location, registered-location]> internet-service-name: <value of string> internet-service-src-name: <value of string> poolname6: <value of string> src-vendor-mac: <value of string> vendor-mac: <value of string> file-filter-profile: <value of string> cgn-eif: <value in [disable, enable]> cgn-eim: <value in [disable, enable]> cgn-log-server-grp: <value of string> cgn-resource-quota: <value of integer> cgn-session-quota: <value of integer> policy-offload: <value in [disable, enable]> dynamic-shaping: <value in [disable, enable]> passive-wan-health-measurement: <value in [disable, enable]> videofilter-profile: <value of string> ztna-ems-tag: <value of string> ztna-geo-tag: <value of string> ztna-status: <value in [disable, enable]>
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
request_url string | always | The full url requested Sample: /sys/login/user |
response_code integer | always | The status of api request |
response_message string | always | The descriptive message of the api response Sample: OK. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_pkg_header_policy_module.html