fortinet.fortimanager.fmgr_pkg_header_policy6 module – Configure IPv6 policies.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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_header_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:
|
|
Deprecated, please rename it to anti_replay. Anti replay. Choices:
|
|
(list or str) Deprecated, please rename it to app_category. App category. |
|
(list or str) Deprecated, please rename it to app_group. App group. |
|
(list) Application. |
|
Deprecated, please rename it to application_charts. Application charts. Choices:
|
|
(list or str) Deprecated, please rename it to application_list. Application list. |
|
Deprecated, please rename it to auto_asic_offload. Auto asic offload. Choices:
|
|
(list or str) Deprecated, please rename it to av_profile. Av profile. |
|
(list or str) Deprecated, please rename it to casi_profile. 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. Cifs profile. |
|
Comments. |
|
(list or str) Deprecated, please rename it to custom_log_fields. Custom log fields. |
|
(list or str) Deprecated, please rename it to decrypted_traffic_mirror. Decrypted traffic mirror. |
|
(list or str) Deprecated, please rename it to deep_inspection_options. Deep inspection options. |
|
Deprecated, please rename it to device_detection_portal. Device detection portal. Choices:
|
|
(list or str) Devices. |
|
Deprecated, please rename it to diffserv_forward. Diffserv forward. Choices:
|
|
Deprecated, please rename it to diffserv_reverse. Diffserv reverse. Choices:
|
|
Deprecated, please rename it to diffservcode_forward. Diffservcode forward. |
|
Deprecated, please rename it to diffservcode_rev. Diffservcode rev. |
|
(list or str) Deprecated, please rename it to dlp_sensor. Dlp sensor. |
|
(list or str) Deprecated, please rename it to dnsfilter_profile. Dnsfilter profile. |
|
Deprecated, please rename it to dscp_match. Dscp match. Choices:
|
|
Deprecated, please rename it to dscp_negate. Dscp negate. Choices:
|
|
Deprecated, please rename it to dscp_value. Dscp value. |
|
Dsri. Choices:
|
|
(list or str) Dstaddr. |
|
Deprecated, please rename it to dstaddr_negate. Dstaddr negate. Choices:
|
|
(list or str) Dstintf. |
|
Deprecated, please rename it to dynamic_profile. Dynamic profile. Choices:
|
|
Deprecated, please rename it to dynamic_profile_access. Dynamic profile access. Choices:
|
|
(list or str) Deprecated, please rename it to dynamic_profile_group. Dynamic profile group. |
|
Deprecated, please rename it to email_collection_portal. Email collection portal. Choices:
|
|
(list or str) Deprecated, please rename it to emailfilter_profile. Emailfilter profile. |
|
(list or str) Deprecated, please rename it to file_filter_profile. File filter profile. |
|
Deprecated, please rename it to firewall_session_dirty. Firewall session dirty. Choices:
|
|
Fixedport. Choices:
|
|
Fsae. Choices:
|
|
(list or str) Deprecated, please rename it to fsso_groups. Fsso groups. |
|
Deprecated, please rename it to global_label. Global label. |
|
(list or str) Groups. |
|
Deprecated, please rename it to http_policy_redirect. Http policy redirect. Choices:
|
|
(list or str) Deprecated, please rename it to icap_profile. Icap profile. |
|
Deprecated, please rename it to identity_based. Identity based. Choices:
|
|
Deprecated, please rename it to identity_based_policy6. Identity based policy6. |
|
Action. Choices:
|
|
Deprecated, please rename it to application_list. Application list. |
|
Deprecated, please rename it to av_profile. Av profile. |
|
Deprecated, please rename it to deep_inspection_options. Deep inspection options. |
|
Devices. |
|
Deprecated, please rename it to dlp_sensor. Dlp sensor. |
|
Deprecated, please rename it to endpoint_compliance. Endpoint compliance. Choices:
|
|
Groups. |
|
Deprecated, please rename it to icap_profile. Icap profile. |
|
Id. |
|
Deprecated, please rename it to ips_sensor. Ips sensor. |
|
Logtraffic. Choices:
|
|
Deprecated, please rename it to mms_profile. Mms profile. |
|
Deprecated, please rename it to per_ip_shaper. Per ip shaper. |
|
Deprecated, please rename it to profile_group. Profile group. |
|
Deprecated, please rename it to profile_protocol_options. Profile protocol options. |
|
Deprecated, please rename it to profile_type. Profile type. Choices:
|
|
Deprecated, please rename it to replacemsg_group. Replacemsg group. |
|
Schedule. |
|
Deprecated, please rename it to send_deny_packet. Send deny packet. Choices:
|
|
Service. |
|
Deprecated, please rename it to service_negate. Service negate. Choices:
|
|
Deprecated, please rename it to spamfilter_profile. Spamfilter profile. |
|
Deprecated, please rename it to sslvpn_portal. Sslvpn portal. |
|
Deprecated, please rename it to sslvpn_realm. Sslvpn realm. |
|
Deprecated, please rename it to traffic_shaper. Traffic shaper. |
|
Deprecated, please rename it to traffic_shaper_reverse. Traffic shaper reverse. |
|
Deprecated, please rename it to utm_status. Utm status. Choices:
|
|
Deprecated, please rename it to voip_profile. Voip profile. |
|
Deprecated, please rename it to webfilter_profile. Webfilter profile. |
|
Deprecated, please rename it to identity_from. Identity from. Choices:
|
|
Inbound. Choices:
|
|
Deprecated, please rename it to inspection_mode. Inspection mode. Choices:
|
|
Ippool. Choices:
|
|
(list or str) Deprecated, please rename it to ips_sensor. Ips sensor. |
|
Label. |
|
Logtraffic. Choices:
|
|
Deprecated, please rename it to logtraffic_start. Logtraffic start. Choices:
|
|
(list or str) Deprecated, please rename it to mms_profile. Mms profile. |
|
Name. |
|
Nat. Choices:
|
|
Natinbound. Choices:
|
|
Natoutbound. Choices:
|
|
Deprecated, please rename it to np_accelation. Np accelation. Choices:
|
|
Deprecated, please rename it to np_acceleration. Np acceleration. Choices:
|
|
Outbound. Choices:
|
|
(list or str) Deprecated, please rename it to per_ip_shaper. Per ip shaper. |
|
Deprecated, please rename it to policy_offload. Enable/disable offloading policy configuration to CP processors. Choices:
|
|
Policyid. |
|
(list or str) Poolname. |
|
(list or str) Deprecated, please rename it to profile_group. Profile group. |
|
(list or str) Deprecated, please rename it to profile_protocol_options. Profile protocol options. |
|
Deprecated, please rename it to profile_type. Profile type. Choices:
|
|
(list or str) Deprecated, please rename it to replacemsg_group. Replacemsg group. |
|
(list or str) Deprecated, please rename it to replacemsg_override_group. Replacemsg override group. |
|
Rsso. Choices:
|
|
(list or str) Schedule. |
|
Deprecated, please rename it to send_deny_packet. Send deny packet. Choices:
|
|
(list or str) Service. |
|
Deprecated, please rename it to service_negate. Service negate. Choices:
|
|
(int or str) Deprecated, please rename it to session_ttl. Session ttl. |
|
(list or str) Deprecated, please rename it to spamfilter_profile. Spamfilter profile. |
|
(list or str) Srcaddr. |
|
Deprecated, please rename it to srcaddr_negate. Srcaddr negate. Choices:
|
|
(list or str) Srcintf. |
|
(list or str) Deprecated, please rename it to ssh_filter_profile. Ssh filter profile. |
|
Deprecated, please rename it to ssh_policy_redirect. Ssh policy redirect. Choices:
|
|
Deprecated, please rename it to ssl_mirror. Ssl mirror. Choices:
|
|
(list or str) Deprecated, please rename it to ssl_mirror_intf. Ssl mirror intf. |
|
(list or str) Deprecated, please rename it to ssl_ssh_profile. Ssl ssh profile. |
|
Deprecated, please rename it to sslvpn_auth. Sslvpn auth. Choices:
|
|
Deprecated, please rename it to sslvpn_ccert. Sslvpn ccert. Choices:
|
|
Deprecated, please rename it to sslvpn_cipher. Sslvpn cipher. Choices:
|
|
Status. Choices:
|
|
(list or str) Tags. |
|
Deprecated, please rename it to tcp_mss_receiver. Tcp mss receiver. |
|
Deprecated, please rename it to tcp_mss_sender. Tcp mss sender. |
|
Deprecated, please rename it to tcp_session_without_syn. Tcp session without syn. Choices:
|
|
Deprecated, please rename it to timeout_send_rst. Timeout send rst. Choices:
|
|
Tos. |
|
Deprecated, please rename it to tos_mask. Tos mask. |
|
Deprecated, please rename it to tos_negate. Tos negate. Choices:
|
|
(list or str) Deprecated, please rename it to traffic_shaper. Traffic shaper. |
|
(list or str) Deprecated, please rename it to traffic_shaper_reverse. Traffic shaper reverse. |
|
(list or str) Deprecated, please rename it to url_category. Url category. |
|
(list or str) Users. |
|
Deprecated, please rename it to utm_inspection_mode. Utm inspection mode. Choices:
|
|
Deprecated, please rename it to utm_status. Utm status. Choices:
|
|
Uuid. |
|
Deprecated, please rename it to vlan_cos_fwd. Vlan cos fwd. |
|
Deprecated, please rename it to vlan_cos_rev. Vlan cos rev. |
|
Deprecated, please rename it to vlan_filter. Vlan filter. |
|
(list or str) Deprecated, please rename it to voip_profile. Voip profile. |
|
(list or str) Vpntunnel. |
|
(list or str) Deprecated, please rename it to waf_profile. Waf profile. |
|
Webcache. Choices:
|
|
Deprecated, please rename it to webcache_https. Webcache https. Choices:
|
|
(list or str) Deprecated, please rename it to webfilter_profile. Webfilter profile. |
|
(list or str) Deprecated, please rename it to webproxy_forward_server. Webproxy forward server. |
|
(list or str) Deprecated, please rename it to webproxy_profile. 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 header policies.
fortinet.fortimanager.fmgr_pkg_header_policy6:
bypass_validation: false
pkg: ansible
state: present
pkg_header_policy6:
action: accept # <value in [deny, accept, ipsec, ...]>
comments: ansible-comment
dstaddr: gall
dstintf: any
name: ansible-test2-header
policyid: 1073741827 # 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 IPv6 header policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_header_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 |