fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile module – FortiExtender extender profile configuration.

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_extensioncontroller_extenderprofile.

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

extensioncontroller_extenderprofile

dictionary

The top level parameters set.

_is_factory_setting

string

Is factory setting.

Choices:

  • "disable"

  • "enable"

  • "ext"

allowaccess

list / elements=string

Control management access to the managed extender.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

bandwidth-limit

integer

Deprecated, please rename it to bandwidth_limit. FortiExtender LAN extension bandwidth limit

cellular

dictionary

Cellular.

controller-report

dictionary

Deprecated, please rename it to controller_report. Controller report.

interval

integer

Controller report interval.

signal-threshold

integer

Deprecated, please rename it to signal_threshold. Controller report signal threshold.

status

string

FortiExtender controller report status.

Choices:

  • "disable"

  • "enable"

dataplan

any

(list) Dataplan names.

modem1

dictionary

Modem1.

auto-switch

dictionary

Deprecated, please rename it to auto_switch. Auto switch.

dataplan

string

Automatically switch based on data usage.

Choices:

  • "disable"

  • "enable"

disconnect

string

Auto switch by disconnect.

Choices:

  • "disable"

  • "enable"

disconnect-period

integer

Deprecated, please rename it to disconnect_period. Automatically switch based on disconnect period.

disconnect-threshold

integer

Deprecated, please rename it to disconnect_threshold. Automatically switch based on disconnect thr…

signal

string

Automatically switch based on signal strength.

Choices:

  • "disable"

  • "enable"

switch-back

list / elements=string

Deprecated, please rename it to switch_back. Auto switch with switch back multi-options.

Choices:

  • "time"

  • "timer"

switch-back-time

string

Deprecated, please rename it to switch_back_time. Automatically switch over to preferred SIM/carri…

switch-back-timer

integer

Deprecated, please rename it to switch_back_timer. Automatically switch over to preferred SIM/carr…

conn-status

integer

Deprecated, please rename it to conn_status. Conn status.

default-sim

string

Deprecated, please rename it to default_sim. Default SIM selection.

Choices:

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

string

FortiExtender GPS enable/disable.

Choices:

  • "disable"

  • "enable"

modem-id

integer

Deprecated, please rename it to modem_id. Modem ID.

preferred-carrier

string

Deprecated, please rename it to preferred_carrier. Preferred carrier.

redundant-intf

string

Deprecated, please rename it to redundant_intf. Redundant interface.

redundant-mode

string

Deprecated, please rename it to redundant_mode. FortiExtender mode.

Choices:

  • "disable"

  • "enable"

sim1-pin

string

Deprecated, please rename it to sim1_pin. SIM

Choices:

  • "disable"

  • "enable"

sim1-pin-code

any

(list) Deprecated, please rename it to sim1_pin_code. SIM

sim2-pin

string

Deprecated, please rename it to sim2_pin. SIM

Choices:

  • "disable"

  • "enable"

sim2-pin-code

any

(list) Deprecated, please rename it to sim2_pin_code. SIM

modem2

dictionary

Modem2.

auto-switch

dictionary

Deprecated, please rename it to auto_switch. Auto switch.

dataplan

string

Automatically switch based on data usage.

Choices:

  • "disable"

  • "enable"

disconnect

string

Auto switch by disconnect.

Choices:

  • "disable"

  • "enable"

disconnect-period

integer

Deprecated, please rename it to disconnect_period. Automatically switch based on disconnect period.

disconnect-threshold

integer

Deprecated, please rename it to disconnect_threshold. Automatically switch based on disconnect thr…

signal

string

Automatically switch based on signal strength.

Choices:

  • "disable"

  • "enable"

switch-back

list / elements=string

Deprecated, please rename it to switch_back. Auto switch with switch back multi-options.

Choices:

  • "time"

  • "timer"

switch-back-time

string

Deprecated, please rename it to switch_back_time. Automatically switch over to preferred SIM/carri…

switch-back-timer

integer

Deprecated, please rename it to switch_back_timer. Automatically switch over to preferred SIM/carr…

conn-status

integer

Deprecated, please rename it to conn_status. Conn status.

default-sim

string

Deprecated, please rename it to default_sim. Default SIM selection.

Choices:

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

string

FortiExtender GPS enable/disable.

Choices:

  • "disable"

  • "enable"

modem-id

integer

Deprecated, please rename it to modem_id. Modem ID.

preferred-carrier

string

Deprecated, please rename it to preferred_carrier. Preferred carrier.

redundant-intf

string

Deprecated, please rename it to redundant_intf. Redundant interface.

redundant-mode

string

Deprecated, please rename it to redundant_mode. FortiExtender mode.

Choices:

  • "disable"

  • "enable"

sim1-pin

string

Deprecated, please rename it to sim1_pin. SIM

Choices:

  • "disable"

  • "enable"

sim1-pin-code

any

(list) Deprecated, please rename it to sim1_pin_code. SIM

sim2-pin

string

Deprecated, please rename it to sim2_pin. SIM

Choices:

  • "disable"

  • "enable"

sim2-pin-code

any

(list) Deprecated, please rename it to sim2_pin_code. SIM

sms-notification

dictionary

Deprecated, please rename it to sms_notification. Sms notification.

alert

dictionary

Alert.

data-exhausted

string

Deprecated, please rename it to data_exhausted. Display string when data exhausted.

fgt-backup-mode-switch

string

Deprecated, please rename it to fgt_backup_mode_switch. Display string when FortiGate backup mode …

low-signal-strength

string

Deprecated, please rename it to low_signal_strength. Display string when signal strength is low.

mode-switch

string

Deprecated, please rename it to mode_switch. Display string when mode is switched.

os-image-fallback

string

Deprecated, please rename it to os_image_fallback. Display string when falling back to a previous …

session-disconnect

string

Deprecated, please rename it to session_disconnect. Display string when session disconnected.

system-reboot

string

Deprecated, please rename it to system_reboot. Display string when system rebooted.

receiver

list / elements=dictionary

Receiver.

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

FortiExtender SMS notification receiver name.

phone-number

string

Deprecated, please rename it to phone_number. Receiver phone number.

status

string

SMS notification receiver status.

Choices:

  • "disable"

  • "enable"

status

string

FortiExtender SMS notification status.

Choices:

  • "disable"

  • "enable"

enforce-bandwidth

string

Deprecated, please rename it to enforce_bandwidth. Enable/disable enforcement of bandwidth on LAN extension interface.

Choices:

  • "disable"

  • "enable"

extension

string

Extension option.

Choices:

  • "wan-extension"

  • "lan-extension"

id

integer / required

ID.

lan-extension

dictionary

Deprecated, please rename it to lan_extension. Lan extension.

backhaul

list / elements=dictionary

Backhaul.

name

string

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

Deprecated, please rename it to backhaul_interface. IPsec phase1 interface.

backhaul-ip

string

Deprecated, please rename it to backhaul_ip. IPsec phase1 IPv4/FQDN.

list / elements=dictionary

Downlinks.

string

FortiExtender LAN extension downlink config entry name.

string

FortiExtender LAN extension downlink port.

Choices:

  • "port1"

  • "port2"

  • "port3"

  • "port4"

  • "port5"

  • "lan1"

  • "lan2"

integer

FortiExtender LAN extension downlink PVID.

string

FortiExtender LAN extension downlink type [port/vap].

Choices:

  • "port"

  • "vap"

any

(list) FortiExtender LAN extension downlink vap.

ipsec-tunnel

string

Deprecated, please rename it to ipsec_tunnel. IPsec tunnel name.

string

Deprecated, please rename it to link_loadbalance. LAN extension link load balance strategy.

Choices:

  • "activebackup"

  • "loadbalance"

login-password

any

(list) Deprecated, please rename it to login_password. Set the managed extenders administrator password.

login-password-change

string

Deprecated, please rename it to login_password_change. Change or reset the administrator password of a managed extender

Choices:

  • "no"

  • "yes"

  • "default"

model

string

Model.

Choices:

  • "FX201E"

  • "FX211E"

  • "FX200F"

  • "FXA11F"

  • "FXE11F"

  • "FXA21F"

  • "FXE21F"

  • "FXA22F"

  • "FXE22F"

  • "FX212F"

  • "FX311F"

  • "FX312F"

  • "FX511F"

  • "FVG21F"

  • "FVA21F"

  • "FVG22F"

  • "FVA22F"

  • "FX04DA"

  • "FX04DN"

  • "FX04DI"

  • "FXR51G"

  • "FG"

  • "BS10FW"

  • "BS20GW"

  • "BS20GN"

  • "FXN51G"

  • "FXW51G"

name

string

FortiExtender profile name.

wifi

dictionary

Wifi.

country

string

Country in which this FEX will operate

Choices:

  • "AL"

  • "DZ"

  • "AR"

  • "AM"

  • "AU"

  • "AT"

  • "AZ"

  • "BH"

  • "BD"

  • "BY"

  • "BE"

  • "BZ"

  • "BO"

  • "BA"

  • "BR"

  • "BN"

  • "BG"

  • "CA"

  • "CL"

  • "CN"

  • "CO"

  • "CR"

  • "HR"

  • "CY"

  • "CZ"

  • "DK"

  • "DO"

  • "EC"

  • "EG"

  • "SV"

  • "EE"

  • "FI"

  • "FR"

  • "GE"

  • "DE"

  • "GR"

  • "GT"

  • "HN"

  • "HK"

  • "HU"

  • "IS"

  • "IN"

  • "ID"

  • "IE"

  • "IL"

  • "IT"

  • "JM"

  • "JP"

  • "JO"

  • "KZ"

  • "KE"

  • "KR"

  • "KW"

  • "LV"

  • "LB"

  • "LI"

  • "LT"

  • "LU"

  • "MO"

  • "MK"

  • "MY"

  • "MT"

  • "MX"

  • "MC"

  • "MA"

  • "NP"

  • "NL"

  • "AN"

  • "NZ"

  • "NO"

  • "OM"

  • "PK"

  • "PA"

  • "PG"

  • "PE"

  • "PH"

  • "PL"

  • "PT"

  • "PR"

  • "QA"

  • "RO"

  • "RU"

  • "SA"

  • "SG"

  • "SK"

  • "SI"

  • "ZA"

  • "ES"

  • "LK"

  • "SE"

  • "CH"

  • "TW"

  • "TH"

  • "TT"

  • "TN"

  • "TR"

  • "AE"

  • "UA"

  • "GB"

  • "US"

  • "PS"

  • "UY"

  • "UZ"

  • "VE"

  • "VN"

  • "YE"

  • "ZW"

  • "NA"

  • "BS"

  • "VC"

  • "KH"

  • "MV"

  • "AF"

  • "NG"

  • "TZ"

  • "ZM"

  • "SN"

  • "CI"

  • "GH"

  • "CM"

  • "MW"

  • "AO"

  • "GA"

  • "ML"

  • "BJ"

  • "MG"

  • "TD"

  • "BW"

  • "LY"

  • "RW"

  • "MZ"

  • "GM"

  • "LS"

  • "MU"

  • "CG"

  • "UG"

  • "BF"

  • "SL"

  • "SO"

  • "CD"

  • "NE"

  • "CF"

  • "SZ"

  • "TG"

  • "LR"

  • "MR"

  • "DJ"

  • "RE"

  • "RS"

  • "ME"

  • "IQ"

  • "MD"

  • "KY"

  • "BB"

  • "BM"

  • "TC"

  • "VI"

  • "PM"

  • "MF"

  • "GD"

  • "IM"

  • "FO"

  • "GI"

  • "GL"

  • "TM"

  • "MN"

  • "VU"

  • "FJ"

  • "LA"

  • "GU"

  • "WF"

  • "MH"

  • "BT"

  • "FM"

  • "PF"

  • "NI"

  • "PY"

  • "HT"

  • "GY"

  • "AW"

  • "KN"

  • "GF"

  • "AS"

  • "MP"

  • "PW"

  • "MM"

  • "LC"

  • "GP"

  • "ET"

  • "SR"

  • "CX"

  • "DM"

  • "MQ"

  • "YT"

  • "BL"

  • "--"

DFS

string

Wi-Fi 5G Radio DFS channel enable/disable.

Choices:

  • "disable"

  • "enable"

radio-1

dictionary

Deprecated, please rename it to radio_1. Radio 1.

80211d

string

Deprecated, please rename it to d80211d. Enable/disable Wi-Fi 802.

Choices:

  • "disable"

  • "enable"

band

string

Wi-Fi band selection 2.

Choices:

  • "2.4GHz"

bandwidth

string

Wi-Fi channel bandwidth.

Choices:

  • "auto"

  • "20MHz"

  • "40MHz"

  • "80MHz"

beacon-interval

integer

Deprecated, please rename it to beacon_interval. Wi-Fi beacon interval in miliseconds

bss-color

integer

Deprecated, please rename it to bss_color. Wi-Fi 802.

bss-color-mode

string

Deprecated, please rename it to bss_color_mode. Wi-Fi 802.

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

Deprecated, please rename it to extension_channel. Wi-Fi extension channel.

Choices:

  • "auto"

  • "higher"

  • "lower"

guard-interval

string

Deprecated, please rename it to guard_interval. Wi-Fi guard interval.

Choices:

  • "auto"

  • "400ns"

  • "800ns"

lan-ext-vap

any

(list) Deprecated, please rename it to lan_ext_vap. Wi-Fi LAN-Extention VAP.

local-vaps

any

(list) Deprecated, please rename it to local_vaps. Wi-Fi local VAP.

max-clients

integer

Deprecated, please rename it to max_clients. Maximum number of Wi-Fi radio clients

mode

string

Wi-Fi radio mode AP

Choices:

  • "AP"

  • "Client"

operating-standard

string

Deprecated, please rename it to operating_standard. 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

Deprecated, please rename it to power_level. Wi-Fi power level in percent

radio-id

integer

Deprecated, please rename it to radio_id. Radio ID.

status

string

Enable/disable Wi-Fi radio.

Choices:

  • "disable"

  • "enable"

radio-2

dictionary

Deprecated, please rename it to radio_2. Radio 2.

80211d

string

Deprecated, please rename it to d80211d. Enable/disable Wi-Fi 802.

Choices:

  • "disable"

  • "enable"

band

string

Wi-Fi band selection 2.

Choices:

  • "5GHz"

bandwidth

string

Wi-Fi channel bandwidth.

Choices:

  • "auto"

  • "20MHz"

  • "40MHz"

  • "80MHz"

beacon-interval

integer

Deprecated, please rename it to beacon_interval. Wi-Fi beacon interval in miliseconds

bss-color

integer

Deprecated, please rename it to bss_color. Wi-Fi 802.

bss-color-mode

string

Deprecated, please rename it to bss_color_mode. Wi-Fi 802.

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

Deprecated, please rename it to extension_channel. Wi-Fi extension channel.

Choices:

  • "auto"

  • "higher"

  • "lower"

guard-interval

string

Deprecated, please rename it to guard_interval. Wi-Fi guard interval.

Choices:

  • "auto"

  • "400ns"

  • "800ns"

lan-ext-vap

any

(list) Deprecated, please rename it to lan_ext_vap. Wi-Fi LAN-Extention VAP.

local-vaps

any

(list) Deprecated, please rename it to local_vaps. Wi-Fi local VAP.

max-clients

integer

Deprecated, please rename it to max_clients. Maximum number of Wi-Fi radio clients

mode

string

Wi-Fi radio mode AP

Choices:

  • "AP"

  • "Client"

operating-standard

string

Deprecated, please rename it to operating_standard. 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

Deprecated, please rename it to power_level. Wi-Fi power level in percent

radio-id

integer

Deprecated, please rename it to radio_id. Radio ID.

status

string

Enable/disable Wi-Fi radio.

Choices:

  • "disable"

  • "enable"

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

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 (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: FortiExtender extender profile configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile:
        # 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>
        state: present # <value in [present, absent]>
        extensioncontroller_extenderprofile:
          allowaccess:
            - https
            - ping
            - ssh
            - snmp
            - http
            - telnet
          bandwidth_limit: <integer>
          cellular:
            controller_report:
              interval: <integer>
              signal_threshold: <integer>
              status: <value in [disable, enable]>
            dataplan: <list or string>
            modem1:
              auto_switch:
                dataplan: <value in [disable, enable]>
                disconnect: <value in [disable, enable]>
                disconnect_period: <integer>
                disconnect_threshold: <integer>
                signal: <value in [disable, enable]>
                switch_back:
                  - time
                  - timer
                switch_back_time: <string>
                switch_back_timer: <integer>
              conn_status: <integer>
              default_sim: <value in [sim1, sim2, carrier, ...]>
              gps: <value in [disable, enable]>
              modem_id: <integer>
              preferred_carrier: <string>
              redundant_intf: <string>
              redundant_mode: <value in [disable, enable]>
              sim1_pin: <value in [disable, enable]>
              sim1_pin_code: <list or string>
              sim2_pin: <value in [disable, enable]>
              sim2_pin_code: <list or string>
            modem2:
              auto_switch:
                dataplan: <value in [disable, enable]>
                disconnect: <value in [disable, enable]>
                disconnect_period: <integer>
                disconnect_threshold: <integer>
                signal: <value in [disable, enable]>
                switch_back:
                  - time
                  - timer
                switch_back_time: <string>
                switch_back_timer: <integer>
              conn_status: <integer>
              default_sim: <value in [sim1, sim2, carrier, ...]>
              gps: <value in [disable, enable]>
              modem_id: <integer>
              preferred_carrier: <string>
              redundant_intf: <string>
              redundant_mode: <value in [disable, enable]>
              sim1_pin: <value in [disable, enable]>
              sim1_pin_code: <list or string>
              sim2_pin: <value in [disable, enable]>
              sim2_pin_code: <list or string>
            sms_notification:
              alert:
                data_exhausted: <string>
                fgt_backup_mode_switch: <string>
                low_signal_strength: <string>
                mode_switch: <string>
                os_image_fallback: <string>
                session_disconnect: <string>
                system_reboot: <string>
              receiver:
                -
                  alert:
                    - system-reboot
                    - data-exhausted
                    - session-disconnect
                    - low-signal-strength
                    - mode-switch
                    - os-image-fallback
                    - fgt-backup-mode-switch
                  name: <string>
                  phone_number: <string>
                  status: <value in [disable, enable]>
              status: <value in [disable, enable]>
          enforce_bandwidth: <value in [disable, enable]>
          extension: <value in [wan-extension, lan-extension]>
          id: <integer>
          lan_extension:
            backhaul:
              -
                name: <string>
                port: <value in [wan, lte1, lte2, ...]>
                role: <value in [primary, secondary]>
                weight: <integer>
            backhaul_interface: <string>
            backhaul_ip: <string>
            ipsec_tunnel: <string>
            link_loadbalance: <value in [activebackup, loadbalance]>
            downlinks:
              -
                name: <string>
                port: <value in [port1, port2, port3, ...]>
                pvid: <integer>
                type: <value in [port, vap]>
                vap: <list or string>
          login_password: <list or string>
          login_password_change: <value in [no, yes, default]>
          model: <value in [FX201E, FX211E, FX200F, ...]>
          name: <string>
          _is_factory_setting: <value in [disable, enable, ext]>
          wifi:
            DFS: <value in [disable, enable]>
            country: <value in [AL, DZ, AR, ...]>
            radio_1:
              d80211d: <value in [disable, enable]>
              band: <value in [2.4GHz]>
              bandwidth: <value in [auto, 20MHz, 40MHz, ...]>
              beacon_interval: <integer>
              bss_color: <integer>
              bss_color_mode: <value in [auto, static]>
              channel:
                - CH1
                - CH2
                - CH3
                - CH4
                - CH5
                - CH6
                - CH7
                - CH8
                - CH9
                - CH10
                - CH11
              extension_channel: <value in [auto, higher, lower]>
              guard_interval: <value in [auto, 400ns, 800ns]>
              lan_ext_vap: <list or string>
              local_vaps: <list or string>
              max_clients: <integer>
              mode: <value in [AP, Client]>
              operating_standard: <value in [auto, 11A-N-AC-AX, 11A-N-AC, ...]>
              power_level: <integer>
              radio_id: <integer>
              status: <value in [disable, enable]>
            radio_2:
              d80211d: <value in [disable, enable]>
              band: <value in [5GHz]>
              bandwidth: <value in [auto, 20MHz, 40MHz, ...]>
              beacon_interval: <integer>
              bss_color: <integer>
              bss_color_mode: <value in [auto, static]>
              channel:
                - 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: <value in [auto, higher, lower]>
              guard_interval: <value in [auto, 400ns, 800ns]>
              lan_ext_vap: <list or string>
              local_vaps: <list or string>
              max_clients: <integer>
              mode: <value in [AP, Client]>
              operating_standard: <value in [auto, 11A-N-AC-AX, 11A-N-AC, ...]>
              power_level: <integer>
              radio_id: <integer>
              status: <value in [disable, enable]>

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)