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.

pblock

string / required

The parameter (pblock) in requested url.

pm_config_pblock_firewall_consolidated_policy

dictionary

The top level parameters set.

_policy_block

integer

Assigned policy block.

action

string

Policy action

Choices:

• "deny"
• "accept"
• "ipsec"

app_category

aliases: app-category

any

(list) App category.

app_group

aliases: app-group

any

(list) App group.

application

any

(list) Application.

application_list

aliases: application-list

string

Name of an existing Application list.

auto_asic_offload

aliases: auto-asic-offload

string

Enable/disable policy traffic ASIC offloading.

Choices:

• "disable"
• "enable"

av_profile

aliases: av-profile

string

Name of an existing Antivirus profile.

captive_portal_exempt

aliases: captive-portal-exempt

string

Enable exemption of some users from the captive portal.

Choices:

• "disable"
• "enable"

cifs_profile

aliases: cifs-profile

string

Name of an existing CIFS profile.

comments

string

Comment.

diffserv_forward

aliases: diffserv-forward

string

Enable to change packets DiffServ values to the specified diffservcode-forward value.

Choices:

• "disable"
• "enable"

diffserv_reverse

aliases: diffserv-reverse

string

Enable to change packets reverse

Choices:

• "disable"
• "enable"

diffservcode_forward

aliases: diffservcode-forward

string

Change packets DiffServ to this value.

diffservcode_rev

aliases: diffservcode-rev

string

Change packets reverse

dlp_sensor

aliases: dlp-sensor

string

Name of an existing DLP sensor.

dnsfilter_profile

aliases: dnsfilter-profile

string

Name of an existing DNS filter profile.

dstaddr4

any

(list) Destination IPv4 address name and address group names.

dstaddr6

any

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

dstaddr_negate

aliases: dstaddr-negate

string

When enabled dstaddr specifies what the destination address must NOT be.

Choices:

• "disable"
• "enable"

dstintf

any

(list) Outgoing

emailfilter_profile

aliases: emailfilter-profile

string

Name of an existing email filter profile.

fixedport

string

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

Choices:

• "disable"
• "enable"

fsso_groups

aliases: fsso-groups

any

(list) Names of FSSO groups.

global_label

aliases: global-label

string

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

groups

any

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

http_policy_redirect

aliases: http-policy-redirect

string

Redirect HTTP

Choices:

• "disable"
• "enable"

icap_profile

aliases: icap-profile

string

Name of an existing ICAP profile.

inbound

string

Policy-based IPsec VPN

Choices:

• "disable"
• "enable"

inspection_mode

aliases: inspection-mode

string

Policy inspection mode

Choices:

• "proxy"
• "flow"

internet_service

aliases: internet-service

string

Enable/disable use of Internet Services for this policy.

Choices:

• "disable"
• "enable"

internet_service_custom

aliases: internet-service-custom

any

(list) Custom Internet Service name.

internet_service_custom_group

aliases: internet-service-custom-group

any

(list) Custom Internet Service group name.

internet_service_group

aliases: internet-service-group

any

(list) Internet Service group name.

internet_service_id

aliases: internet-service-id

any

(list) Internet Service ID.

internet_service_negate

aliases: internet-service-negate

string

When enabled internet-service specifies what the service must NOT be.

Choices:

• "disable"
• "enable"

internet_service_src

aliases: internet-service-src

string

Enable/disable use of Internet Services in source for this policy.

Choices:

• "disable"
• "enable"

internet_service_src_custom

aliases: internet-service-src-custom

any

(list) Custom Internet Service source name.

internet_service_src_custom_group

aliases: internet-service-src-custom-group

any

(list) Custom Internet Service source group name.

internet_service_src_group

aliases: internet-service-src-group

any

(list) Internet Service source group name.

internet_service_src_id

aliases: internet-service-src-id

any

(list) Internet Service source ID.

internet_service_src_negate

aliases: internet-service-src-negate

string

When enabled internet-service-src specifies what the service must NOT be.

Choices:

• "disable"
• "enable"

ippool

string

Enable to use IP Pools for source NAT.

Choices:

• "disable"
• "enable"

ips_sensor

aliases: ips-sensor

string

Name of an existing IPS sensor.

logtraffic

string

Enable or disable logging.

Choices:

• "disable"
• "all"
• "utm"

logtraffic_start

aliases: logtraffic-start

string

Record logs when a session starts.

Choices:

• "disable"
• "enable"

mms_profile

aliases: mms-profile

string

Name of an existing MMS profile.

name

string

Policy name.

nat

string

Enable/disable source NAT.

Choices:

• "disable"
• "enable"

outbound

string

Policy-based IPsec VPN

Choices:

• "disable"
• "enable"

per_ip_shaper

aliases: per-ip-shaper

string

Per-IP traffic shaper.

policyid

integer / required

Policy ID

poolname4

any

(list) IPv4 pool names.

poolname6

any

(list) IPv6 pool names.

profile_group

aliases: profile-group

string

Name of profile group.

profile_protocol_options

aliases: profile-protocol-options

string

Name of an existing Protocol options profile.

profile_type

aliases: profile-type

string

Determine whether the firewall policy allows security profile groups or single profiles only.

Choices:

• "single"
• "group"

schedule

string

Schedule name.

service

any

(list) Service and service group names.

service_negate

aliases: service-negate

string

When enabled service specifies what the service must NOT be.

Choices:

• "disable"
• "enable"

session_ttl

aliases: session-ttl

integer

TTL in seconds for sessions accepted by this policy

srcaddr4

any

(list) Source IPv4 address name and address group names.

srcaddr6

any

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

srcaddr_negate

aliases: srcaddr-negate

string

When enabled srcaddr specifies what the source address must NOT be.

Choices:

• "disable"
• "enable"

srcintf

any

(list) Incoming

ssh_filter_profile

aliases: ssh-filter-profile

string

Name of an existing SSH filter profile.

ssh_policy_redirect

aliases: ssh-policy-redirect

string

Redirect SSH traffic to matching transparent proxy policy.

Choices:

• "disable"
• "enable"

ssl_ssh_profile

aliases: ssl-ssh-profile

string

Name of an existing SSL SSH profile.

status

string

Enable or disable this policy.

Choices:

• "disable"
• "enable"

tcp_mss_receiver

aliases: tcp-mss-receiver

integer

Receiver TCP maximum segment size

tcp_mss_sender

aliases: tcp-mss-sender

integer

Sender TCP maximum segment size

traffic_shaper

aliases: traffic-shaper

string

Traffic shaper.

traffic_shaper_reverse

aliases: traffic-shaper-reverse

string

Reverse traffic shaper.

url_category

aliases: url-category

any

(list) Url category.

users

any

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

utm_status

aliases: utm-status

string

Enable to add one or more security profiles

Choices:

• "disable"
• "enable"

uuid

string

Universally Unique Identifier

voip_profile

aliases: voip-profile

string

Name of an existing VoIP profile.

vpntunnel

string

Policy-based IPsec VPN

waf_profile

aliases: waf-profile

string

Name of an existing Web application firewall profile.

wanopt

string

Enable/disable WAN optimization.

Choices:

• "disable"
• "enable"

wanopt_detection

aliases: wanopt-detection

string

WAN optimization auto-detection mode.

Choices:

• "active"
• "passive"
• "off"

wanopt_passive_opt

aliases: wanopt-passive-opt

string

WAN optimization passive mode options.

Choices:

• "default"
• "transparent"
• "non-transparent"

wanopt_peer

aliases: wanopt-peer

string

WAN optimization peer.

wanopt_profile

aliases: wanopt-profile

string

WAN optimization profile.

webcache

string

Enable/disable web cache.

Choices:

• "disable"
• "enable"

webcache_https

aliases: webcache-https

string

Enable/disable web cache for HTTPS.

Choices:

• "disable"
• "enable"

webfilter_profile

aliases: webfilter-profile

string

Name of an existing Web filter profile.

webproxy_forward_server

aliases: webproxy-forward-server

string

Webproxy forward server name.

webproxy_profile

aliases: webproxy-profile

string

Webproxy profile name.

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

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