access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

• false ← (default)
• true

extension_controller_extender_profile

dictionary

FortiExtender extender profile configuration.

allowaccess

list / elements=string

Control management access to the managed extender. Separate entries with a space.

Choices:

• "ping"
• "telnet"
• "http"
• "https"
• "ssh"
• "snmp"

bandwidth_limit

integer

FortiExtender LAN extension bandwidth limit (Mbps).

cellular

dictionary

FortiExtender cellular configuration.

controller_report

dictionary

FortiExtender controller report configuration.

interval

integer

Controller report interval.

signal_threshold

integer

Controller report signal threshold.

status

string

FortiExtender controller report status.

Choices:

• "disable"
• "enable"

dataplan

list / elements=dictionary

Dataplan names.

name

string / required

Dataplan name. Source extension-controller.dataplan.name.

modem1

dictionary

Configuration options for modem 1.

auto_switch

dictionary

FortiExtender auto switch configuration.

dataplan

string

Automatically switch based on data usage.

Choices:

• "disable"
• "enable"

disconnect

string

Auto switch by disconnect.

Choices:

• "disable"
• "enable"

disconnect_period

integer

Automatically switch based on disconnect period.

disconnect_threshold

integer

Automatically switch based on disconnect threshold.

signal

string

Automatically switch based on signal strength.

Choices:

• "disable"
• "enable"

switch_back

list / elements=string

Auto switch with switch back multi-options.

Choices:

• "time"
• "timer"

switch_back_time

string

Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM).

switch_back_timer

integer

Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec).

default_sim

string

Default SIM selection.

Choices:

• "sim1"
• "sim2"
• "carrier"
• "cost"

gps

string

FortiExtender GPS enable/disable.

Choices:

• "disable"
• "enable"

multiple_PDN

string

Multiple-PDN enable/disable.

Choices:

• "disable"
• "enable"

pdn1_dataplan

string

PDN1-dataplan. Source extension-controller.dataplan.name.

pdn2_dataplan

string

PDN2-dataplan. Source extension-controller.dataplan.name.

pdn3_dataplan

string

PDN3-dataplan. Source extension-controller.dataplan.name.

pdn4_dataplan

string

PDN4-dataplan. Source extension-controller.dataplan.name.

preferred_carrier

string

Preferred carrier.

redundant_intf

string

Redundant interface.

redundant_mode

string

FortiExtender mode.

Choices:

• "disable"
• "enable"

sim1_pin

string

SIM

Choices:

• "disable"
• "enable"

sim1_pin_code

string

SIM

sim2_pin

string

SIM

Choices:

• "disable"
• "enable"

sim2_pin_code

string

SIM

modem2

dictionary

Configuration options for modem 2.

auto_switch

dictionary

FortiExtender auto switch configuration.

dataplan

string

Automatically switch based on data usage.

Choices:

• "disable"
• "enable"

disconnect

string

Auto switch by disconnect.

Choices:

• "disable"
• "enable"

disconnect_period

integer

Automatically switch based on disconnect period.

disconnect_threshold

integer

Automatically switch based on disconnect threshold.

signal

string

Automatically switch based on signal strength.

Choices:

• "disable"
• "enable"

switch_back

list / elements=string

Auto switch with switch back multi-options.

Choices:

• "time"
• "timer"

switch_back_time

string

Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM).

switch_back_timer

integer

Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec).

default_sim

string

Default SIM selection.

Choices:

• "sim1"
• "sim2"
• "carrier"
• "cost"

gps

string

FortiExtender GPS enable/disable.

Choices:

• "disable"
• "enable"

multiple_PDN

string

Multiple-PDN enable/disable.

Choices:

• "disable"
• "enable"

pdn1_dataplan

string

PDN1-dataplan. Source extension-controller.dataplan.name.

pdn2_dataplan

string

PDN2-dataplan. Source extension-controller.dataplan.name.

pdn3_dataplan

string

PDN3-dataplan. Source extension-controller.dataplan.name.

pdn4_dataplan

string

PDN4-dataplan. Source extension-controller.dataplan.name.

preferred_carrier

string

Preferred carrier.

redundant_intf

string

Redundant interface.

redundant_mode

string

FortiExtender mode.

Choices:

• "disable"
• "enable"

sim1_pin

string

SIM

Choices:

• "disable"
• "enable"

sim1_pin_code

string

SIM

sim2_pin

string

SIM

Choices:

• "disable"
• "enable"

sim2_pin_code

string

SIM

sms_notification

dictionary

FortiExtender cellular SMS notification configuration.

alert

dictionary

SMS alert list.

data_exhausted

string

Display string when data exhausted.

fgt_backup_mode_switch

string

Display string when FortiGate backup mode switched.

low_signal_strength

string

Display string when signal strength is low.

mode_switch

string

Display string when mode is switched.

os_image_fallback

string

Display string when falling back to a previous OS image.

session_disconnect

string

Display string when session disconnected.

system_reboot

string

Display string when system rebooted.

receiver

list / elements=dictionary

SMS notification receiver list.

alert

list / elements=string

Alert multi-options.

Choices:

• "system-reboot"
• "data-exhausted"
• "session-disconnect"
• "low-signal-strength"
• "mode-switch"
• "os-image-fallback"
• "fgt-backup-mode-switch"

name

string / required

FortiExtender SMS notification receiver name.

phone_number

string

Receiver phone number. Format: [+][country code][area code][local phone number]. For example, +16501234567.

status

string

SMS notification receiver status.

Choices:

• "disable"
• "enable"

status

string

FortiExtender SMS notification status.

Choices:

• "disable"
• "enable"

enforce_bandwidth

string

Enable/disable enforcement of bandwidth on LAN extension interface.

Choices:

• "enable"
• "disable"

extension

string

Extension option.

Choices:

• "wan-extension"
• "lan-extension"

id

integer

ID.

lan_extension

dictionary

FortiExtender LAN extension configuration.

backhaul

list / elements=dictionary

LAN extension backhaul tunnel configuration.

name

string / required

FortiExtender LAN extension backhaul name.

port

string

FortiExtender uplink port.

Choices:

• "wan"
• "lte1"
• "lte2"
• "port1"
• "port2"
• "port3"
• "port4"
• "port5"
• "sfp"

role

string

FortiExtender uplink port.

Choices:

• "primary"
• "secondary"

weight

integer

WRR weight parameter.

backhaul_interface

string

IPsec phase1 interface. Source system.interface.name.

backhaul_ip

string

IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device.

downlinks

list / elements=dictionary

Config FortiExtender downlink interface for LAN extension.

name

string / required

FortiExtender LAN extension downlink config entry name.

port

string

FortiExtender LAN extension downlink port.

Choices:

• "port1"
• "port2"
• "port3"
• "port4"
• "port5"
• "lan1"
• "lan2"

pvid

integer

FortiExtender LAN extension downlink PVID.

type

string

FortiExtender LAN extension downlink type [port/vap].

Choices:

• "port"
• "vap"

vap

string

FortiExtender LAN extension downlink vap. Source extension-controller.extender-vap.name.

ipsec_tunnel

string

IPsec tunnel name.

link_loadbalance

string

LAN extension link load balance strategy.

Choices:

• "activebackup"
• "loadbalance"

traffic_split_services

list / elements=dictionary

Config FortiExtender traffic split interface for LAN extension.

address

string

Address selection. Source firewall.address.name.

name

string / required

FortiExtender LAN extension tunnel split entry name.

service

string

Service selection. Source firewall.service.custom.name.

vsdb

string

Select vsdb [enable/disable].

Choices:

• "disable"
• "enable"

login_password

string

Set the managed extender”s administrator password.

login_password_change

string

Change or reset the administrator password of a managed extender (yes, default, or no).

Choices:

• "yes"
• "default"
• "no"

model

string

Model.

Choices:

• "FX201E"
• "FX211E"
• "FX200F"
• "FXA11F"
• "FXE11F"
• "FXA21F"
• "FXE21F"
• "FXA22F"
• "FXE22F"
• "FX212F"
• "FX311F"
• "FX312F"
• "FX511F"
• "FXR51G"
• "FXN51G"
• "FXW51G"
• "FVG21F"
• "FVA21F"
• "FVG22F"
• "FVA22F"
• "FX04DA"
• "FG"
• "BS10FW"
• "BS20GW"
• "BS20GN"
• "FVG51G"

name

string / required

FortiExtender profile name.

wifi

dictionary

FortiExtender Wi-Fi configuration.

country

string

Country in which this FEX will operate .

Choices:

• "--"
• "AF"
• "AL"
• "DZ"
• "AS"
• "AO"
• "AR"
• "AM"
• "AU"
• "AT"
• "AZ"
• "BS"
• "BH"
• "BD"
• "BB"
• "BY"
• "BE"
• "BZ"
• "BJ"
• "BM"
• "BT"
• "BO"
• "BA"
• "BW"
• "BR"
• "BN"
• "BG"
• "BF"
• "KH"
• "CM"
• "KY"
• "CF"
• "TD"
• "CL"
• "CN"
• "CX"
• "CO"
• "CG"
• "CD"
• "CR"
• "HR"
• "CY"
• "CZ"
• "DK"
• "DJ"
• "DM"
• "DO"
• "EC"
• "EG"
• "SV"
• "ET"
• "EE"
• "GF"
• "PF"
• "FO"
• "FJ"
• "FI"
• "FR"
• "GA"
• "GE"
• "GM"
• "DE"
• "GH"
• "GI"
• "GR"
• "GL"
• "GD"
• "GP"
• "GU"
• "GT"
• "GY"
• "HT"
• "HN"
• "HK"
• "HU"
• "IS"
• "IN"
• "ID"
• "IQ"
• "IE"
• "IM"
• "IL"
• "IT"
• "CI"
• "JM"
• "JO"
• "KZ"
• "KE"
• "KR"
• "KW"
• "LA"
• "LV"
• "LB"
• "LS"
• "LR"
• "LY"
• "LI"
• "LT"
• "LU"
• "MO"
• "MK"
• "MG"
• "MW"
• "MY"
• "MV"
• "ML"
• "MT"
• "MH"
• "MQ"
• "MR"
• "MU"
• "YT"
• "MX"
• "FM"
• "MD"
• "MC"
• "MN"
• "MA"
• "MZ"
• "MM"
• "NA"
• "NP"
• "NL"
• "AN"
• "AW"
• "NZ"
• "NI"
• "NE"
• "NG"
• "NO"
• "MP"
• "OM"
• "PK"
• "PW"
• "PA"
• "PG"
• "PY"
• "PE"
• "PH"
• "PL"
• "PT"
• "PR"
• "QA"
• "RE"
• "RO"
• "RU"
• "RW"
• "BL"
• "KN"
• "LC"
• "MF"
• "PM"
• "VC"
• "SA"
• "SN"
• "RS"
• "ME"
• "SL"
• "SG"
• "SK"
• "SI"
• "SO"
• "ZA"
• "ES"
• "LK"
• "SR"
• "SZ"
• "SE"
• "CH"
• "TW"
• "TZ"
• "TH"
• "TG"
• "TT"
• "TN"
• "TR"
• "TM"
• "AE"
• "TC"
• "UG"
• "UA"
• "GB"
• "US"
• "PS"
• "UY"
• "UZ"
• "VU"
• "VE"
• "VN"
• "VI"
• "WF"
• "YE"
• "ZM"
• "ZW"
• "JP"
• "CA"

radio_1

dictionary

Radio-1 config for Wi-Fi 2.4GHz

band

string

Wi-Fi band selection 2.4GHz / 5GHz.

Choices:

• "2.4GHz"

bandwidth

string

Wi-Fi channel bandwidth.

Choices:

• "auto"
• "20MHz"
• "40MHz"
• "80MHz"

beacon_interval

integer

Wi-Fi beacon interval in miliseconds (100 - 3500).

bss_color

integer

Wi-Fi 802.11AX BSS color value (0 - 63, 0 = disable).

bss_color_mode

string

Wi-Fi 802.11AX BSS color mode.

Choices:

• "auto"
• "static"

channel

list / elements=string

Wi-Fi channels.

Choices:

• "CH1"
• "CH2"
• "CH3"
• "CH4"
• "CH5"
• "CH6"
• "CH7"
• "CH8"
• "CH9"
• "CH10"
• "CH11"

extension_channel

string

Wi-Fi extension channel.

Choices:

• "auto"
• "higher"
• "lower"

guard_interval

string

Wi-Fi guard interval.

Choices:

• "auto"
• "400ns"
• "800ns"

lan_ext_vap

string

Wi-Fi LAN-Extention VAP. Select only one VAP. Source extension-controller.extender-vap.name.

local_vaps

list / elements=dictionary

Wi-Fi local VAP. Select up to three VAPs.

name

string / required

Wi-Fi local VAP name. Source extension-controller.extender-vap.name.

max_clients

integer

Maximum number of Wi-Fi radio clients (0 - 512, 0 = unlimited).

mode

string

Wi-Fi radio mode AP(LAN mode) / Client(WAN mode).

Choices:

• "AP"
• "Client"

operating_standard

string

Wi-Fi operating standard.

Choices:

• "auto"
• "11A-N-AC-AX"
• "11A-N-AC"
• "11A-N"
• "11A"
• "11N-AC-AX"
• "11AC-AX"
• "11AC"
• "11N-AC"
• "11B-G-N-AX"
• "11B-G-N"
• "11B-G"
• "11B"
• "11G-N-AX"
• "11N-AX"
• "11AX"
• "11G-N"
• "11N"
• "11G"

power_level

integer

Wi-Fi power level in percent (0 - 100, 0 = auto).

set_80211d

string

Enable/disable Wi-Fi 802.11d.

Choices:

• "disable"
• "enable"

status

string

Enable/disable Wi-Fi radio.

Choices:

• "disable"
• "enable"

radio_2

dictionary

Radio-2 config for Wi-Fi 5GHz

band

string

Wi-Fi band selection 2.4GHz / 5GHz.

Choices:

• "5GHz"

bandwidth

string

Wi-Fi channel bandwidth.

Choices:

• "auto"
• "20MHz"
• "40MHz"
• "80MHz"

beacon_interval

integer

Wi-Fi beacon interval in miliseconds (100 - 3500).

bss_color

integer

Wi-Fi 802.11AX BSS color value (0 - 63, 0 = disable).

bss_color_mode

string

Wi-Fi 802.11AX BSS color mode.

Choices:

• "auto"
• "static"

channel

list / elements=string

Wi-Fi channels.

Choices:

• "CH36"
• "CH40"
• "CH44"
• "CH48"
• "CH52"
• "CH56"
• "CH60"
• "CH64"
• "CH100"
• "CH104"
• "CH108"
• "CH112"
• "CH116"
• "CH120"
• "CH124"
• "CH128"
• "CH132"
• "CH136"
• "CH140"
• "CH144"
• "CH149"
• "CH153"
• "CH157"
• "CH161"
• "CH165"

extension_channel

string

Wi-Fi extension channel.

Choices:

• "auto"
• "higher"
• "lower"

guard_interval

string

Wi-Fi guard interval.

Choices:

• "auto"
• "400ns"
• "800ns"

lan_ext_vap

string

Wi-Fi LAN-Extention VAP. Select only one VAP. Source extension-controller.extender-vap.name.

local_vaps

list / elements=dictionary

Wi-Fi local VAP. Select up to three VAPs.

name

string / required

Wi-Fi local VAP name. Source extension-controller.extender-vap.name.

max_clients

integer

Maximum number of Wi-Fi radio clients (0 - 512, 0 = unlimited).

mode

string

Wi-Fi radio mode AP(LAN mode) / Client(WAN mode).

Choices:

• "AP"
• "Client"

operating_standard

string

Wi-Fi operating standard.

Choices:

• "auto"
• "11A-N-AC-AX"
• "11A-N-AC"
• "11A-N"
• "11A"
• "11N-AC-AX"
• "11AC-AX"
• "11AC"
• "11N-AC"
• "11B-G-N-AX"
• "11B-G-N"
• "11B-G"
• "11B"
• "11G-N-AX"
• "11N-AX"
• "11AX"
• "11G-N"
• "11N"
• "11G"

power_level

integer

Wi-Fi power level in percent (0 - 100, 0 = auto).

set_80211d

string

Enable/disable Wi-Fi 802.11d.

Choices:

• "disable"
• "enable"

status

string

Enable/disable Wi-Fi radio.

Choices:

• "disable"
• "enable"

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"

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"