fortinet.fortimanager.fmgr_pkg_footer_policy6 module – Configure IPv6 policies.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
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_policy6
.
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. |
|
Action. Choices:
|
|
Anti replay. Choices:
|
|
(list or str) App category. |
|
(list or str) App group. |
|
(list) Application. |
|
Application charts. Choices:
|
|
(list or str) Application list. |
|
Auto asic offload. Choices:
|
|
(list or str) Av profile. |
|
(list or str) Casi profile. |
|
NP log server group name |
|
(list or str) Cifs profile. |
|
Comments. |
|
(list or str) Custom log fields. |
|
(list or str) Decrypted traffic mirror. |
|
(list or str) Deep inspection options. |
|
Device detection portal. Choices:
|
|
(list or str) Devices. |
|
Diffserv forward. Choices:
|
|
Diffserv reverse. Choices:
|
|
Diffservcode forward. |
|
Diffservcode rev. |
|
(list or str) Dlp sensor. |
|
(list or str) Dnsfilter profile. |
|
Dscp match. Choices:
|
|
Dscp negate. Choices:
|
|
Dscp value. |
|
Dsri. Choices:
|
|
(list or str) Dstaddr. |
|
Dstaddr negate. Choices:
|
|
(list or str) Dstintf. |
|
Dynamic profile. Choices:
|
|
Dynamic profile access. Choices:
|
|
(list or str) Dynamic profile group. |
|
Email collection portal. Choices:
|
|
(list or str) Emailfilter profile. |
|
(list or str) File filter profile. |
|
Firewall session dirty. Choices:
|
|
Fixedport. Choices:
|
|
Fsae. Choices:
|
|
(list or str) Fsso groups. |
|
Global label. |
|
(list or str) Groups. |
|
Http policy redirect. Choices:
|
|
(list or str) Icap profile. |
|
Identity based. Choices:
|
|
Identity based policy6. |
|
Action. Choices:
|
|
Application list. |
|
Av profile. |
|
Deep inspection options. |
|
Devices. |
|
Dlp sensor. |
|
Endpoint compliance. Choices:
|
|
Groups. |
|
Icap profile. |
|
Id. |
|
Ips sensor. |
|
Logtraffic. 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. |
|
Utm status. Choices:
|
|
Voip profile. |
|
Webfilter profile. |
|
Identity from. Choices:
|
|
Inbound. Choices:
|
|
Inspection mode. Choices:
|
|
Ippool. Choices:
|
|
(list or str) Ips sensor. |
|
Label. |
|
Logtraffic. Choices:
|
|
Logtraffic start. Choices:
|
|
(list or str) Mms profile. |
|
Name. |
|
Nat. Choices:
|
|
Natinbound. Choices:
|
|
Natoutbound. Choices:
|
|
Np accelation. Choices:
|
|
Np acceleration. Choices:
|
|
Outbound. Choices:
|
|
(list or str) Per ip shaper. |
|
Enable/disable offloading policy configuration to CP processors. Choices:
|
|
Policyid. |
|
(list or str) Poolname. |
|
(list or str) Profile group. |
|
(list or str) Profile protocol options. |
|
Profile type. Choices:
|
|
(list or str) Replacemsg group. |
|
(list or str) Replacemsg override group. |
|
Rsso. Choices:
|
|
(list or str) Schedule. |
|
Send deny packet. Choices:
|
|
(list or str) Service. |
|
Service negate. Choices:
|
|
(int or str) Session ttl. |
|
(list or str) Spamfilter profile. |
|
(list or str) Srcaddr. |
|
Srcaddr negate. Choices:
|
|
(list or str) Srcintf. |
|
(list or str) Ssh filter profile. |
|
Ssh policy redirect. Choices:
|
|
Ssl mirror. Choices:
|
|
(list or str) Ssl mirror intf. |
|
(list or str) Ssl ssh profile. |
|
Sslvpn auth. Choices:
|
|
Sslvpn ccert. Choices:
|
|
Sslvpn cipher. Choices:
|
|
Status. Choices:
|
|
(list or str) Tags. |
|
Tcp mss receiver. |
|
Tcp mss sender. |
|
Tcp session without syn. Choices:
|
|
Timeout send rst. Choices:
|
|
Tos. |
|
Tos mask. |
|
Tos negate. Choices:
|
|
(list or str) Traffic shaper. |
|
(list or str) Traffic shaper reverse. |
|
(list or str) Url category. |
|
(list or str) Users. |
|
Utm inspection mode. Choices:
|
|
Utm status. Choices:
|
|
Uuid. |
|
Vlan cos fwd. |
|
Vlan cos rev. |
|
Vlan filter. |
|
(list or str) Voip profile. |
|
(list or str) Vpntunnel. |
|
(list or str) Waf profile. |
|
Webcache. Choices:
|
|
Webcache https. Choices:
|
|
(list or str) Webfilter profile. |
|
(list or str) Webproxy forward server. |
|
(list or str) Webproxy profile. |
|
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 IPv6 footer policies.
fortinet.fortimanager.fmgr_pkg_footer_policy6:
bypass_validation: false
pkg: ansible
state: present
pkg_footer_policy6:
action: accept # <value in [deny, accept, ipsec, ...]>
comments: ansible-comment
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: disable
- 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 IPv6 footer policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_footer_policy6"
params:
pkg: "ansible"
policy6: "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)