fortinet.fortimanager.fmgr_pkg_firewall_policy module – Configure IPv4 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_firewall_policy.

New in fortinet.fortimanager 1.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

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

pkg

string / required

The parameter (pkg) in requested url.

pkg_firewall_policy

dictionary

The top level parameters set.

_policy_block

integer

Assigned policy block.

action

string

Policy action

Choices:

  • "deny"

  • "accept"

  • "ipsec"

  • "ssl-vpn"

  • "redirect"

  • "isolate"

anti-replay

string

Deprecated, please rename it to anti_replay. Enable/disable anti-replay check.

Choices:

  • "disable"

  • "enable"

app-category

any

(list or str) Deprecated, please rename it to app_category. Application category ID list.

app-group

any

(list or str) Deprecated, please rename it to app_group. Application group names.

application

any

(list) Application ID list.

application-list

string

Deprecated, please rename it to application_list. Name of an existing Application list.

auth-cert

string

Deprecated, please rename it to auth_cert. HTTPS server certificate for policy authentication.

auth-path

string

Deprecated, please rename it to auth_path. Enable/disable authentication-based routing.

Choices:

  • "disable"

  • "enable"

auth-redirect-addr

string

Deprecated, please rename it to auth_redirect_addr. HTTP-to-HTTPS redirect address for firewall authentication.

auto-asic-offload

string

Deprecated, please rename it to auto_asic_offload. Enable/disable offloading security profile processing to CP processors.

Choices:

  • "disable"

  • "enable"

av-profile

string

Deprecated, please rename it to av_profile. Name of an existing Antivirus profile.

best-route

string

Deprecated, please rename it to best_route. Enable/disable the use of best route.

Choices:

  • "disable"

  • "enable"

block-notification

string

Deprecated, please rename it to block_notification. Enable/disable block notification.

Choices:

  • "disable"

  • "enable"

captive-portal-exempt

string

Deprecated, please rename it to captive_portal_exempt. Enable to exempt some users from the captive portal.

Choices:

  • "disable"

  • "enable"

capture-packet

string

Deprecated, please rename it to capture_packet. Enable/disable capture packets.

Choices:

  • "disable"

  • "enable"

casb-profile

string

Deprecated, please rename it to casb_profile. Name of an existing CASB profile.

casi-profile

string

Deprecated, please rename it to casi_profile. CASI profile.

cgn-eif

string

Deprecated, please rename it to cgn_eif. Enable/Disable CGN endpoint independent filtering.

Choices:

  • "disable"

  • "enable"

cgn-eim

string

Deprecated, please rename it to cgn_eim. Enable/Disable CGN endpoint independent mapping

Choices:

  • "disable"

  • "enable"

cgn-log-server-grp

string

Deprecated, please rename it to cgn_log_server_grp. NP log server group name

cgn-resource-quota

integer

Deprecated, please rename it to cgn_resource_quota. Resource quota

cgn-session-quota

integer

Deprecated, please rename it to cgn_session_quota. Session quota

cgn-sw-eif-ctrl

string

Deprecated, please rename it to cgn_sw_eif_ctrl. Enable/disable software endpoint independent filtering control.

Choices:

  • "disable"

  • "enable"

cifs-profile

string

Deprecated, please rename it to cifs_profile. Name of an existing CIFS profile.

comments

any

(dict or str) Comments.

custom-log-fields

any

(list or str) Deprecated, please rename it to custom_log_fields. Custom fields to append to log messages for this policy.

decrypted-traffic-mirror

string

Deprecated, please rename it to decrypted_traffic_mirror. Decrypted traffic mirror.

delay-tcp-npu-session

string

Deprecated, please rename it to delay_tcp_npu_session. Enable TCP NPU session delay to guarantee packet order of 3-way han…

Choices:

  • "disable"

  • "enable"

delay-tcp-npu-sessoin

string

Deprecated, please rename it to delay_tcp_npu_sessoin. Enable/disable TCP NPU session delay in order to guarantee packet o…

Choices:

  • "disable"

  • "enable"

devices

any

(list or str) Names of devices or device groups that can be matched by the policy.

diameter-filter-profile

string

Deprecated, please rename it to diameter_filter_profile. Name of an existing Diameter filter profile.

diffserv-copy

string

Deprecated, please rename it to diffserv_copy. Enable to copy packets DiffServ values from sessions original direction to …

Choices:

  • "disable"

  • "enable"

diffserv-forward

string

Deprecated, please rename it to diffserv_forward. Enable to change packets DiffServ values to the specified diffservcode-f…

Choices:

  • "disable"

  • "enable"

diffserv-reverse

string

Deprecated, please rename it to diffserv_reverse. Enable to change packets reverse

Choices:

  • "disable"

  • "enable"

diffservcode-forward

string

Deprecated, please rename it to diffservcode_forward. Change packets DiffServ to this value.

diffservcode-rev

string

Deprecated, please rename it to diffservcode_rev. Change packets reverse

disclaimer

string

Enable/disable user authentication disclaimer.

Choices:

  • "disable"

  • "enable"

  • "user"

  • "domain"

  • "policy"

dlp-profile

string

Deprecated, please rename it to dlp_profile. Name of an existing DLP profile.

dlp-sensor

string

Deprecated, please rename it to dlp_sensor. Name of an existing DLP sensor.

dnsfilter-profile

string

Deprecated, please rename it to dnsfilter_profile. Name of an existing DNS filter profile.

dscp-match

string

Deprecated, please rename it to dscp_match. Enable DSCP check.

Choices:

  • "disable"

  • "enable"

dscp-negate

string

Deprecated, please rename it to dscp_negate. Enable negated DSCP match.

Choices:

  • "disable"

  • "enable"

dscp-value

string

Deprecated, please rename it to dscp_value. DSCP value.

dsri

string

Enable DSRI to ignore HTTP server responses.

Choices:

  • "disable"

  • "enable"

dstaddr

any

(list or str) Destination address and address group names.

dstaddr-negate

string

Deprecated, please rename it to dstaddr_negate. When enabled dstaddr specifies what the destination address must NOT be.

Choices:

  • "disable"

  • "enable"

dstaddr6

any

(list or str) Destination IPv6 address name and address group names.

dstaddr6-negate

string

Deprecated, please rename it to dstaddr6_negate. When enabled dstaddr6 specifies what the destination address must NOT be.

Choices:

  • "disable"

  • "enable"

dstintf

any

(list or str) Outgoing

dynamic-shaping

string

Deprecated, please rename it to dynamic_shaping. Enable/disable dynamic RADIUS defined traffic shaping.

Choices:

  • "disable"

  • "enable"

eif-check

string

Deprecated, please rename it to eif_check. Enable/Disable check endpoint-independent-filtering pinhole.

Choices:

  • "disable"

  • "enable"

eif-learn

string

Deprecated, please rename it to eif_learn. Enable/Disable learning of end-point-independent filtering pinhole.

Choices:

  • "disable"

  • "enable"

email-collect

string

Deprecated, please rename it to email_collect. Enable/disable email collection.

Choices:

  • "disable"

  • "enable"

emailfilter-profile

string

Deprecated, please rename it to emailfilter_profile. Name of an existing email filter profile.

fec

string

Enable/disable Forward Error Correction on traffic matching this policy on a FEC device.

Choices:

  • "disable"

  • "enable"

file-filter-profile

string

Deprecated, please rename it to file_filter_profile. Name of an existing file-filter profile.

firewall-session-dirty

string

Deprecated, please rename it to firewall_session_dirty. How to handle sessions if the configuration of this firewall polic…

Choices:

  • "check-all"

  • "check-new"

fixedport

string

Enable to prevent source NAT from changing a sessions source port.

Choices:

  • "disable"

  • "enable"

fsso

string

Enable/disable Fortinet Single Sign-On.

Choices:

  • "disable"

  • "enable"

fsso-agent-for-ntlm

string

Deprecated, please rename it to fsso_agent_for_ntlm. FSSO agent to use for NTLM authentication.

fsso-groups

any

(list or str) Deprecated, please rename it to fsso_groups. Names of FSSO groups.

geoip-anycast

string

Deprecated, please rename it to geoip_anycast. Enable/disable recognition of anycast IP addresses using the geography IP d…

Choices:

  • "disable"

  • "enable"

geoip-match

string

Deprecated, please rename it to geoip_match. Match geography address based either on its physical location or registered l…

Choices:

  • "physical-location"

  • "registered-location"

global-label

string

Deprecated, please rename it to global_label. Label for the policy that appears when the GUI is in Global View mode.

groups

any

(list or str) Names of user groups that can authenticate with this policy.

gtp-profile

string

Deprecated, please rename it to gtp_profile. GTP profile.

http-policy-redirect

string

Deprecated, please rename it to http_policy_redirect. Redirect HTTP

Choices:

  • "disable"

  • "enable"

icap-profile

string

Deprecated, please rename it to icap_profile. Name of an existing ICAP profile.

identity-based-route

string

Deprecated, please rename it to identity_based_route. Name of identity-based routing rule.

inbound

string

Policy-based IPsec VPN

Choices:

  • "disable"

  • "enable"

inspection-mode

string

Deprecated, please rename it to inspection_mode. Policy inspection mode

Choices:

  • "proxy"

  • "flow"

internet-service

string

Deprecated, please rename it to internet_service. Enable/disable use of Internet Services for this policy.

Choices:

  • "disable"

  • "enable"

internet-service-custom

any

(list or str) Deprecated, please rename it to internet_service_custom. Custom Internet Service Name.

internet-service-custom-group

any

(list or str) Deprecated, please rename it to internet_service_custom_group. Custom Internet Service group name.

internet-service-group

any

(list or str) Deprecated, please rename it to internet_service_group. Internet Service group name.

internet-service-id

any

(list or str) Deprecated, please rename it to internet_service_id. Internet Service ID.

internet-service-name

any

(list or str) Deprecated, please rename it to internet_service_name. Internet Service name.

internet-service-negate

string

Deprecated, please rename it to internet_service_negate. When enabled internet-service specifies what the service must NOT be.

Choices:

  • "disable"

  • "enable"

internet-service-src

string

Deprecated, please rename it to internet_service_src. Enable/disable use of Internet Services in source for this policy.

Choices:

  • "disable"

  • "enable"

internet-service-src-custom

any

(list or str) Deprecated, please rename it to internet_service_src_custom. Custom Internet Service source name.

internet-service-src-custom-group

any

(list or str) Deprecated, please rename it to internet_service_src_custom_group. Custom Internet Service source group name.

internet-service-src-group

any

(list or str) Deprecated, please rename it to internet_service_src_group. Internet Service source group name.

internet-service-src-id

any

(list or str) Deprecated, please rename it to internet_service_src_id. Internet Service source ID.

internet-service-src-name

any

(list or str) Deprecated, please rename it to internet_service_src_name. Internet Service source name.

internet-service-src-negate

string

Deprecated, please rename it to internet_service_src_negate. When enabled internet-service-src specifies what the service …

Choices:

  • "disable"

  • "enable"

internet-service6

string

Deprecated, please rename it to internet_service6. Enable/disable use of IPv6 Internet Services for this policy.

Choices:

  • "disable"

  • "enable"

internet-service6-custom

any

(list) Deprecated, please rename it to internet_service6_custom. Custom IPv6 Internet Service name.

internet-service6-custom-group

any

(list) Deprecated, please rename it to internet_service6_custom_group. Custom Internet Service6 group name.

internet-service6-group

any

(list) Deprecated, please rename it to internet_service6_group. Internet Service group name.

internet-service6-name

any

(list) Deprecated, please rename it to internet_service6_name. IPv6 Internet Service name.

internet-service6-negate

string

Deprecated, please rename it to internet_service6_negate. When enabled internet-service6 specifies what the service must N…

Choices:

  • "disable"

  • "enable"

internet-service6-src

string

Deprecated, please rename it to internet_service6_src. Enable/disable use of IPv6 Internet Services in source for this policy.

Choices:

  • "disable"

  • "enable"

internet-service6-src-custom

any

(list) Deprecated, please rename it to internet_service6_src_custom. Custom IPv6 Internet Service source name.

internet-service6-src-custom-group

any

(list) Deprecated, please rename it to internet_service6_src_custom_group. Custom Internet Service6 source group name.

internet-service6-src-group

any

(list) Deprecated, please rename it to internet_service6_src_group. Internet Service6 source group name.

internet-service6-src-name

any

(list) Deprecated, please rename it to internet_service6_src_name. IPv6 Internet Service source name.

internet-service6-src-negate

string

Deprecated, please rename it to internet_service6_src_negate. When enabled internet-service6-src specifies what the servic…

Choices:

  • "disable"

  • "enable"

ip-version-type

string

Deprecated, please rename it to ip_version_type. IP version of the policy.

ippool

string

Enable to use IP Pools for source NAT.

Choices:

  • "disable"

  • "enable"

ips-sensor

string

Deprecated, please rename it to ips_sensor. Name of an existing IPS sensor.

ips-voip-filter

string

Deprecated, please rename it to ips_voip_filter. Name of an existing VoIP

label

string

Label for the policy that appears when the GUI is in Section View mode.

learning-mode

string

Deprecated, please rename it to learning_mode. Enable to allow everything, but log all of the meaningful data for security…

Choices:

  • "disable"

  • "enable"

log-http-transaction

string

Deprecated, please rename it to log_http_transaction. Enable/disable HTTP transaction log.

Choices:

  • "disable"

  • "enable"

  • "all"

  • "utm"

logtraffic

string

Enable or disable logging.

Choices:

  • "disable"

  • "enable"

  • "all"

  • "utm"

logtraffic-start

string

Deprecated, please rename it to logtraffic_start. Record logs when a session starts and ends.

Choices:

  • "disable"

  • "enable"

match-vip

string

Deprecated, please rename it to match_vip. Enable to match packets that have had their destination addresses changed by a VIP.

Choices:

  • "disable"

  • "enable"

match-vip-only

string

Deprecated, please rename it to match_vip_only. Enable/disable matching of only those packets that have had their destinat…

Choices:

  • "disable"

  • "enable"

mms-profile

string

Deprecated, please rename it to mms_profile. Name of an existing MMS profile.

name

string

Policy name.

nat

string

Enable/disable source NAT.

Choices:

  • "disable"

  • "enable"

nat46

string

Enable/disable NAT46.

Choices:

  • "disable"

  • "enable"

nat64

string

Enable/disable NAT64.

Choices:

  • "disable"

  • "enable"

natinbound

string

Policy-based IPsec VPN

Choices:

  • "disable"

  • "enable"

natip

string

Policy-based IPsec VPN

natoutbound

string

Policy-based IPsec VPN

Choices:

  • "disable"

  • "enable"

network-service-dynamic

any

(list) Deprecated, please rename it to network_service_dynamic. Dynamic Network Service name.

network-service-src-dynamic

any

(list) Deprecated, please rename it to network_service_src_dynamic. Dynamic Network Service source name.

np-accelation

string

Deprecated, please rename it to np_accelation. Enable/disable UTM Network Processor acceleration.

Choices:

  • "disable"

  • "enable"

np-acceleration

string

Deprecated, please rename it to np_acceleration. Enable/disable UTM Network Processor acceleration.

Choices:

  • "disable"

  • "enable"

ntlm

string

Enable/disable NTLM authentication.

Choices:

  • "disable"

  • "enable"

ntlm-enabled-browsers

any

(list) Deprecated, please rename it to ntlm_enabled_browsers. HTTP-User-Agent value of supported browsers.

ntlm-guest

string

Deprecated, please rename it to ntlm_guest. Enable/disable NTLM guest user access.

Choices:

  • "disable"

  • "enable"

object position

list / elements=string

Deprecated, please rename it to object_position. Object position.

outbound

string

Policy-based IPsec VPN

Choices:

  • "disable"

  • "enable"

passive-wan-health-measurement

string

Deprecated, please rename it to passive_wan_health_measurement. Enable/disable passive WAN health measurement.

Choices:

  • "disable"

  • "enable"

pcp-inbound

string

Deprecated, please rename it to pcp_inbound. Enable/disable PCP inbound DNAT.

Choices:

  • "disable"

  • "enable"

pcp-outbound

string

Deprecated, please rename it to pcp_outbound. Enable/disable PCP outbound SNAT.

Choices:

  • "disable"

  • "enable"

pcp-poolname

any

(list) Deprecated, please rename it to pcp_poolname. PCP pool names.

per-ip-shaper

string

Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper.

permit-any-host

string

Deprecated, please rename it to permit_any_host. Accept UDP packets from any host.

Choices:

  • "disable"

  • "enable"

permit-stun-host

string

Deprecated, please rename it to permit_stun_host. Accept UDP packets from any Session Traversal Utilities for NAT

Choices:

  • "disable"

  • "enable"

pfcp-profile

string

Deprecated, please rename it to pfcp_profile. PFCP profile.

policy-behaviour-type

string

Deprecated, please rename it to policy_behaviour_type. Behaviour of the policy.

policy-expiry

string

Deprecated, please rename it to policy_expiry. Enable/disable policy expiry.

Choices:

  • "disable"

  • "enable"

policy-expiry-date

string

Deprecated, please rename it to policy_expiry_date. Policy expiry date

policy-expiry-date-utc

string

Deprecated, please rename it to policy_expiry_date_utc. Policy expiry date and time, in epoch format.

policy-offload

string

Deprecated, please rename it to policy_offload. Enable/Disable hardware session setup for CGNAT.

Choices:

  • "disable"

  • "enable"

policyid

integer / required

Policy ID.

poolname

any

(list or str) IP Pool names.

poolname6

any

(list or str) IPv6 pool names.

port-preserve

string

Deprecated, please rename it to port_preserve. Enable/disable preservation of the original source port from source NAT if …

Choices:

  • "disable"

  • "enable"

profile-group

string

Deprecated, please rename it to profile_group. Name of profile group.

profile-protocol-options

string

Deprecated, please rename it to profile_protocol_options. Name of an existing Protocol options profile.

profile-type

string

Deprecated, please rename it to profile_type. Determine whether the firewall policy allows security profile groups or sing…

Choices:

  • "single"

  • "group"

radius-ip-auth-bypass

string

Deprecated, please rename it to radius_ip_auth_bypass. Enable IP authentication bypass.

Choices:

  • "disable"

  • "enable"

radius-mac-auth-bypass

string

Deprecated, please rename it to radius_mac_auth_bypass. Enable MAC authentication bypass.

Choices:

  • "disable"

  • "enable"

redirect-url

string

Deprecated, please rename it to redirect_url. URL users are directed to after seeing and accepting the disclaimer or authe…

replacemsg-override-group

string

Deprecated, please rename it to replacemsg_override_group. Override the default replacement message group for this policy.

reputation-direction

string

Deprecated, please rename it to reputation_direction. Direction of the initial traffic for reputation to take effect.

Choices:

  • "source"

  • "destination"

reputation-direction6

string

Deprecated, please rename it to reputation_direction6. Direction of the initial traffic for IPv6 reputation to take effect.

Choices:

  • "source"

  • "destination"

reputation-minimum

integer

Deprecated, please rename it to reputation_minimum. Minimum Reputation to take action.

reputation-minimum6

integer

Deprecated, please rename it to reputation_minimum6. IPv6 Minimum Reputation to take action.

rsso

string

Enable/disable RADIUS single sign-on

Choices:

  • "disable"

  • "enable"

rtp-addr

any

(list or str) Deprecated, please rename it to rtp_addr. Address names if this is an RTP NAT policy.

rtp-nat

string

Deprecated, please rename it to rtp_nat. Enable Real Time Protocol

Choices:

  • "disable"

  • "enable"

scan-botnet-connections

string

Deprecated, please rename it to scan_botnet_connections. Block or monitor connections to Botnet servers or disable Botnet …

Choices:

  • "disable"

  • "block"

  • "monitor"

schedule

string

Schedule name.

schedule-timeout

string

Deprecated, please rename it to schedule_timeout. Enable to force current sessions to end when the schedule object times out.

Choices:

  • "disable"

  • "enable"

sctp-filter-profile

string

Deprecated, please rename it to sctp_filter_profile. Name of an existing SCTP filter profile.

send-deny-packet

string

Deprecated, please rename it to send_deny_packet. Enable to send a reply when a session is denied or blocked by a firewall…

Choices:

  • "disable"

  • "enable"

service

any

(list or str) Service and service group names.

service-negate

string

Deprecated, please rename it to service_negate. When enabled service specifies what the service must NOT be.

Choices:

  • "disable"

  • "enable"

session-ttl

any

(int or str) Deprecated, please rename it to session_ttl. Session TTL in seconds for sessions accepted by this policy.

sgt

any

(list) Security group tags.

sgt-check

string

Deprecated, please rename it to sgt_check. Enable/disable security group tags

Choices:

  • "disable"

  • "enable"

spamfilter-profile

string

Deprecated, please rename it to spamfilter_profile. Name of an existing Spam filter profile.

src-vendor-mac

any

(list or str) Deprecated, please rename it to src_vendor_mac. Vendor MAC source ID.

srcaddr

any

(list or str) Source address and address group names.

srcaddr-negate

string

Deprecated, please rename it to srcaddr_negate. When enabled srcaddr specifies what the source address must NOT be.

Choices:

  • "disable"

  • "enable"

srcaddr6

any

(list or str) Source IPv6 address name and address group names.

srcaddr6-negate

string

Deprecated, please rename it to srcaddr6_negate. When enabled srcaddr6 specifies what the source address must NOT be.

Choices:

  • "disable"

  • "enable"

srcintf

any

(list or str) Incoming

ssh-filter-profile

string

Deprecated, please rename it to ssh_filter_profile. Name of an existing SSH filter profile.

ssh-policy-redirect

string

Deprecated, please rename it to ssh_policy_redirect. Redirect SSH traffic to matching transparent proxy policy.

Choices:

  • "disable"

  • "enable"

ssl-mirror

string

Deprecated, please rename it to ssl_mirror. Enable to copy decrypted SSL traffic to a FortiGate interface

Choices:

  • "disable"

  • "enable"

ssl-mirror-intf

any

(list or str) Deprecated, please rename it to ssl_mirror_intf. SSL mirror interface name.

ssl-ssh-profile

string

Deprecated, please rename it to ssl_ssh_profile. Name of an existing SSL SSH profile.

status

string

Enable or disable this policy.

Choices:

  • "disable"

  • "enable"

tags

string

Names of object-tags applied to this policy.

tcp-mss-receiver

integer

Deprecated, please rename it to tcp_mss_receiver. Receiver TCP maximum segment size

tcp-mss-sender

integer

Deprecated, please rename it to tcp_mss_sender. Sender TCP maximum segment size

tcp-session-without-syn

string

Deprecated, please rename it to tcp_session_without_syn. Enable/disable creation of TCP session without SYN flag.

Choices:

  • "all"

  • "data-only"

  • "disable"

tcp-timeout-pid

string

Deprecated, please rename it to tcp_timeout_pid. TCP timeout profile ID

timeout-send-rst

string

Deprecated, please rename it to timeout_send_rst. Enable/disable sending RST packets when TCP sessions expire.

Choices:

  • "disable"

  • "enable"

tos

string

ToS

tos-mask

string

Deprecated, please rename it to tos_mask. Non-zero bit positions are used for comparison while zero bit positions are ignored.

tos-negate

string

Deprecated, please rename it to tos_negate. Enable negated TOS match.

Choices:

  • "disable"

  • "enable"

traffic-shaper

string

Deprecated, please rename it to traffic_shaper. Traffic shaper.

traffic-shaper-reverse

string

Deprecated, please rename it to traffic_shaper_reverse. Reverse traffic shaper.

udp-timeout-pid

string

Deprecated, please rename it to udp_timeout_pid. UDP timeout profile ID

url-category

any

(list or str) Deprecated, please rename it to url_category. URL category ID list.

users

any

(list or str) Names of individual users that can authenticate with this policy.

utm-status

string

Deprecated, please rename it to utm_status. Enable to add one or more security profiles

Choices:

  • "disable"

  • "enable"

uuid

string

Universally Unique Identifier

videofilter-profile

string

Deprecated, please rename it to videofilter_profile. Name of an existing VideoFilter profile.

virtual-patch-profile

string

Deprecated, please rename it to virtual_patch_profile. Name of an existing virtual-patch profile.

vlan-cos-fwd

integer

Deprecated, please rename it to vlan_cos_fwd. VLAN forward direction user priority

vlan-cos-rev

integer

Deprecated, please rename it to vlan_cos_rev. VLAN reverse direction user priority

vlan-filter

string

Deprecated, please rename it to vlan_filter. Set VLAN filters.

voip-profile

string

Deprecated, please rename it to voip_profile. Name of an existing VoIP profile.

vpn_dst_node

list / elements=dictionary

Vpn dst node.

host

string

Host.

seq

integer

Seq.

subnet

string

Subnet.

vpn_src_node

list / elements=dictionary

Vpn src node.

host

string

Host.

seq

integer

Seq.

subnet

string

Subnet.

vpntunnel

string

Policy-based IPsec VPN

waf-profile

string

Deprecated, please rename it to waf_profile. Name of an existing Web application firewall profile.

wanopt

string

Enable/disable WAN optimization.

Choices:

  • "disable"

  • "enable"

wanopt-detection

string

Deprecated, please rename it to wanopt_detection. WAN optimization auto-detection mode.

Choices:

  • "active"

  • "passive"

  • "off"

wanopt-passive-opt

string

Deprecated, please rename it to wanopt_passive_opt. WAN optimization passive mode options.

Choices:

  • "default"

  • "transparent"

  • "non-transparent"

wanopt-peer

string

Deprecated, please rename it to wanopt_peer. WAN optimization peer.

wanopt-profile

string

Deprecated, please rename it to wanopt_profile. WAN optimization profile.

wccp

string

Enable/disable forwarding traffic matching this policy to a configured WCCP server.

Choices:

  • "disable"

  • "enable"

webcache

string

Enable/disable web cache.

Choices:

  • "disable"

  • "enable"

webcache-https

string

Deprecated, please rename it to webcache_https. Enable/disable web cache for HTTPS.

Choices:

  • "disable"

  • "ssl-server"

  • "any"

  • "enable"

webfilter-profile

string

Deprecated, please rename it to webfilter_profile. Name of an existing Web filter profile.

webproxy-forward-server

string

Deprecated, please rename it to webproxy_forward_server. Webproxy forward server name.

webproxy-profile

string

Deprecated, please rename it to webproxy_profile. Webproxy profile name.

wsso

string

Enable/disable WiFi Single Sign On

Choices:

  • "disable"

  • "enable"

ztna-device-ownership

string

Deprecated, please rename it to ztna_device_ownership. Enable/disable zero trust device ownership.

Choices:

  • "disable"

  • "enable"

ztna-ems-tag

any

(list or str) Deprecated, please rename it to ztna_ems_tag. Source ztna-ems-tag names.

ztna-ems-tag-secondary

any

(list) Deprecated, please rename it to ztna_ems_tag_secondary. Source ztna-ems-tag-secondary names.

ztna-geo-tag

any

(list or str) Deprecated, please rename it to ztna_geo_tag. Source ztna-geo-tag names.

ztna-policy-redirect

string

Deprecated, please rename it to ztna_policy_redirect. Redirect ZTNA traffic to matching Access-Proxy proxy-policy.

Choices:

  • "disable"

  • "enable"

ztna-status

string

Deprecated, please rename it to ztna_status. Enable/disable zero trust access.

Choices:

  • "disable"

  • "enable"

ztna-tags-match-logic

string

Deprecated, please rename it to ztna_tags_match_logic. ZTNA tag matching logic.

Choices:

  • "or"

  • "and"

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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 IPv4 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_policy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_policy:
          action: accept # <value in [deny, accept, ipsec, ...]>
          comments: ansible-comment
          dstaddr: all
          dstintf: any
          # name: ansible-test-policy
          nat: disable
          policyid: 1
          schedule: always
          service: ALL
          srcaddr: all
          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 IPv4 policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_policy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            policy: "your_value"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

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)