fortinet.fortimanager.fmgr_pkg_footer_policy6 module – Configure IPv6 policies.
Note
This module is part of the fortinet.fortimanager collection (version 2.5.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. |
|
No description. Choices:
|
|
Deprecated, please rename it to anti_replay. Choices:
|
|
(list or str) Deprecated, please rename it to app_category. |
|
(list or str) Deprecated, please rename it to app_group. |
|
(list) No description. |
|
Deprecated, please rename it to application_charts. Choices:
|
|
(list or str) Deprecated, please rename it to application_list. |
|
Deprecated, please rename it to auto_asic_offload. Choices:
|
|
(list or str) Deprecated, please rename it to av_profile. |
|
(list or str) Deprecated, please rename it to casi_profile. |
|
Deprecated, please rename it to cgn_log_server_grp. NP log server group name |
|
(list or str) Deprecated, please rename it to cifs_profile. |
|
No description. |
|
(list or str) Deprecated, please rename it to custom_log_fields. |
|
(list or str) Deprecated, please rename it to decrypted_traffic_mirror. |
|
(list or str) Deprecated, please rename it to deep_inspection_options. |
|
Deprecated, please rename it to device_detection_portal. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to diffserv_forward. Choices:
|
|
Deprecated, please rename it to diffserv_reverse. Choices:
|
|
Deprecated, please rename it to diffservcode_forward. |
|
Deprecated, please rename it to diffservcode_rev. |
|
(list or str) Deprecated, please rename it to dlp_sensor. |
|
(list or str) Deprecated, please rename it to dnsfilter_profile. |
|
Deprecated, please rename it to dscp_match. Choices:
|
|
Deprecated, please rename it to dscp_negate. Choices:
|
|
Deprecated, please rename it to dscp_value. |
|
No description. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to dstaddr_negate. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to dynamic_profile. Choices:
|
|
Deprecated, please rename it to dynamic_profile_access. Choices:
|
|
(list or str) Deprecated, please rename it to dynamic_profile_group. |
|
Deprecated, please rename it to email_collection_portal. Choices:
|
|
(list or str) Deprecated, please rename it to emailfilter_profile. |
|
(list or str) Deprecated, please rename it to file_filter_profile. |
|
Deprecated, please rename it to firewall_session_dirty. Choices:
|
|
No description. Choices:
|
|
No description. Choices:
|
|
(list or str) Deprecated, please rename it to fsso_groups. |
|
Deprecated, please rename it to global_label. |
|
(list or str) No description. |
|
Deprecated, please rename it to http_policy_redirect. Choices:
|
|
(list or str) Deprecated, please rename it to icap_profile. |
|
Deprecated, please rename it to identity_based. Choices:
|
|
Deprecated, please rename it to identity_based_policy6. |
|
No description. Choices:
|
|
Deprecated, please rename it to application_list. |
|
Deprecated, please rename it to av_profile. |
|
Deprecated, please rename it to deep_inspection_options. |
|
No description. |
|
Deprecated, please rename it to dlp_sensor. |
|
Deprecated, please rename it to endpoint_compliance. Choices:
|
|
No description. |
|
Deprecated, please rename it to icap_profile. |
|
No description. |
|
Deprecated, please rename it to ips_sensor. |
|
No description. Choices:
|
|
Deprecated, please rename it to mms_profile. |
|
Deprecated, please rename it to per_ip_shaper. |
|
Deprecated, please rename it to profile_group. |
|
Deprecated, please rename it to profile_protocol_options. |
|
Deprecated, please rename it to profile_type. Choices:
|
|
Deprecated, please rename it to replacemsg_group. |
|
No description. |
|
Deprecated, please rename it to send_deny_packet. Choices:
|
|
No description. |
|
Deprecated, please rename it to service_negate. Choices:
|
|
Deprecated, please rename it to spamfilter_profile. |
|
Deprecated, please rename it to sslvpn_portal. |
|
Deprecated, please rename it to sslvpn_realm. |
|
Deprecated, please rename it to traffic_shaper. |
|
Deprecated, please rename it to traffic_shaper_reverse. |
|
Deprecated, please rename it to utm_status. Choices:
|
|
Deprecated, please rename it to voip_profile. |
|
Deprecated, please rename it to webfilter_profile. |
|
Deprecated, please rename it to identity_from. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to inspection_mode. Choices:
|
|
No description. Choices:
|
|
(list or str) Deprecated, please rename it to ips_sensor. |
|
No description. |
|
No description. Choices:
|
|
Deprecated, please rename it to logtraffic_start. Choices:
|
|
(list or str) Deprecated, please rename it to mms_profile. |
|
No description. |
|
No description. Choices:
|
|
No description. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to np_accelation. Choices:
|
|
Deprecated, please rename it to np_acceleration. Choices:
|
|
No description. Choices:
|
|
(list or str) Deprecated, please rename it to per_ip_shaper. |
|
Deprecated, please rename it to policy_offload. Enable/disable offloading policy configuration to CP processors. Choices:
|
|
No description. |
|
(list or str) No description. |
|
(list or str) Deprecated, please rename it to profile_group. |
|
(list or str) Deprecated, please rename it to profile_protocol_options. |
|
Deprecated, please rename it to profile_type. Choices:
|
|
(list or str) Deprecated, please rename it to replacemsg_group. |
|
(list or str) Deprecated, please rename it to replacemsg_override_group. |
|
No description. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to send_deny_packet. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to service_negate. Choices:
|
|
(int or str) Deprecated, please rename it to session_ttl. |
|
(list or str) Deprecated, please rename it to spamfilter_profile. |
|
(list or str) No description. |
|
Deprecated, please rename it to srcaddr_negate. Choices:
|
|
(list or str) No description. |
|
(list or str) Deprecated, please rename it to ssh_filter_profile. |
|
Deprecated, please rename it to ssh_policy_redirect. Choices:
|
|
Deprecated, please rename it to ssl_mirror. Choices:
|
|
(list or str) Deprecated, please rename it to ssl_mirror_intf. |
|
(list or str) Deprecated, please rename it to ssl_ssh_profile. |
|
Deprecated, please rename it to sslvpn_auth. Choices:
|
|
Deprecated, please rename it to sslvpn_ccert. Choices:
|
|
Deprecated, please rename it to sslvpn_cipher. Choices:
|
|
No description. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to tcp_mss_receiver. |
|
Deprecated, please rename it to tcp_mss_sender. |
|
Deprecated, please rename it to tcp_session_without_syn. Choices:
|
|
Deprecated, please rename it to timeout_send_rst. Choices:
|
|
No description. |
|
Deprecated, please rename it to tos_mask. |
|
Deprecated, please rename it to tos_negate. Choices:
|
|
(list or str) Deprecated, please rename it to traffic_shaper. |
|
(list or str) Deprecated, please rename it to traffic_shaper_reverse. |
|
(list or str) Deprecated, please rename it to url_category. |
|
(list or str) No description. |
|
Deprecated, please rename it to utm_inspection_mode. Choices:
|
|
Deprecated, please rename it to utm_status. Choices:
|
|
No description. |
|
Deprecated, please rename it to vlan_cos_fwd. |
|
Deprecated, please rename it to vlan_cos_rev. |
|
Deprecated, please rename it to vlan_filter. |
|
(list or str) Deprecated, please rename it to voip_profile. |
|
(list or str) No description. |
|
(list or str) Deprecated, please rename it to waf_profile. |
|
No description. Choices:
|
|
Deprecated, please rename it to webcache_https. Choices:
|
|
(list or str) Deprecated, please rename it to webfilter_profile. |
|
(list or str) Deprecated, please rename it to webproxy_forward_server. |
|
(list or str) Deprecated, please rename it to 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)