fortinet.fortios.fortios_extension_controller_extender_profile module – FortiExtender extender profile configuration in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_extension_controller_extender_profile
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extension_controller feature and extender_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
FortiExtender extender profile configuration. |
|
Control management access to the managed extender. Separate entries with a space. Choices:
|
|
FortiExtender LAN extension bandwidth limit (Mbps). |
|
FortiExtender cellular configuration. |
|
FortiExtender controller report configuration. |
|
Controller report interval. |
|
Controller report signal threshold. |
|
FortiExtender controller report status. Choices:
|
|
Dataplan names. |
|
Dataplan name. Source extension-controller.dataplan.name. |
|
Configuration options for modem 1. |
|
FortiExtender auto switch configuration. |
|
Automatically switch based on data usage. Choices:
|
|
Auto switch by disconnect. Choices:
|
|
Automatically switch based on disconnect period. |
|
Automatically switch based on disconnect threshold. |
|
Automatically switch based on signal strength. Choices:
|
|
Auto switch with switch back multi-options. Choices:
|
|
Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). |
|
Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). |
|
Default SIM selection. Choices:
|
|
FortiExtender GPS enable/disable. Choices:
|
|
Preferred carrier. |
|
Redundant interface. |
|
FortiExtender mode. Choices:
|
|
SIM Choices:
|
|
SIM |
|
SIM Choices:
|
|
SIM |
|
Configuration options for modem 2. |
|
FortiExtender auto switch configuration. |
|
Automatically switch based on data usage. Choices:
|
|
Auto switch by disconnect. Choices:
|
|
Automatically switch based on disconnect period. |
|
Automatically switch based on disconnect threshold. |
|
Automatically switch based on signal strength. Choices:
|
|
Auto switch with switch back multi-options. Choices:
|
|
Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). |
|
Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). |
|
Default SIM selection. Choices:
|
|
FortiExtender GPS enable/disable. Choices:
|
|
Preferred carrier. |
|
Redundant interface. |
|
FortiExtender mode. Choices:
|
|
SIM Choices:
|
|
SIM |
|
SIM Choices:
|
|
SIM |
|
FortiExtender cellular SMS notification configuration. |
|
SMS alert list. |
|
Display string when data exhausted. |
|
Display string when FortiGate backup mode switched. |
|
Display string when signal strength is low. |
|
Display string when mode is switched. |
|
Display string when falling back to a previous OS image. |
|
Display string when session disconnected. |
|
Display string when system rebooted. |
|
SMS notification receiver list. |
|
Alert multi-options. Choices:
|
|
FortiExtender SMS notification receiver name. |
|
Receiver phone number. Format: [+][country code][area code][local phone number]. For example, +16501234567. |
|
SMS notification receiver status. Choices:
|
|
FortiExtender SMS notification status. Choices:
|
|
Enable/disable enforcement of bandwidth on LAN extension interface. Choices:
|
|
Extension option. Choices:
|
|
ID. |
|
FortiExtender LAN extension configuration. |
|
LAN extension backhaul tunnel configuration. |
|
FortiExtender LAN extension backhaul name. |
|
FortiExtender uplink port. Choices:
|
|
FortiExtender uplink port. Choices:
|
|
WRR weight parameter. |
|
IPsec phase1 interface. Source system.interface.name. |
|
IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device. |
|
Config FortiExtender downlink interface for LAN extension. |
|
FortiExtender LAN extension downlink config entry name. |
|
FortiExtender LAN extension downlink port. Choices:
|
|
FortiExtender LAN extension downlink PVID. |
|
FortiExtender LAN extension downlink type [port/vap]. Choices:
|
|
FortiExtender LAN extension downlink vap. Source extension-controller.extender-vap.name. |
|
IPsec tunnel name. |
|
LAN extension link load balance strategy. Choices:
|
|
Set the managed extender”s administrator password. |
|
Change or reset the administrator password of a managed extender (yes, default, or no). Choices:
|
|
Model. Choices:
|
|
FortiExtender profile name. |
|
FortiExtender Wi-Fi configuration. |
|
Country in which this FEX will operate . Choices:
|
|
Radio-1 config for Wi-Fi 2.4GHz |
|
Wi-Fi band selection 2.4GHz / 5GHz. Choices:
|
|
Wi-Fi channel bandwidth. Choices:
|
|
Wi-Fi beacon interval in miliseconds (100 - 3500). |
|
Wi-Fi 802.11AX BSS color value (0 - 63, 0 = disable). |
|
Wi-Fi 802.11AX BSS color mode. Choices:
|
|
Wi-Fi channels. Choices:
|
|
Wi-Fi extension channel. Choices:
|
|
Wi-Fi guard interval. Choices:
|
|
Wi-Fi LAN-Extention VAP. Select only one VAP. Source extension-controller.extender-vap.name. |
|
Wi-Fi local VAP. Select up to three VAPs. |
|
Wi-Fi local VAP name. Source extension-controller.extender-vap.name. |
|
Maximum number of Wi-Fi radio clients (0 - 512, 0 = unlimited). |
|
Wi-Fi radio mode AP(LAN mode) / Client(WAN mode). Choices:
|
|
Wi-Fi operating standard. Choices:
|
|
Wi-Fi power level in percent (0 - 100, 0 = auto). |
|
Enable/disable Wi-Fi 802.11d. Choices:
|
|
Enable/disable Wi-Fi radio. Choices:
|
|
Radio-2 config for Wi-Fi 5GHz |
|
Wi-Fi band selection 2.4GHz / 5GHz. Choices:
|
|
Wi-Fi channel bandwidth. Choices:
|
|
Wi-Fi beacon interval in miliseconds (100 - 3500). |
|
Wi-Fi 802.11AX BSS color value (0 - 63, 0 = disable). |
|
Wi-Fi 802.11AX BSS color mode. Choices:
|
|
Wi-Fi channels. Choices:
|
|
Wi-Fi extension channel. Choices:
|
|
Wi-Fi guard interval. Choices:
|
|
Wi-Fi LAN-Extention VAP. Select only one VAP. Source extension-controller.extender-vap.name. |
|
Wi-Fi local VAP. Select up to three VAPs. |
|
Wi-Fi local VAP name. Source extension-controller.extender-vap.name. |
|
Maximum number of Wi-Fi radio clients (0 - 512, 0 = unlimited). |
|
Wi-Fi radio mode AP(LAN mode) / Client(WAN mode). Choices:
|
|
Wi-Fi operating standard. Choices:
|
|
Wi-Fi power level in percent (0 - 100, 0 = auto). |
|
Enable/disable Wi-Fi 802.11d. Choices:
|
|
Enable/disable Wi-Fi radio. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: FortiExtender extender profile configuration.
fortinet.fortios.fortios_extension_controller_extender_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extension_controller_extender_profile:
allowaccess: "ping"
bandwidth_limit: "1024"
cellular:
controller_report:
interval: "300"
signal_threshold: "10"
status: "disable"
dataplan:
-
name: "default_name_11 (source extension-controller.dataplan.name)"
modem1:
auto_switch:
dataplan: "disable"
disconnect: "disable"
disconnect_period: "600"
disconnect_threshold: "3"
signal: "disable"
switch_back: "time"
switch_back_time: "<your_own_value>"
switch_back_timer: "86400"
default_sim: "sim1"
gps: "disable"
preferred_carrier: "<your_own_value>"
redundant_intf: "<your_own_value>"
redundant_mode: "disable"
sim1_pin: "disable"
sim1_pin_code: "<your_own_value>"
sim2_pin: "disable"
sim2_pin_code: "<your_own_value>"
modem2:
auto_switch:
dataplan: "disable"
disconnect: "disable"
disconnect_period: "600"
disconnect_threshold: "3"
signal: "disable"
switch_back: "time"
switch_back_time: "<your_own_value>"
switch_back_timer: "86400"
default_sim: "sim1"
gps: "disable"
preferred_carrier: "<your_own_value>"
redundant_intf: "<your_own_value>"
redundant_mode: "disable"
sim1_pin: "disable"
sim1_pin_code: "<your_own_value>"
sim2_pin: "disable"
sim2_pin_code: "<your_own_value>"
sms_notification:
alert:
data_exhausted: "<your_own_value>"
fgt_backup_mode_switch: "<your_own_value>"
low_signal_strength: "<your_own_value>"
mode_switch: "<your_own_value>"
os_image_fallback: "<your_own_value>"
session_disconnect: "<your_own_value>"
system_reboot: "<your_own_value>"
receiver:
-
alert: "system-reboot"
name: "default_name_61"
phone_number: "<your_own_value>"
status: "disable"
status: "disable"
enforce_bandwidth: "enable"
extension: "wan-extension"
id: "67"
lan_extension:
backhaul:
-
name: "default_name_70"
port: "wan"
role: "primary"
weight: "1"
backhaul_interface: "<your_own_value> (source system.interface.name)"
backhaul_ip: "<your_own_value>"
downlinks:
-
name: "default_name_77"
port: "port1"
pvid: "0"
type: "port"
vap: "<your_own_value> (source extension-controller.extender-vap.name)"
ipsec_tunnel: "<your_own_value>"
link_loadbalance: "activebackup"
login_password: "<your_own_value>"
login_password_change: "yes"
model: "FX201E"
name: "default_name_87"
wifi:
country: "--"
radio_1:
band: "2.4GHz"
bandwidth: "auto"
beacon_interval: "100"
bss_color: "0"
bss_color_mode: "auto"
channel: "CH1"
extension_channel: "auto"
guard_interval: "auto"
lan_ext_vap: "<your_own_value> (source extension-controller.extender-vap.name)"
local_vaps:
-
name: "default_name_101 (source extension-controller.extender-vap.name)"
max_clients: "0"
mode: "AP"
operating_standard: "auto"
power_level: "100"
set_80211d: "disable"
status: "disable"
radio_2:
band: "5GHz"
bandwidth: "auto"
beacon_interval: "100"
bss_color: "0"
bss_color_mode: "auto"
channel: "CH36"
extension_channel: "auto"
guard_interval: "auto"
lan_ext_vap: "<your_own_value> (source extension-controller.extender-vap.name)"
local_vaps:
-
name: "default_name_119 (source extension-controller.extender-vap.name)"
max_clients: "0"
mode: "AP"
operating_standard: "auto"
power_level: "100"
set_80211d: "disable"
status: "disable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |