fortinet.fortimanager.fmgr_pm_config_pblock_firewall_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_pm_config_pblock_firewall_policy6.
New in fortinet.fortimanager 2.2.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. |
|
The parameter (adom) in requested url. |
|
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 (pblock) in requested url. |
|
The top level parameters set. |
|
Assigned policy block. |
|
Policy action Choices:
|
|
Deprecated, please rename it to anti_replay. Enable/disable anti-replay check. Choices:
|
|
(list) Deprecated, please rename it to app_category. Application category ID list. |
|
(list) Deprecated, please rename it to app_group. Application group names. |
|
(list) Application ID list. |
|
Deprecated, please rename it to application_list. Name of an existing Application list. |
|
Deprecated, please rename it to auto_asic_offload. Enable/disable policy traffic ASIC offloading. Choices:
|
|
Deprecated, please rename it to av_profile. Name of an existing Antivirus profile. |
|
Deprecated, please rename it to cgn_log_server_grp. Cgn log server grp. |
|
Deprecated, please rename it to cifs_profile. Name of an existing CIFS profile. |
|
Comment. |
|
(list) Deprecated, please rename it to custom_log_fields. Log field index numbers to append custom log fields to log messa… |
|
(list) Names of devices or device groups that can be matched by the policy. |
|
Deprecated, please rename it to diffserv_forward. Enable to change packets DiffServ values to the specified diffservcode-f… Choices:
|
|
Deprecated, please rename it to diffserv_reverse. Enable to change packets reverse Choices:
|
|
Deprecated, please rename it to diffservcode_forward. Change packets DiffServ to this value. |
|
Deprecated, please rename it to diffservcode_rev. Change packets reverse |
|
Deprecated, please rename it to dlp_sensor. Name of an existing DLP sensor. |
|
Deprecated, please rename it to dnsfilter_profile. Name of an existing DNS filter profile. |
|
Deprecated, please rename it to dscp_match. Enable DSCP check. Choices:
|
|
Deprecated, please rename it to dscp_negate. Enable negated DSCP match. Choices:
|
|
Deprecated, please rename it to dscp_value. DSCP value. |
|
Enable DSRI to ignore HTTP server responses. Choices:
|
|
(list) Destination address and address group names. |
|
Deprecated, please rename it to dstaddr_negate. When enabled dstaddr specifies what the destination address must NOT be. Choices:
|
|
(list) Outgoing |
|
Deprecated, please rename it to emailfilter_profile. Name of an existing email filter profile. |
|
Deprecated, please rename it to firewall_session_dirty. How to handle sessions if the configuration of this firewall polic… Choices:
|
|
Enable to prevent source NAT from changing a sessions source port. Choices:
|
|
(list) Deprecated, please rename it to fsso_groups. Names of FSSO groups. |
|
Deprecated, please rename it to global_label. Label for the policy that appears when the GUI is in Global View mode. |
|
(list) Names of user groups that can authenticate with this policy. |
|
Deprecated, please rename it to http_policy_redirect. Redirect HTTP Choices:
|
|
Deprecated, please rename it to icap_profile. Name of an existing ICAP profile. |
|
Policy-based IPsec VPN Choices:
|
|
Deprecated, please rename it to inspection_mode. Policy inspection mode Choices:
|
|
Enable to use IP Pools for source NAT. Choices:
|
|
Deprecated, please rename it to ips_sensor. Name of an existing IPS sensor. |
|
Label for the policy that appears when the GUI is in Section View mode. |
|
Enable or disable logging. Choices:
|
|
Deprecated, please rename it to logtraffic_start. Record logs when a session starts. Choices:
|
|
Deprecated, please rename it to mms_profile. Name of an existing MMS profile. |
|
Policy name. |
|
Enable/disable source NAT. Choices:
|
|
Policy-based IPsec VPN Choices:
|
|
Policy-based IPsec VPN Choices:
|
|
Deprecated, please rename it to np_acceleration. Enable/disable UTM Network Processor acceleration. Choices:
|
|
Policy-based IPsec VPN Choices:
|
|
Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper. |
|
Deprecated, please rename it to policy_offload. Policy offload. Choices:
|
|
Policy ID |
|
(list) IP Pool names. |
|
Deprecated, please rename it to profile_group. Name of profile group. |
|
Deprecated, please rename it to profile_protocol_options. Name of an existing Protocol options profile. |
|
Deprecated, please rename it to profile_type. Determine whether the firewall policy allows security profile groups or sing… Choices:
|
|
Deprecated, please rename it to replacemsg_override_group. Override the default replacement message group for this policy. |
|
Enable/disable RADIUS single sign-on Choices:
|
|
Schedule name. |
|
Deprecated, please rename it to send_deny_packet. Enable/disable return of deny-packet. Choices:
|
|
(list) Service and service group names. |
|
Deprecated, please rename it to service_negate. When enabled service specifies what the service must NOT be. Choices:
|
|
Deprecated, please rename it to session_ttl. Session TTL in seconds for sessions accepted by this policy. |
|
Deprecated, please rename it to spamfilter_profile. Name of an existing Spam filter profile. |
|
(list) Source address and address group names. |
|
Deprecated, please rename it to srcaddr_negate. When enabled srcaddr specifies what the source address must NOT be. Choices:
|
|
(list) Incoming |
|
Deprecated, please rename it to ssh_filter_profile. Name of an existing SSH filter profile. |
|
Deprecated, please rename it to ssh_policy_redirect. Redirect SSH traffic to matching transparent proxy policy. Choices:
|
|
Deprecated, please rename it to ssl_mirror. Enable to copy decrypted SSL traffic to a FortiGate interface Choices:
|
|
(list) Deprecated, please rename it to ssl_mirror_intf. SSL mirror interface name. |
|
Deprecated, please rename it to ssl_ssh_profile. Name of an existing SSL SSH profile. |
|
Enable or disable this policy. Choices:
|
|
Deprecated, please rename it to tcp_mss_receiver. Receiver TCP maximum segment size |
|
Deprecated, please rename it to tcp_mss_sender. Sender TCP maximum segment size |
|
Deprecated, please rename it to tcp_session_without_syn. Enable/disable creation of TCP session without SYN flag. Choices:
|
|
Deprecated, please rename it to timeout_send_rst. Enable/disable sending RST packets when TCP sessions expire. Choices:
|
|
ToS |
|
Deprecated, please rename it to tos_mask. Non-zero bit positions are used for comparison while zero bit positions are ignored. |
|
Deprecated, please rename it to tos_negate. Enable negated TOS match. Choices:
|
|
Deprecated, please rename it to traffic_shaper. Reverse traffic shaper. |
|
Deprecated, please rename it to traffic_shaper_reverse. Reverse traffic shaper. |
|
(list) Deprecated, please rename it to url_category. URL category ID list. |
|
(list) Names of individual users that can authenticate with this policy. |
|
Deprecated, please rename it to utm_status. Enable AV/web/ips protection profile. Choices:
|
|
Universally Unique Identifier |
|
Deprecated, please rename it to vlan_cos_fwd. VLAN forward direction user priority |
|
Deprecated, please rename it to vlan_cos_rev. VLAN reverse direction user priority |
|
Deprecated, please rename it to vlan_filter. Set VLAN filters. |
|
Deprecated, please rename it to voip_profile. Name of an existing VoIP profile. |
|
Policy-based IPsec VPN |
|
Deprecated, please rename it to waf_profile. Name of an existing Web application firewall profile. |
|
Enable/disable web cache. Choices:
|
|
Deprecated, please rename it to webcache_https. Enable/disable web cache for HTTPS. Choices:
|
|
Deprecated, please rename it to webfilter_profile. Name of an existing Web filter profile. |
|
Deprecated, please rename it to webproxy_forward_server. Web proxy forward server name. |
|
Deprecated, please rename it to webproxy_profile. Webproxy profile name. |
|
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 (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 policies.
fortinet.fortimanager.fmgr_pm_config_pblock_firewall_policy6:
# 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, ...]
adom: <your own value>
pblock: <your own value>
state: present # <value in [present, absent]>
pm_config_pblock_firewall_policy6:
_policy_block: <integer>
action: <value in [deny, accept, ipsec, ...]>
anti_replay: <value in [disable, enable]>
app_category: <list or string>
app_group: <list or string>
application: <list or integer>
application_list: <string>
auto_asic_offload: <value in [disable, enable]>
av_profile: <string>
cgn_log_server_grp: <string>
cifs_profile: <string>
comments: <string>
custom_log_fields: <list or string>
diffserv_forward: <value in [disable, enable]>
diffserv_reverse: <value in [disable, enable]>
diffservcode_forward: <string>
diffservcode_rev: <string>
dlp_sensor: <string>
dnsfilter_profile: <string>
dsri: <value in [disable, enable]>
dstaddr: <list or string>
dstaddr_negate: <value in [disable, enable]>
dstintf: <list or string>
emailfilter_profile: <string>
firewall_session_dirty: <value in [check-all, check-new]>
fixedport: <value in [disable, enable]>
fsso_groups: <list or string>
global_label: <string>
groups: <list or string>
http_policy_redirect: <value in [disable, enable]>
icap_profile: <string>
inbound: <value in [disable, enable]>
inspection_mode: <value in [proxy, flow]>
ippool: <value in [disable, enable]>
ips_sensor: <string>
label: <string>
logtraffic: <value in [disable, enable, all, ...]>
logtraffic_start: <value in [disable, enable]>
mms_profile: <string>
name: <string>
nat: <value in [disable, enable]>
natinbound: <value in [disable, enable]>
natoutbound: <value in [disable, enable]>
np_acceleration: <value in [disable, enable]>
outbound: <value in [disable, enable]>
per_ip_shaper: <string>
policy_offload: <value in [disable, enable]>
policyid: <integer>
poolname: <list or string>
profile_group: <string>
profile_protocol_options: <string>
profile_type: <value in [single, group]>
replacemsg_override_group: <string>
rsso: <value in [disable, enable]>
schedule: <string>
send_deny_packet: <value in [disable, enable]>
service: <list or string>
service_negate: <value in [disable, enable]>
session_ttl: <string>
srcaddr: <list or string>
srcaddr_negate: <value in [disable, enable]>
srcintf: <list or string>
ssh_filter_profile: <string>
ssh_policy_redirect: <value in [disable, enable]>
ssl_mirror: <value in [disable, enable]>
ssl_mirror_intf: <list or string>
ssl_ssh_profile: <string>
status: <value in [disable, enable]>
tcp_mss_receiver: <integer>
tcp_mss_sender: <integer>
tcp_session_without_syn: <value in [all, data-only, disable]>
timeout_send_rst: <value in [disable, enable]>
tos: <string>
tos_mask: <string>
tos_negate: <value in [disable, enable]>
traffic_shaper: <string>
traffic_shaper_reverse: <string>
url_category: <list or string>
users: <list or string>
utm_status: <value in [disable, enable]>
uuid: <string>
vlan_cos_fwd: <integer>
vlan_cos_rev: <integer>
vlan_filter: <string>
voip_profile: <string>
vpntunnel: <string>
waf_profile: <string>
webcache: <value in [disable, enable]>
webcache_https: <value in [disable, enable]>
webfilter_profile: <string>
webproxy_forward_server: <string>
webproxy_profile: <string>
dscp_negate: <value in [disable, enable]>
devices: <list or string>
dscp_value: <string>
spamfilter_profile: <string>
dscp_match: <value in [disable, enable]>
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 |