access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

• false ← (default)
• true

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

• "present"
• "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

• "present"
• "absent"

vdom

string

Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Default: "root"

ztna_web_portal

dictionary

Configure ztna web-portal.

auth_portal

string

Enable/disable authentication portal.

Choices:

• "disable"
• "enable"

auth_rule

string

Authentication Rule. Source authentication.rule.name.

auth_virtual_host

string

Virtual host for authentication portal. Source firewall.access-proxy-virtual-host.name.

clipboard

string

Enable to support RDP/VPC clipboard functionality.

Choices:

• "enable"
• "disable"

cookie_age

integer

Time in minutes that client web browsers should keep a cookie. Default is 60 minutes. 0 = no time limit.

customize_forticlient_download_url

string

Enable support of customized download URL for FortiClient.

Choices:

• "enable"
• "disable"

decrypted_traffic_mirror

string

Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name.

default_window_height

integer

Screen height (range from 0 - 65535).

default_window_width

integer

Screen width (range from 0 - 65535).

display_bookmark

string

Enable to display the web portal bookmark widget.

Choices:

• "enable"
• "disable"

display_history

string

Enable to display the web portal user login history widget.

Choices:

• "enable"
• "disable"

display_status

string

Enable to display the web portal status widget.

Choices:

• "enable"
• "disable"

focus_bookmark

string

Enable to prioritize the placement of the bookmark section over the quick-connection section in the ztna web-portal.

Choices:

• "enable"
• "disable"

forticlient_download

string

Enable/disable download option for FortiClient.

Choices:

• "enable"
• "disable"

forticlient_download_method

string

FortiClient download method.

Choices:

• "direct"
• "ssl-vpn"

heading

string

Web portal heading message.

host

string

Virtual or real host name. Source firewall.access-proxy-virtual-host.name.

log_blocked_traffic

string

Enable/disable logging of blocked traffic.

Choices:

• "disable"
• "enable"

macos_forticlient_download_url

string

Download URL for Mac FortiClient.

name

string / required

ZTNA proxy name.

policy_auth_sso

string

Enable policy sso authentication.

Choices:

• "enable"
• "disable"

theme

string

Web portal color scheme.

Choices:

• "jade"
• "neutrino"
• "mariner"
• "graphite"
• "melongene"
• "jet-stream"
• "security-fabric"
• "dark-matter"
• "onyx"
• "eclipse"

vip

string

Virtual IP name. Source firewall.vip.name.

vip6

string

Virtual IPv6 name. Source firewall.vip6.name.

windows_forticlient_download_url

string

Download URL for Windows FortiClient.

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"