fortinet.fortimanager.fmgr_pm_config_pblock_firewall_policy module – Configure IPv4/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_policy.
New in fortinet.fortimanager 2.1.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 auth_cert. HTTPS server certificate for policy authentication. |
|
Deprecated, please rename it to auth_path. Enable/disable authentication-based routing. Choices:
|
|
Deprecated, please rename it to auth_redirect_addr. HTTP-to-HTTPS redirect address for firewall authentication. |
|
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 best_route. Best route. Choices:
|
|
Deprecated, please rename it to block_notification. Enable/disable block notification. Choices:
|
|
Deprecated, please rename it to captive_portal_exempt. Enable to exempt some users from the captive portal. Choices:
|
|
Deprecated, please rename it to capture_packet. Enable/disable capture packets. Choices:
|
|
Deprecated, please rename it to casb_profile. Name of an existing CASB profile. |
|
Deprecated, please rename it to cgn_eif. Enable/Disable CGN endpoint independent filtering. Choices:
|
|
Deprecated, please rename it to cgn_eim. Enable/Disable CGN endpoint independent mapping Choices:
|
|
Deprecated, please rename it to cgn_log_server_grp. NP log server group name |
|
Deprecated, please rename it to cgn_resource_quota. Resource quota |
|
Deprecated, please rename it to cgn_session_quota. Session quota |
|
Deprecated, please rename it to cgn_sw_eif_ctrl. Enable/disable software endpoint independent filtering control. Choices:
|
|
Deprecated, please rename it to cifs_profile. Name of an existing CIFS profile. |
|
Comment. |
|
(list) Deprecated, please rename it to custom_log_fields. Custom fields to append to log messages for this policy. |
|
Deprecated, please rename it to decrypted_traffic_mirror. Decrypted traffic mirror. |
|
Deprecated, please rename it to delay_tcp_npu_session. Enable TCP NPU session delay to guarantee packet order of 3-way han… Choices:
|
|
(list) Names of devices or device groups that can be matched by the policy. |
|
Deprecated, please rename it to diameter_filter_profile. Name of an existing Diameter filter profile. |
|
Deprecated, please rename it to diffserv_copy. Enable to copy packets DiffServ values from sessions original direction to … Choices:
|
|
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 |
|
Enable/disable user authentication disclaimer. Choices:
|
|
Deprecated, please rename it to dlp_profile. Name of an existing DLP profile. |
|
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 IPv4 address and address group names. |
|
Deprecated, please rename it to dstaddr_negate. When enabled dstaddr/dstaddr6 specifies what the destination address must … Choices:
|
|
(list) Destination IPv6 address name and address group names. |
|
Deprecated, please rename it to dstaddr6_negate. When enabled dstaddr6 specifies what the destination address must NOT be. Choices:
|
|
(list) Outgoing |
|
Deprecated, please rename it to dynamic_shaping. Enable/disable dynamic RADIUS defined traffic shaping. Choices:
|
|
Deprecated, please rename it to eif_check. Enable/Disable check endpoint-independent-filtering pinhole. Choices:
|
|
Deprecated, please rename it to eif_learn. Enable/Disable learning of end-point-independent filtering pinhole. Choices:
|
|
Deprecated, please rename it to email_collect. Enable/disable email collection. Choices:
|
|
Deprecated, please rename it to emailfilter_profile. Name of an existing email filter profile. |
|
Enable/disable Forward Error Correction on traffic matching this policy on a FEC device. Choices:
|
|
Deprecated, please rename it to file_filter_profile. Name of an existing file-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:
|
|
Enable/disable Fortinet Single Sign-On. Choices:
|
|
Deprecated, please rename it to fsso_agent_for_ntlm. FSSO agent to use for NTLM authentication. |
|
(list) Deprecated, please rename it to fsso_groups. Names of FSSO groups. |
|
Deprecated, please rename it to geoip_anycast. Enable/disable recognition of anycast IP addresses using the geography IP d… Choices:
|
|
Deprecated, please rename it to geoip_match. Match geography address based either on its physical location or registered l… Choices:
|
|
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 gtp_profile. GTP profile. |
|
Deprecated, please rename it to http_policy_redirect. Redirect HTTP Choices:
|
|
Deprecated, please rename it to icap_profile. Name of an existing ICAP profile. |
|
Deprecated, please rename it to identity_based_route. Name of identity-based routing rule. |
|
Policy-based IPsec VPN Choices:
|
|
Deprecated, please rename it to inspection_mode. Policy inspection mode Choices:
|
|
Deprecated, please rename it to internet_service. Enable/disable use of Internet Services for this policy. Choices:
|
|
(list) Deprecated, please rename it to internet_service_custom. Custom Internet Service name. |
|
(list) Deprecated, please rename it to internet_service_custom_group. Custom Internet Service group name. |
|
(list) Deprecated, please rename it to internet_service_group. Internet Service group name. |
|
(list) Deprecated, please rename it to internet_service_id. Internet Service ID. |
|
(list) Deprecated, please rename it to internet_service_name. Internet Service name. |
|
Deprecated, please rename it to internet_service_negate. When enabled internet-service specifies what the service must NOT be. Choices:
|
|
Deprecated, please rename it to internet_service_src. Enable/disable use of Internet Services in source for this policy. Choices:
|
|
(list) Deprecated, please rename it to internet_service_src_custom. Custom Internet Service source name. |
|
(list) Deprecated, please rename it to internet_service_src_custom_group. Custom Internet Service source group name. |
|
(list) Deprecated, please rename it to internet_service_src_group. Internet Service source group name. |
|
(list) Deprecated, please rename it to internet_service_src_id. Internet Service source ID. |
|
(list) Deprecated, please rename it to internet_service_src_name. Internet Service source name. |
|
Deprecated, please rename it to internet_service_src_negate. When enabled internet-service-src specifies what the service … Choices:
|
|
Deprecated, please rename it to internet_service6. Enable/disable use of IPv6 Internet Services for this policy. Choices:
|
|
(list) Deprecated, please rename it to internet_service6_custom. Custom IPv6 Internet Service name. |
|
(list) Deprecated, please rename it to internet_service6_custom_group. Custom Internet Service6 group name. |
|
(list) Deprecated, please rename it to internet_service6_group. Internet Service group name. |
|
(list) Deprecated, please rename it to internet_service6_name. IPv6 Internet Service name. |
|
Deprecated, please rename it to internet_service6_negate. When enabled internet-service6 specifies what the service must N… Choices:
|
|
Deprecated, please rename it to internet_service6_src. Enable/disable use of IPv6 Internet Services in source for this policy. Choices:
|
|
(list) Deprecated, please rename it to internet_service6_src_custom. Custom IPv6 Internet Service source name. |
|
(list) Deprecated, please rename it to internet_service6_src_custom_group. Custom Internet Service6 source group name. |
|
(list) Deprecated, please rename it to internet_service6_src_group. Internet Service6 source group name. |
|
(list) Deprecated, please rename it to internet_service6_src_name. IPv6 Internet Service source name. |
|
Deprecated, please rename it to internet_service6_src_negate. When enabled internet-service6-src specifies what the servic… Choices:
|
|
Deprecated, please rename it to ip_version_type. IP version of the policy. |
|
Enable to use IP Pools for source NAT. Choices:
|
|
Deprecated, please rename it to ips_sensor. Name of an existing IPS sensor. |
|
Deprecated, please rename it to ips_voip_filter. Name of an existing VoIP |
|
Label for the policy that appears when the GUI is in Section View mode. |
|
Deprecated, please rename it to learning_mode. Enable to allow everything, but log all of the meaningful data for security… Choices:
|
|
Deprecated, please rename it to log_http_transaction. Enable/disable HTTP transaction log. Choices:
|
|
Enable or disable logging. Choices:
|
|
Deprecated, please rename it to logtraffic_start. Record logs when a session starts. Choices:
|
|
Deprecated, please rename it to match_vip. Enable to match packets that have had their destination addresses changed by a VIP. Choices:
|
|
Deprecated, please rename it to match_vip_only. Enable/disable matching of only those packets that have had their destinat… Choices:
|
|
Deprecated, please rename it to mms_profile. Name of an existing MMS profile. |
|
Policy name. |
|
Enable/disable source NAT. Choices:
|
|
Enable/disable NAT46. Choices:
|
|
Enable/disable NAT64. Choices:
|
|
Policy-based IPsec VPN Choices:
|
|
Policy-based IPsec VPN |
|
Policy-based IPsec VPN Choices:
|
|
(list) Deprecated, please rename it to network_service_dynamic. Dynamic Network Service name. |
|
(list) Deprecated, please rename it to network_service_src_dynamic. Dynamic Network Service source name. |
|
Deprecated, please rename it to np_acceleration. Enable/disable UTM Network Processor acceleration. Choices:
|
|
Enable/disable NTLM authentication. Choices:
|
|
(list) Deprecated, please rename it to ntlm_enabled_browsers. HTTP-User-Agent value of supported browsers. |
|
Deprecated, please rename it to ntlm_guest. Enable/disable NTLM guest user access. Choices:
|
|
Policy-based IPsec VPN Choices:
|
|
Deprecated, please rename it to passive_wan_health_measurement. Enable/disable passive WAN health measurement. Choices:
|
|
Deprecated, please rename it to pcp_inbound. Enable/disable PCP inbound DNAT. Choices:
|
|
Deprecated, please rename it to pcp_outbound. Enable/disable PCP outbound SNAT. Choices:
|
|
(list) Deprecated, please rename it to pcp_poolname. PCP pool names. |
|
Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper. |
|
Deprecated, please rename it to permit_any_host. Accept UDP packets from any host. Choices:
|
|
Deprecated, please rename it to permit_stun_host. Accept UDP packets from any Session Traversal Utilities for NAT Choices:
|
|
Deprecated, please rename it to pfcp_profile. PFCP profile. |
|
Deprecated, please rename it to policy_behaviour_type. Behaviour of the policy. |
|
Deprecated, please rename it to policy_expiry. Enable/disable policy expiry. Choices:
|
|
Deprecated, please rename it to policy_expiry_date. Policy expiry date |
|
Deprecated, please rename it to policy_expiry_date_utc. Policy expiry date and time, in epoch format. |
|
Deprecated, please rename it to policy_offload. Enable/Disable hardware session setup for CGNAT. Choices:
|
|
Policy ID |
|
(list) IP Pool names. |
|
(list) IPv6 pool names. |
|
Deprecated, please rename it to port_preserve. Enable/disable preservation of the original source port from source NAT if … Choices:
|
|
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 radius_ip_auth_bypass. Enable IP authentication bypass. Choices:
|
|
Deprecated, please rename it to radius_mac_auth_bypass. Enable MAC authentication bypass. Choices:
|
|
Deprecated, please rename it to redirect_url. URL users are directed to after seeing and accepting the disclaimer or authe… |
|
Deprecated, please rename it to replacemsg_override_group. Override the default replacement message group for this policy. |
|
Deprecated, please rename it to reputation_direction. Direction of the initial traffic for reputation to take effect. Choices:
|
|
Deprecated, please rename it to reputation_direction6. Direction of the initial traffic for IPv6 reputation to take effect. Choices:
|
|
Deprecated, please rename it to reputation_minimum. Minimum Reputation to take action. |
|
Deprecated, please rename it to reputation_minimum6. IPv6 Minimum Reputation to take action. |
|
Enable/disable RADIUS single sign-on Choices:
|
|
(list) Deprecated, please rename it to rtp_addr. Address names if this is an RTP NAT policy. |
|
Deprecated, please rename it to rtp_nat. Enable Real Time Protocol Choices:
|
|
Deprecated, please rename it to scan_botnet_connections. Block or monitor connections to Botnet servers or disable Botnet … Choices:
|
|
Schedule name. |
|
Deprecated, please rename it to schedule_timeout. Enable to force current sessions to end when the schedule object times out. Choices:
|
|
Deprecated, please rename it to sctp_filter_profile. Name of an existing SCTP filter profile. |
|
Deprecated, please rename it to send_deny_packet. Enable to send a reply when a session is denied or blocked by a firewall… 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:
|
|
(int or str) Deprecated, please rename it to session_ttl. TTL in seconds for sessions accepted by this policy |
|
(list) Security group tags. |
|
Deprecated, please rename it to sgt_check. Enable/disable security group tags Choices:
|
|
Deprecated, please rename it to spamfilter_profile. Name of an existing Spam filter profile. |
|
(list) Deprecated, please rename it to src_vendor_mac. Vendor MAC source ID. |
|
(list) Source IPv4 address and address group names. |
|
Deprecated, please rename it to srcaddr_negate. When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. Choices:
|
|
(list) Source IPv6 address name and address group names. |
|
Deprecated, please rename it to srcaddr6_negate. When enabled srcaddr6 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 tcp_timeout_pid. TCP timeout profile ID |
|
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. Traffic shaper. |
|
Deprecated, please rename it to traffic_shaper_reverse. Reverse traffic shaper. |
|
Deprecated, please rename it to udp_timeout_pid. UDP timeout profile ID |
|
(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 to add one or more security profiles Choices:
|
|
Universally Unique Identifier |
|
Deprecated, please rename it to videofilter_profile. Name of an existing VideoFilter profile. |
|
Deprecated, please rename it to virtual_patch_profile. Name of an existing virtual-patch profile. |
|
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 WAN optimization. Choices:
|
|
Deprecated, please rename it to wanopt_detection. WAN optimization auto-detection mode. Choices:
|
|
Deprecated, please rename it to wanopt_passive_opt. WAN optimization passive mode options. Choices:
|
|
Deprecated, please rename it to wanopt_peer. WAN optimization peer. |
|
Deprecated, please rename it to wanopt_profile. WAN optimization profile. |
|
Enable/disable forwarding traffic matching this policy to a configured WCCP server. Choices:
|
|
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. Webproxy forward server name. |
|
Deprecated, please rename it to webproxy_profile. Webproxy profile name. |
|
Enable/disable WiFi Single Sign On Choices:
|
|
Deprecated, please rename it to ztna_device_ownership. Enable/disable zero trust device ownership. Choices:
|
|
(list) Deprecated, please rename it to ztna_ems_tag. Source ztna-ems-tag names. |
|
(list) Deprecated, please rename it to ztna_ems_tag_secondary. Source ztna-ems-tag-secondary names. |
|
(list) Deprecated, please rename it to ztna_geo_tag. Source ztna-geo-tag names. |
|
Deprecated, please rename it to ztna_policy_redirect. Redirect ZTNA traffic to matching Access-Proxy proxy-policy. Choices:
|
|
Deprecated, please rename it to ztna_status. Enable/disable zero trust access. Choices:
|
|
Deprecated, please rename it to ztna_tags_match_logic. ZTNA tag matching 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 (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 IPv4/IPv6 policies.
fortinet.fortimanager.fmgr_pm_config_pblock_firewall_policy:
# 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_policy:
_policy_block: <integer>
action: <value in [deny, accept, ipsec, ...]>
anti_replay: <value in [disable, enable]>
application_list: <string>
auth_cert: <string>
auth_path: <value in [disable, enable]>
auth_redirect_addr: <string>
auto_asic_offload: <value in [disable, enable]>
av_profile: <string>
block_notification: <value in [disable, enable]>
captive_portal_exempt: <value in [disable, enable]>
capture_packet: <value in [disable, enable]>
cifs_profile: <string>
comments: <string>
custom_log_fields: <list or string>
decrypted_traffic_mirror: <string>
delay_tcp_npu_session: <value in [disable, enable]>
diffserv_forward: <value in [disable, enable]>
diffserv_reverse: <value in [disable, enable]>
diffservcode_forward: <string>
diffservcode_rev: <string>
disclaimer: <value in [disable, enable, user, ...]>
dlp_profile: <string>
dnsfilter_profile: <string>
dsri: <value in [disable, enable]>
dstaddr: <list or string>
dstaddr_negate: <value in [disable, enable]>
dstaddr6: <list or string>
dstintf: <list or string>
dynamic_shaping: <value in [disable, enable]>
email_collect: <value in [disable, enable]>
emailfilter_profile: <string>
fec: <value in [disable, enable]>
file_filter_profile: <string>
firewall_session_dirty: <value in [check-all, check-new]>
fixedport: <value in [disable, enable]>
fsso_agent_for_ntlm: <string>
fsso_groups: <list or string>
geoip_anycast: <value in [disable, enable]>
geoip_match: <value in [physical-location, registered-location]>
global_label: <string>
groups: <list or string>
gtp_profile: <string>
http_policy_redirect: <value in [disable, enable]>
icap_profile: <string>
identity_based_route: <string>
inbound: <value in [disable, enable]>
inspection_mode: <value in [proxy, flow]>
internet_service: <value in [disable, enable]>
internet_service_custom: <list or string>
internet_service_custom_group: <list or string>
internet_service_group: <list or string>
internet_service_name: <list or string>
internet_service_negate: <value in [disable, enable]>
internet_service_src: <value in [disable, enable]>
internet_service_src_custom: <list or string>
internet_service_src_custom_group: <list or string>
internet_service_src_group: <list or string>
internet_service_src_name: <list or string>
internet_service_src_negate: <value in [disable, enable]>
ippool: <value in [disable, enable]>
ips_sensor: <string>
label: <string>
logtraffic: <value in [disable, enable, all, ...]>
logtraffic_start: <value in [disable, enable]>
match_vip: <value in [disable, enable]>
match_vip_only: <value in [disable, enable]>
name: <string>
nat: <value in [disable, enable]>
nat46: <value in [disable, enable]>
nat64: <value in [disable, enable]>
natinbound: <value in [disable, enable]>
natip: <string>
natoutbound: <value in [disable, enable]>
np_acceleration: <value in [disable, enable]>
ntlm: <value in [disable, enable]>
ntlm_enabled_browsers: <list or string>
ntlm_guest: <value in [disable, enable]>
outbound: <value in [disable, enable]>
passive_wan_health_measurement: <value in [disable, enable]>
per_ip_shaper: <string>
permit_any_host: <value in [disable, enable]>
permit_stun_host: <value in [disable, enable]>
pfcp_profile: <string>
policy_expiry: <value in [disable, enable]>
policy_expiry_date: <string>
policyid: <integer>
poolname: <list or string>
poolname6: <list or string>
profile_group: <string>
profile_protocol_options: <string>
profile_type: <value in [single, group]>
radius_mac_auth_bypass: <value in [disable, enable]>
redirect_url: <string>
replacemsg_override_group: <string>
reputation_direction: <value in [source, destination]>
reputation_minimum: <integer>
rtp_addr: <list or string>
rtp_nat: <value in [disable, enable]>
schedule: <string>
schedule_timeout: <value in [disable, enable]>
sctp_filter_profile: <string>
send_deny_packet: <value in [disable, enable]>
service: <list or string>
service_negate: <value in [disable, enable]>
session_ttl: <integer or string>
sgt: <list or integer>
sgt_check: <value in [disable, enable]>
src_vendor_mac: <list or string>
srcaddr: <list or string>
srcaddr_negate: <value in [disable, enable]>
srcaddr6: <list or string>
srcintf: <list or string>
ssh_filter_profile: <string>
ssh_policy_redirect: <value in [disable, enable]>
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>
users: <list or string>
utm_status: <value in [disable, enable]>
uuid: <string>
videofilter_profile: <string>
vlan_cos_fwd: <integer>
vlan_cos_rev: <integer>
vlan_filter: <string>
voip_profile: <string>
vpntunnel: <string>
waf_profile: <string>
wanopt: <value in [disable, enable]>
wanopt_detection: <value in [active, passive, off]>
wanopt_passive_opt: <value in [default, transparent, non-transparent]>
wanopt_peer: <string>
wanopt_profile: <string>
wccp: <value in [disable, enable]>
webcache: <value in [disable, enable]>
webcache_https: <value in [disable, ssl-server, any, ...]>
webfilter_profile: <string>
webproxy_forward_server: <string>
webproxy_profile: <string>
ztna_ems_tag: <list or string>
ztna_geo_tag: <list or string>
ztna_status: <value in [disable, enable]>
policy_offload: <value in [disable, enable]>
cgn_session_quota: <integer>
tcp_timeout_pid: <string>
udp_timeout_pid: <string>
dlp_sensor: <string>
cgn_eif: <value in [disable, enable]>
cgn_log_server_grp: <string>
cgn_resource_quota: <integer>
cgn_eim: <value in [disable, enable]>
mms_profile: <string>
app_category: <list or string>
internet_service_src_id: <list or string>
rsso: <value in [disable, enable]>
internet_service_id: <list or string>
best_route: <value in [disable, enable]>
fsso: <value in [disable, enable]>
url_category: <list or string>
app_group: <list or string>
ssl_mirror_intf: <list or string>
wsso: <value in [disable, enable]>
ssl_mirror: <value in [disable, enable]>
application: <list or integer>
dscp_negate: <value in [disable, enable]>
learning_mode: <value in [disable, enable]>
devices: <list or string>
dscp_value: <string>
spamfilter_profile: <string>
scan_botnet_connections: <value in [disable, block, monitor]>
dscp_match: <value in [disable, enable]>
diffserv_copy: <value in [disable, enable]>
dstaddr6_negate: <value in [disable, enable]>
internet_service6: <value in [disable, enable]>
internet_service6_custom: <list or string>
internet_service6_custom_group: <list or string>
internet_service6_group: <list or string>
internet_service6_name: <list or string>
internet_service6_negate: <value in [disable, enable]>
internet_service6_src: <value in [disable, enable]>
internet_service6_src_custom: <list or string>
internet_service6_src_custom_group: <list or string>
internet_service6_src_group: <list or string>
internet_service6_src_name: <list or string>
internet_service6_src_negate: <value in [disable, enable]>
network_service_dynamic: <list or string>
network_service_src_dynamic: <list or string>
reputation_direction6: <value in [source, destination]>
reputation_minimum6: <integer>
srcaddr6_negate: <value in [disable, enable]>
ip_version_type: <string>
ips_voip_filter: <string>
pcp_inbound: <value in [disable, enable]>
pcp_outbound: <value in [disable, enable]>
pcp_poolname: <list or string>
policy_behaviour_type: <string>
policy_expiry_date_utc: <string>
ztna_device_ownership: <value in [disable, enable]>
ztna_ems_tag_secondary: <list or string>
ztna_policy_redirect: <value in [disable, enable]>
ztna_tags_match_logic: <value in [or, and]>
casb_profile: <string>
virtual_patch_profile: <string>
diameter_filter_profile: <string>
port_preserve: <value in [disable, enable]>
cgn_sw_eif_ctrl: <value in [disable, enable]>
eif_check: <value in [disable, enable]>
eif_learn: <value in [disable, enable]>
log_http_transaction: <value in [disable, enable, all, ...]>
radius_ip_auth_bypass: <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 |