fortinet.fortimanager.fmgr_pkg_footer_policy module – Configure IPv4/IPv6 policies.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
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_footer_policy.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (pkg) in requested url. |
|
The top level parameters set. |
|
Assigned policy block. |
|
(list) Access proxy. |
|
Action. Choices:
|
|
Active auth method. Choices:
|
|
Anti replay. Choices:
|
|
(list or str) App category. |
|
(list or str) App group. |
|
(list) Application. |
|
Application charts. Choices:
|
|
Application list. |
|
Auth cert. |
|
Auth method. Choices:
|
|
Auth path. Choices:
|
|
Auth portal. Choices:
|
|
Auth redirect addr. |
|
Auto asic offload. Choices:
|
|
Av profile. |
|
Bandwidth. Choices:
|
|
Best route. Choices:
|
|
Block notification. Choices:
|
|
Captive portal exempt. Choices:
|
|
Capture packet. Choices:
|
|
Name of an existing CASB profile. |
|
(list or str) Casi profile. |
|
Central nat. Choices:
|
|
Enable/Disable CGN endpoint independent filtering. Choices:
|
|
Enable/Disable CGN endpoint independent mapping Choices:
|
|
(list or str) NP log server group name |
|
Resource quota |
|
Session quota |
|
Enable/disable software endpoint independent filtering control. Choices:
|
|
Cifs profile. |
|
Client reputation. Choices:
|
|
Client reputation mode. Choices:
|
|
(dict or str) Comments. |
|
(list or str) Custom log fields. |
|
Decrypted traffic mirror. |
|
(list or str) Deep inspection options. |
|
Delay tcp npu session. Choices:
|
|
Delay tcp npu sessoin. Choices:
|
|
Detect https in http request. Choices:
|
|
Device detection portal. Choices:
|
|
Device ownership. Choices:
|
|
(list or str) Devices. |
|
Name of an existing Diameter filter profile. |
|
Enable to copy packets DiffServ values from sessions original direction to its reply direction. Choices:
|
|
Diffserv forward. Choices:
|
|
Diffserv reverse. Choices:
|
|
Diffservcode forward. |
|
Diffservcode rev. |
|
Disclaimer. Choices:
|
|
Name of an existing DLP profile. |
|
(list or str) Dlp sensor. |
|
Dnsfilter profile. |
|
Dponly. Choices:
|
|
Dscp match. Choices:
|
|
Dscp negate. Choices:
|
|
Dscp value. |
|
Dsri. Choices:
|
|
(list or str) Dstaddr. |
|
(list or str) Dstaddr6. |
|
When enabled dstaddr6 specifies what the destination address must NOT be. Choices:
|
|
Dstaddr negate. Choices:
|
|
(list or str) Dstintf. |
|
Dynamic bypass. Choices:
|
|
Dynamic profile. Choices:
|
|
Dynamic profile access. Choices:
|
|
Dynamic profile fallthrough. Choices:
|
|
(list or str) Dynamic profile group. |
|
Enable/disable dynamic RADIUS defined traffic shaping. Choices:
|
|
Enable/Disable check endpoint-independent-filtering pinhole. Choices:
|
|
Enable/Disable learning of end-point-independent filtering pinhole. Choices:
|
|
Email collect. Choices:
|
|
Email collection portal. Choices:
|
|
Emailfilter profile. |
|
Endpoint check. Choices:
|
|
Endpoint compliance. Choices:
|
|
(list or str) Endpoint keepalive interface. |
|
(list or str) Endpoint profile. |
|
Extended log. Choices:
|
|
Failed connection. Choices:
|
|
Fall through unauthenticated. Choices:
|
|
Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. Choices:
|
|
File filter profile. |
|
Firewall session dirty. Choices:
|
|
Fixedport. Choices:
|
|
Force proxy. Choices:
|
|
Forticlient compliance devices. Choices:
|
|
Forticlient compliance enforcement portal. Choices:
|
|
Fsae. Choices:
|
|
(list or str) Fsae server for ntlm. |
|
Fsso. Choices:
|
|
Fsso agent for ntlm. |
|
(list or str) Fsso groups. |
|
Geo location. Choices:
|
|
Geoip anycast. Choices:
|
|
Geoip match. Choices:
|
|
Global label. |
|
(list or str) Groups. |
|
Gtp profile. |
|
Http policy redirect. Choices:
|
|
Http tunnel auth. Choices:
|
|
(list) Ia profile. |
|
Icap profile. |
|
Identity based. Choices:
|
|
Identity based policy. |
|
Action. Choices:
|
|
Application charts. Choices:
|
|
Application list. |
|
Av profile. |
|
Capture packet. Choices:
|
|
Deep inspection options. |
|
Devices. |
|
Dlp sensor. |
|
Dstaddr. |
|
Dstaddr negate. Choices:
|
|
Endpoint compliance. Choices:
|
|
Groups. |
|
Icap profile. |
|
Id. |
|
Ips sensor. |
|
Logtraffic. Choices:
|
|
Logtraffic app. Choices:
|
|
Logtraffic start. Choices:
|
|
Mms profile. |
|
Per ip shaper. |
|
Profile group. |
|
Profile protocol options. |
|
Profile type. Choices:
|
|
Replacemsg group. |
|
Schedule. |
|
Send deny packet. Choices:
|
|
Service. |
|
Service negate. Choices:
|
|
Spamfilter profile. |
|
Sslvpn portal. |
|
Sslvpn realm. |
|
Traffic shaper. |
|
Traffic shaper reverse. |
|
Users. |
|
Utm status. Choices:
|
|
Voip profile. |
|
Webfilter profile. |
|
Identity based route. |
|
Identity from. Choices:
|
|
Implicit proxy detection. Choices:
|
|
Inbound. Choices:
|
|
Inspection mode. Choices:
|
|
Internet service. Choices:
|
|
Enable/disable use of IPv6 Internet Services for this policy. Choices:
|
|
(list) Custom IPv6 Internet Service name. |
|
(list) Custom Internet Service6 group name. |
|
(list) Internet Service group name. |
|
(list) IPv6 Internet Service name. |
|
When enabled internet-service6 specifies what the service must NOT be. Choices:
|
|
Enable/disable use of IPv6 Internet Services in source for this policy. Choices:
|
|
(list) Custom IPv6 Internet Service source name. |
|
(list) Custom Internet Service6 source group name. |
|
(list) Internet Service6 source group name. |
|
(list) IPv6 Internet Service source name. |
|
When enabled internet-service6-src specifies what the service must NOT be. Choices:
|
|
(list or str) Internet service custom. |
|
(list or str) Internet service custom group. |
|
(list or str) Internet service group. |
|
(list or str) Internet service id. |
|
(list or str) Internet service name. |
|
Internet service negate. Choices:
|
|
Internet service src. Choices:
|
|
(list or str) Internet service src custom. |
|
(list or str) Internet service src custom group. |
|
(list or str) Internet service src group. |
|
(list or str) Internet service src id. |
|
(list or str) Internet service src name. |
|
Internet service src negate. Choices:
|
|
Ip based. Choices:
|
|
IP version of the policy. |
|
Ippool. Choices:
|
|
Ips sensor. |
|
Name of an existing VoIP |
|
(list) Isolator profile. |
|
(list) Isolator server. |
|
Label. |
|
Learning mode. Choices:
|
|
Log http transaction. Choices:
|
|
Log unmatched traffic. Choices:
|
|
Logtraffic. Choices:
|
|
Logtraffic app. Choices:
|
|
Logtraffic start. Choices:
|
|
Match vip. Choices:
|
|
Match vip only. Choices:
|
|
Max session per user. |
|
(list or str) Mms profile. |
|
Name. |
|
Nat. Choices:
|
|
Enable/disable NAT46. Choices:
|
|
Enable/disable NAT64. Choices:
|
|
Natinbound. Choices:
|
|
Natip. |
|
Natoutbound. Choices:
|
|
(list) Dynamic Network Service name. |
|
(list) Dynamic Network Service source name. |
|
Np accelation. Choices:
|
|
Np acceleration. Choices:
|
|
Ntlm. Choices:
|
|
(list) Ntlm enabled browsers. |
|
Ntlm guest. Choices:
|
|
Outbound. Choices:
|
|
Pass through. Choices:
|
|
Enable/disable passive WAN health measurement. Choices:
|
|
Enable/disable PCP inbound DNAT. Choices:
|
|
Enable/disable PCP outbound SNAT. Choices:
|
|
(list) PCP pool names. |
|
Per ip shaper. |
|
Permit any host. Choices:
|
|
Permit stun host. Choices:
|
|
PFCP profile. |
|
Behaviour of the policy. |
|
Enable/disable policy expiry. Choices:
|
|
Policy expiry date |
|
Policy expiry date and time, in epoch format. |
|
Enable/Disable hardware session setup for CGNAT. Choices:
|
|
Policyid. |
|
(list or str) Poolname. |
|
(list or str) Poolname6. |
|
Enable/disable preservation of the original source port from source NAT if it has not been used. Choices:
|
|
Profile group. |
|
Profile protocol options. |
|
Profile type. Choices:
|
|
Enable IP authentication bypass. Choices:
|
|
Radius mac auth bypass. Choices:
|
|
(list) Redirect profile. |
|
Redirect url. |
|
(list or str) Replacemsg group. |
|
Replacemsg override group. |
|
Reputation direction. Choices:
|
|
Direction of the initial traffic for IPv6 reputation to take effect. Choices:
|
|
Reputation minimum. |
|
IPv6 Minimum Reputation to take action. |
|
Require tfa. Choices:
|
|
Reverse cache. Choices:
|
|
Rsso. Choices:
|
|
(list or str) Rtp addr. |
|
Rtp nat. Choices:
|
|
Scan botnet connections. Choices:
|
|
Schedule. |
|
Schedule timeout. Choices:
|
|
Name of an existing SCTP filter profile. |
|
Send deny packet. Choices:
|
|
(list or str) Service. |
|
Service negate. Choices:
|
|
(int or str) Session ttl. |
|
Sessions. Choices:
|
|
(list) Security group tags. |
|
Enable/disable security group tags Choices:
|
|
(list or str) Spamfilter profile. |
|
(list or str) Src vendor mac. |
|
(list or str) Srcaddr. |
|
(list or str) Srcaddr6. |
|
When enabled srcaddr6 specifies what the source address must NOT be. Choices:
|
|
Srcaddr negate. Choices:
|
|
(list or str) Srcintf. |
|
Ssh filter profile. |
|
Ssh policy check. Choices:
|
|
Ssh policy redirect. Choices:
|
|
Ssl mirror. Choices:
|
|
(list or str) Ssl mirror intf. |
|
Ssl ssh profile. |
|
Sslvpn auth. Choices:
|
|
Sslvpn ccert. Choices:
|
|
Sslvpn cipher. Choices:
|
|
Sso auth method. Choices:
|
|
Status. Choices:
|
|
(list or str) Tags. |
|
Tcp mss receiver. |
|
Tcp mss sender. |
|
Tcp reset. Choices:
|
|
Tcp session without syn. Choices:
|
|
(list) TCP timeout profile ID |
|
Timeout send rst. Choices:
|
|
Tos. |
|
Tos mask. |
|
Tos negate. Choices:
|
|
Traffic shaper. |
|
Traffic shaper reverse. |
|
Transaction based. Choices:
|
|
Transparent. Choices:
|
|
Type. Choices:
|
|
(list) UDP timeout profile ID |
|
(list or str) Url category. |
|
(list) Url risk. |
|
(list or str) Users. |
|
Utm inspection mode. Choices:
|
|
Utm status. Choices:
|
|
Uuid. |
|
Uuid idx. |
|
(list or str) Vendor mac. |
|
Name of an existing VideoFilter profile. |
|
Name of an existing virtual-patch profile. |
|
Vlan cos fwd. |
|
Vlan cos rev. |
|
Vlan filter. |
|
Voip profile. |
|
Vpntunnel. |
|
Waf profile. |
|
Wanopt. Choices:
|
|
Wanopt detection. Choices:
|
|
Wanopt passive opt. Choices:
|
|
Wanopt peer. |
|
Wanopt profile. |
|
Wccp. Choices:
|
|
Web auth cookie. Choices:
|
|
Webcache. Choices:
|
|
Webcache https. Choices:
|
|
Webfilter profile. |
|
Webproxy forward server. |
|
Webproxy profile. |
|
Wsso. Choices:
|
|
Enable/disable zero trust device ownership. Choices:
|
|
(list or str) Source ztna-ems-tag names. |
|
(list) Source ztna-ems-tag-secondary names. |
|
(list or str) Source ztna-geo-tag names. |
|
Redirect ZTNA traffic to matching Access-Proxy proxy-policy. Choices:
|
|
Enable/disable zero trust access. Choices:
|
|
Ztna tags match logic. Choices:
|
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 footer policies.
fortinet.fortimanager.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
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the IPv4 footer policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_footer_policy"
params:
pkg: "ansible"
policy: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |
Authors
Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)