:source: fortios_extension_controller_extender_profile.py
:orphan:
.. fortios_extension_controller_extender_profile:
fortios_extension_controller_extender_profile -- FortiExtender extender profile configuration in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
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
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v7.2.1 -> v7.6.6
Parameters
----------
.. raw:: html
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- extension_controller_extender_profile - FortiExtender extender profile configuration. type: dict
more...
| Supported Version Ranges |
| extension_controller_extender_profile |
v7.2.1 -> 7.6.6 |
- allowaccess - Control management access to the managed extender. Separate entries with a space. type: list choices: ping, telnet, http, https, ssh, snmp
more...
|
Supported Version Ranges |
| allowaccess |
v7.2.1 -> 7.6.6 |
| [ping] |
v7.2.1 -> 7.6.6 |
| [telnet] |
v7.2.1 -> 7.6.6 |
| [http] |
v7.2.1 -> 7.6.6 |
| [https] |
v7.2.1 -> 7.6.6 |
| [ssh] |
v7.2.1 -> 7.6.6 |
| [snmp] |
v7.2.1 -> 7.6.6 |
- bandwidth_limit - FortiExtender LAN extension bandwidth limit (Mbps). type: int
more...
|
Supported Version Ranges |
| bandwidth_limit |
v7.2.1 -> 7.6.6 |
- cellular - FortiExtender cellular configuration. type: dict
more...
| Supported Version Ranges |
| cellular |
v7.2.1 -> 7.6.6 |
- controller_report - FortiExtender controller report configuration. type: dict
more...
| Supported Version Ranges |
| controller_report |
v7.2.1 -> 7.6.6 |
- interval - Controller report interval. type: int
more...
|
Supported Version Ranges |
| interval |
v7.2.1 -> 7.6.6 |
- signal_threshold - Controller report signal threshold. type: int
more...
|
Supported Version Ranges |
| signal_threshold |
v7.2.1 -> 7.6.6 |
- status - FortiExtender controller report status. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| status |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- dataplan - Dataplan names. type: list member_path: cellular/dataplan:name
more...
| Supported Version Ranges |
| dataplan |
v7.2.1 -> 7.6.6 |
- name - Dataplan name. Source extension-controller.dataplan.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- modem1 - Configuration options for modem 1. type: dict
more...
| Supported Version Ranges |
| modem1 |
v7.2.1 -> 7.6.6 |
- auto_switch - FortiExtender auto switch configuration. type: dict
more...
| Supported Version Ranges |
| auto_switch |
v7.2.1 -> 7.6.6 |
- dataplan - Automatically switch based on data usage. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| dataplan |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- disconnect - Auto switch by disconnect. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| disconnect |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- disconnect_period - Automatically switch based on disconnect period. type: int
more...
|
Supported Version Ranges |
| disconnect_period |
v7.2.1 -> 7.6.6 |
- disconnect_threshold - Automatically switch based on disconnect threshold. type: int
more...
|
Supported Version Ranges |
| disconnect_threshold |
v7.2.1 -> 7.6.6 |
- signal - Automatically switch based on signal strength. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| signal |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- switch_back - Auto switch with switch back multi-options. type: list choices: time, timer
more...
|
Supported Version Ranges |
| switch_back |
v7.2.1 -> 7.6.6 |
| [time] |
v7.2.1 -> 7.6.6 |
| [timer] |
v7.2.1 -> 7.6.6 |
- switch_back_time - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). type: str
more...
|
Supported Version Ranges |
| switch_back_time |
v7.2.1 -> 7.6.6 |
- switch_back_timer - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). type: int
more...
|
Supported Version Ranges |
| switch_back_timer |
v7.2.1 -> 7.6.6 |
- default_sim - Default SIM selection. type: str choices: sim1, sim2, carrier, cost
more...
|
Supported Version Ranges |
| default_sim |
v7.2.1 -> 7.6.6 |
| [sim1] |
v7.2.1 -> 7.6.6 |
| [sim2] |
v7.2.1 -> 7.6.6 |
| [carrier] |
v7.2.1 -> 7.6.6 |
| [cost] |
v7.2.1 -> 7.6.6 |
- gps - FortiExtender GPS enable/disable. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| gps |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- multiple_PDN - Multiple-PDN enable/disable. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| multiple_PDN |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
- pdn1_dataplan - PDN1-dataplan. Source extension-controller.dataplan.name. type: str
more...
|
Supported Version Ranges |
| pdn1_dataplan |
v7.6.1 -> 7.6.6 |
- pdn2_dataplan - PDN2-dataplan. Source extension-controller.dataplan.name. type: str
more...
|
Supported Version Ranges |
| pdn2_dataplan |
v7.6.1 -> 7.6.6 |
- pdn3_dataplan - PDN3-dataplan. Source extension-controller.dataplan.name. type: str
more...
|
Supported Version Ranges |
| pdn3_dataplan |
v7.6.1 -> 7.6.6 |
- pdn4_dataplan - PDN4-dataplan. Source extension-controller.dataplan.name. type: str
more...
|
Supported Version Ranges |
| pdn4_dataplan |
v7.6.1 -> 7.6.6 |
- preferred_carrier - Preferred carrier. type: str
more...
|
Supported Version Ranges |
| preferred_carrier |
v7.2.1 -> 7.6.6 |
- redundant_intf - Redundant interface. type: str
more...
|
Supported Version Ranges |
| redundant_intf |
v7.2.1 -> 7.6.6 |
- redundant_mode - FortiExtender mode. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| redundant_mode |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- sim1_pin - SIM type: str choices: disable, enable
more...
|
Supported Version Ranges |
| sim1_pin |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- sim1_pin_code - SIM type: str
more...
|
Supported Version Ranges |
| sim1_pin_code |
v7.2.1 -> 7.6.6 |
- sim2_pin - SIM type: str choices: disable, enable
more...
|
Supported Version Ranges |
| sim2_pin |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- sim2_pin_code - SIM type: str
more...
|
Supported Version Ranges |
| sim2_pin_code |
v7.2.1 -> 7.6.6 |
- modem2 - Configuration options for modem 2. type: dict
more...
| Supported Version Ranges |
| modem2 |
v7.2.1 -> 7.6.6 |
- auto_switch - FortiExtender auto switch configuration. type: dict
more...
| Supported Version Ranges |
| auto_switch |
v7.2.1 -> 7.6.6 |
- dataplan - Automatically switch based on data usage. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| dataplan |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- disconnect - Auto switch by disconnect. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| disconnect |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- disconnect_period - Automatically switch based on disconnect period. type: int
more...
|
Supported Version Ranges |
| disconnect_period |
v7.2.1 -> 7.6.6 |
- disconnect_threshold - Automatically switch based on disconnect threshold. type: int
more...
|
Supported Version Ranges |
| disconnect_threshold |
v7.2.1 -> 7.6.6 |
- signal - Automatically switch based on signal strength. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| signal |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- switch_back - Auto switch with switch back multi-options. type: list choices: time, timer
more...
|
Supported Version Ranges |
| switch_back |
v7.2.1 -> 7.6.6 |
| [time] |
v7.2.1 -> 7.6.6 |
| [timer] |
v7.2.1 -> 7.6.6 |
- switch_back_time - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). type: str
more...
|
Supported Version Ranges |
| switch_back_time |
v7.2.1 -> 7.6.6 |
- switch_back_timer - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). type: int
more...
|
Supported Version Ranges |
| switch_back_timer |
v7.2.1 -> 7.6.6 |
- default_sim - Default SIM selection. type: str choices: sim1, sim2, carrier, cost
more...
|
Supported Version Ranges |
| default_sim |
v7.2.1 -> 7.6.6 |
| [sim1] |
v7.2.1 -> 7.6.6 |
| [sim2] |
v7.2.1 -> 7.6.6 |
| [carrier] |
v7.2.1 -> 7.6.6 |
| [cost] |
v7.2.1 -> 7.6.6 |
- gps - FortiExtender GPS enable/disable. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| gps |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- multiple_PDN - Multiple-PDN enable/disable. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| multiple_PDN |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
- pdn1_dataplan - PDN1-dataplan. Source extension-controller.dataplan.name. type: str
more...
|
Supported Version Ranges |
| pdn1_dataplan |
v7.6.1 -> 7.6.6 |
- pdn2_dataplan - PDN2-dataplan. Source extension-controller.dataplan.name. type: str
more...
|
Supported Version Ranges |
| pdn2_dataplan |
v7.6.1 -> 7.6.6 |
- pdn3_dataplan - PDN3-dataplan. Source extension-controller.dataplan.name. type: str
more...
|
Supported Version Ranges |
| pdn3_dataplan |
v7.6.1 -> 7.6.6 |
- pdn4_dataplan - PDN4-dataplan. Source extension-controller.dataplan.name. type: str
more...
|
Supported Version Ranges |
| pdn4_dataplan |
v7.6.1 -> 7.6.6 |
- preferred_carrier - Preferred carrier. type: str
more...
|
Supported Version Ranges |
| preferred_carrier |
v7.2.1 -> 7.6.6 |
- redundant_intf - Redundant interface. type: str
more...
|
Supported Version Ranges |
| redundant_intf |
v7.2.1 -> 7.6.6 |
- redundant_mode - FortiExtender mode. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| redundant_mode |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- sim1_pin - SIM type: str choices: disable, enable
more...
|
Supported Version Ranges |
| sim1_pin |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- sim1_pin_code - SIM type: str
more...
|
Supported Version Ranges |
| sim1_pin_code |
v7.2.1 -> 7.6.6 |
- sim2_pin - SIM type: str choices: disable, enable
more...
|
Supported Version Ranges |
| sim2_pin |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- sim2_pin_code - SIM type: str
more...
|
Supported Version Ranges |
| sim2_pin_code |
v7.2.1 -> 7.6.6 |
- sms_notification - FortiExtender cellular SMS notification configuration. type: dict
more...
| Supported Version Ranges |
| sms_notification |
v7.2.1 -> 7.6.6 |
- alert - SMS alert list. type: dict
more...
| Supported Version Ranges |
| alert |
v7.2.1 -> 7.6.6 |
- data_exhausted - Display string when data exhausted. type: str
more...
|
Supported Version Ranges |
| data_exhausted |
v7.2.1 -> 7.6.6 |
- fgt_backup_mode_switch - Display string when FortiGate backup mode switched. type: str
more...
|
Supported Version Ranges |
| fgt_backup_mode_switch |
v7.2.1 -> 7.6.6 |
- low_signal_strength - Display string when signal strength is low. type: str
more...
|
Supported Version Ranges |
| low_signal_strength |
v7.2.1 -> 7.6.6 |
- mode_switch - Display string when mode is switched. type: str
more...
|
Supported Version Ranges |
| mode_switch |
v7.2.1 -> 7.6.6 |
- os_image_fallback - Display string when falling back to a previous OS image. type: str
more...
|
Supported Version Ranges |
| os_image_fallback |
v7.2.1 -> 7.6.6 |
- session_disconnect - Display string when session disconnected. type: str
more...
|
Supported Version Ranges |
| session_disconnect |
v7.2.1 -> 7.6.6 |
- system_reboot - Display string when system rebooted. type: str
more...
|
Supported Version Ranges |
| system_reboot |
v7.2.1 -> 7.6.6 |
- receiver - SMS notification receiver list. type: list member_path: cellular/sms_notification/receiver:name
more...
| Supported Version Ranges |
| receiver |
v7.2.1 -> 7.6.6 |
- alert - Alert multi-options. type: list choices: system-reboot, data-exhausted, session-disconnect, low-signal-strength, mode-switch, os-image-fallback, fgt-backup-mode-switch
more...
|
Supported Version Ranges |
| alert |
v7.2.1 -> 7.6.6 |
| [system-reboot] |
v7.2.1 -> 7.6.6 |
| [data-exhausted] |
v7.2.1 -> 7.6.6 |
| [session-disconnect] |
v7.2.1 -> 7.6.6 |
| [low-signal-strength] |
v7.2.1 -> 7.6.6 |
| [mode-switch] |
v7.2.1 -> 7.6.6 |
| [os-image-fallback] |
v7.2.1 -> 7.6.6 |
| [fgt-backup-mode-switch] |
v7.2.1 -> 7.6.6 |
- name - FortiExtender SMS notification receiver name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- phone_number - Receiver phone number. Format: [+][country code][area code][local phone number]. For example, +16501234567. type: str
more...
|
Supported Version Ranges |
| phone_number |
v7.2.1 -> 7.6.6 |
- status - SMS notification receiver status. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| status |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- status - FortiExtender SMS notification status. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| status |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- enforce_bandwidth - Enable/disable enforcement of bandwidth on LAN extension interface. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| enforce_bandwidth |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- extension - Extension option. type: str choices: wan-extension, lan-extension
more...
|
Supported Version Ranges |
| extension |
v7.2.1 -> 7.6.6 |
| [wan-extension] |
v7.2.1 -> 7.6.6 |
| [lan-extension] |
v7.2.1 -> 7.6.6 |
- id - ID. type: int
more...
|
Supported Version Ranges |
| id |
v7.2.1 -> 7.6.6 |
- lan_extension - FortiExtender LAN extension configuration. type: dict
more...
| Supported Version Ranges |
| lan_extension |
v7.2.1 -> 7.6.6 |
- backhaul - LAN extension backhaul tunnel configuration. type: list member_path: lan_extension/backhaul:name
more...
| Supported Version Ranges |
| backhaul |
v7.2.1 -> 7.6.6 |
- health_check_fail_cnt - Number of failures before the link is considered dead (1 - 10). type: int
more...
|
Supported Version Ranges |
| health_check_fail_cnt |
v7.6.5 -> 7.6.6 |
- health_check_interval - Health monitoring interval in seconds (1 - 3600). type: int
more...
|
Supported Version Ranges |
| health_check_interval |
v7.6.5 -> 7.6.6 |
- health_check_probe_cnt - Number of health monitoring probes to send within an interval (1 - 10). type: int
more...
|
Supported Version Ranges |
| health_check_probe_cnt |
v7.6.5 -> 7.6.6 |
- health_check_probe_tm - Health monitoring probe timeout in seconds (1 - 10). type: int
more...
|
Supported Version Ranges |
| health_check_probe_tm |
v7.6.5 -> 7.6.6 |
- health_check_recovery_cnt - Number of successful checks before the link is considered alive (1 - 10). type: int
more...
|
Supported Version Ranges |
| health_check_recovery_cnt |
v7.6.5 -> 7.6.6 |
- name - FortiExtender LAN extension backhaul name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- port - FortiExtender uplink port. type: str choices: wan, lte1, lte2, port1, port2, port3, port4, port5, sfp
more...
|
Supported Version Ranges |
| port |
v7.2.1 -> 7.6.6 |
| [wan] |
v7.2.1 -> 7.6.6 |
| [lte1] |
v7.2.1 -> 7.6.6 |
| [lte2] |
v7.2.1 -> 7.6.6 |
| [port1] |
v7.2.1 -> 7.6.6 |
| [port2] |
v7.2.1 -> 7.6.6 |
| [port3] |
v7.2.1 -> 7.6.6 |
| [port4] |
v7.2.1 -> 7.6.6 |
| [port5] |
v7.2.1 -> 7.6.6 |
| [sfp] |
v7.2.1 -> 7.6.6 |
- role - FortiExtender uplink port. type: str choices: primary, secondary
more...
|
Supported Version Ranges |
| role |
v7.2.1 -> 7.6.6 |
| [primary] |
v7.2.1 -> 7.6.6 |
| [secondary] |
v7.2.1 -> 7.6.6 |
- weight - WRR weight parameter. type: int
more...
|
Supported Version Ranges |
| weight |
v7.2.1 -> 7.6.6 |
- backhaul_interface - IPsec phase1 interface. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| backhaul_interface |
v7.2.1 -> 7.6.6 |
- backhaul_ip - IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device. type: str
more...
|
Supported Version Ranges |
| backhaul_ip |
v7.2.1 -> 7.6.6 |
- downlinks - Config FortiExtender downlink interface for LAN extension. type: list member_path: lan_extension/downlinks:name
more...
| Supported Version Ranges |
| downlinks |
v7.6.0 -> 7.6.6 |
- name - FortiExtender LAN extension downlink config entry name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.6.0 -> 7.6.6 |
- port - FortiExtender LAN extension downlink port. type: str choices: port1, port2, port3, port4, port5, lan1, lan2, lan
more...
|
Supported Version Ranges |
| port |
v7.6.0 -> 7.6.6 |
| [port1] |
v7.6.0 -> 7.6.6 |
| [port2] |
v7.6.0 -> 7.6.6 |
| [port3] |
v7.6.0 -> 7.6.6 |
| [port4] |
v7.6.0 -> 7.6.6 |
| [port5] |
v7.6.0 -> 7.6.6 |
| [lan1] |
v7.6.0 -> 7.6.6 |
| [lan2] |
v7.6.0 -> 7.6.6 |
| [lan] |
v7.6.4 -> 7.6.6 |
- pvid - FortiExtender LAN extension downlink PVID (1 - 4089). type: int
more...
|
Supported Version Ranges |
| pvid |
v7.6.0 -> 7.6.6 |
- type - FortiExtender LAN extension downlink type [port/vap]. type: str choices: port, vap
more...
|
Supported Version Ranges |
| type |
v7.6.0 -> 7.6.6 |
| [port] |
v7.6.0 -> 7.6.6 |
| [vap] |
v7.6.0 -> 7.6.6 |
- vap - FortiExtender LAN extension downlink vap. Source extension-controller.extender-vap.name. type: str
more...
|
Supported Version Ranges |
| vap |
v7.6.0 -> 7.6.6 |
- vids - FortiExtender LAN extension downlink VIDs. type: list member_path: lan_extension/downlinks:name/vids:vid
more...
| Supported Version Ranges |
| vids |
v7.6.4 -> 7.6.6 |
- vid - Please enter VID numbers (1 - 4089) with space separated. Up to 50 VIDs are accepted. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| vid |
v7.6.4 -> 7.6.6 |
- ipsec_tunnel - IPsec tunnel name. type: str
more...
|
Supported Version Ranges |
| ipsec_tunnel |
v7.2.1 -> 7.6.6 |
- link_loadbalance - LAN extension link load balance strategy. type: str choices: activebackup, loadbalance
more...
|
Supported Version Ranges |
| link_loadbalance |
v7.2.1 -> 7.6.6 |
| [activebackup] |
v7.2.1 -> 7.6.6 |
| [loadbalance] |
v7.2.1 -> 7.6.6 |
- traffic_split_services - Config FortiExtender traffic split interface for LAN extension. type: list member_path: lan_extension/traffic_split_services:name
more...
| Supported Version Ranges |
| traffic_split_services |
v7.6.1 -> 7.6.6 |
- address - Address selection. Source firewall.address.name. type: str
more...
|
Supported Version Ranges |
| address |
v7.6.1 -> 7.6.6 |
- name - FortiExtender LAN extension tunnel split entry name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.6.1 -> 7.6.6 |
- service - Service selection. Source firewall.service.custom.name. type: str
more...
|
Supported Version Ranges |
| service |
v7.6.1 -> 7.6.6 |
- vsdb - Set video streaming traffic goes through local WAN [enable/disable]. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| vsdb |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
- login_password - Set the managed extender"s administrator password. type: str
more...
|
Supported Version Ranges |
| login_password |
v7.2.1 -> 7.6.6 |
- login_password_change - Change or reset the administrator password of a managed extender (yes, default, or no). type: str choices: yes, default, no
more...
|
Supported Version Ranges |
| login_password_change |
v7.2.1 -> 7.6.6 |
| [yes] |
v7.2.1 -> 7.6.6 |
| [default] |
v7.2.1 -> 7.6.6 |
| [no] |
v7.2.1 -> 7.6.6 |
- model - Model. type: str 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, FXE11G, FX211G
more...
|
Supported Version Ranges |
| model |
v7.2.1 -> 7.6.6 |
| [FX201E] |
v7.2.1 -> 7.6.6 |
| [FX211E] |
v7.2.1 -> 7.6.6 |
| [FX200F] |
v7.2.1 -> 7.6.6 |
| [FXA11F] |
v7.2.1 -> 7.6.6 |
| [FXE11F] |
v7.2.1 -> 7.6.6 |
| [FXA21F] |
v7.2.1 -> 7.6.6 |
| [FXE21F] |
v7.2.1 -> 7.6.6 |
| [FXA22F] |
v7.2.1 -> 7.6.6 |
| [FXE22F] |
v7.2.1 -> 7.6.6 |
| [FX212F] |
v7.2.1 -> 7.6.6 |
| [FX311F] |
v7.2.1 -> 7.6.6 |
| [FX312F] |
v7.2.1 -> 7.6.6 |
| [FX511F] |
v7.2.1 -> 7.6.6 |
| [FXR51G] |
v7.4.4 -> 7.6.6 |
| [FXN51G] |
v7.6.0 -> 7.6.6 |
| [FXW51G] |
v7.6.0 -> 7.6.6 |
| [FVG21F] |
v7.2.1 -> 7.6.6 |
| [FVA21F] |
v7.2.1 -> 7.6.6 |
| [FVG22F] |
v7.2.1 -> 7.6.6 |
| [FVA22F] |
v7.2.1 -> 7.6.6 |
| [FX04DA] |
v7.2.1 -> 7.6.6 |
| [FG] |
v7.4.4 -> 7.6.6 |
| [BS10FW] |
v7.4.4 -> 7.6.6 |
| [BS20GW] |
v7.4.4 -> 7.6.6 |
| [BS20GN] |
v7.4.4 -> 7.6.6 |
| [FVG51G] |
v7.6.1 -> 7.6.6 |
| [FXE11G] |
v7.6.3 -> 7.6.6 |
| [FX211G] |
v7.6.4 -> 7.6.6 |
- name - FortiExtender profile name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.2.1 -> 7.6.6 |
- wifi - FortiExtender Wi-Fi configuration. type: dict
more...
| Supported Version Ranges |
| wifi |
v7.4.4 -> 7.6.6 |
- country - Country in which this FEX will operate . type: str 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, TL, TG, TT, TN, TR, TM, AE, TC, UG, UA, GB, US, PS, UY, UZ, VU, VE, VN, VI, WF, YE, ZM, ZW, JP, CA
more...
|
Supported Version Ranges |
| country |
v7.4.4 -> 7.6.6 |
| [--] |
v7.4.4 -> 7.6.6 |
| [AF] |
v7.4.4 -> 7.6.6 |
| [AL] |
v7.4.4 -> 7.6.6 |
| [DZ] |
v7.4.4 -> 7.6.6 |
| [AS] |
v7.4.4 -> 7.6.6 |
| [AO] |
v7.4.4 -> 7.6.6 |
| [AR] |
v7.4.4 -> 7.6.6 |
| [AM] |
v7.4.4 -> 7.6.6 |
| [AU] |
v7.4.4 -> 7.6.6 |
| [AT] |
v7.4.4 -> 7.6.6 |
| [AZ] |
v7.4.4 -> 7.6.6 |
| [BS] |
v7.4.4 -> 7.6.6 |
| [BH] |
v7.4.4 -> 7.6.6 |
| [BD] |
v7.4.4 -> 7.6.6 |
| [BB] |
v7.4.4 -> 7.6.6 |
| [BY] |
v7.4.4 -> 7.6.6 |
| [BE] |
v7.4.4 -> 7.6.6 |
| [BZ] |
v7.4.4 -> 7.6.6 |
| [BJ] |
v7.4.4 -> 7.6.6 |
| [BM] |
v7.4.4 -> 7.6.6 |
| [BT] |
v7.4.4 -> 7.6.6 |
| [BO] |
v7.4.4 -> 7.6.6 |
| [BA] |
v7.4.4 -> 7.6.6 |
| [BW] |
v7.4.4 -> 7.6.6 |
| [BR] |
v7.4.4 -> 7.6.6 |
| [BN] |
v7.4.4 -> 7.6.6 |
| [BG] |
v7.4.4 -> 7.6.6 |
| [BF] |
v7.4.4 -> 7.6.6 |
| [KH] |
v7.4.4 -> 7.6.6 |
| [CM] |
v7.4.4 -> 7.6.6 |
| [KY] |
v7.4.4 -> 7.6.6 |
| [CF] |
v7.4.4 -> 7.6.6 |
| [TD] |
v7.4.4 -> 7.6.6 |
| [CL] |
v7.4.4 -> 7.6.6 |
| [CN] |
v7.4.4 -> 7.6.6 |
| [CX] |
v7.4.4 -> 7.6.6 |
| [CO] |
v7.4.4 -> 7.6.6 |
| [CG] |
v7.4.4 -> 7.6.6 |
| [CD] |
v7.4.4 -> 7.6.6 |
| [CR] |
v7.4.4 -> 7.6.6 |
| [HR] |
v7.4.4 -> 7.6.6 |
| [CY] |
v7.4.4 -> 7.6.6 |
| [CZ] |
v7.4.4 -> 7.6.6 |
| [DK] |
v7.4.4 -> 7.6.6 |
| [DJ] |
v7.4.4 -> 7.6.6 |
| [DM] |
v7.4.4 -> 7.6.6 |
| [DO] |
v7.4.4 -> 7.6.6 |
| [EC] |
v7.4.4 -> 7.6.6 |
| [EG] |
v7.4.4 -> 7.6.6 |
| [SV] |
v7.4.4 -> 7.6.6 |
| [ET] |
v7.4.4 -> 7.6.6 |
| [EE] |
v7.4.4 -> 7.6.6 |
| [GF] |
v7.4.4 -> 7.6.6 |
| [PF] |
v7.4.4 -> 7.6.6 |
| [FO] |
v7.4.4 -> 7.6.6 |
| [FJ] |
v7.4.4 -> 7.6.6 |
| [FI] |
v7.4.4 -> 7.6.6 |
| [FR] |
v7.4.4 -> 7.6.6 |
| [GA] |
v7.4.4 -> 7.6.6 |
| [GE] |
v7.4.4 -> 7.6.6 |
| [GM] |
v7.4.4 -> 7.6.6 |
| [DE] |
v7.4.4 -> 7.6.6 |
| [GH] |
v7.4.4 -> 7.6.6 |
| [GI] |
v7.4.4 -> 7.6.6 |
| [GR] |
v7.4.4 -> 7.6.6 |
| [GL] |
v7.4.4 -> 7.6.6 |
| [GD] |
v7.4.4 -> 7.6.6 |
| [GP] |
v7.4.4 -> 7.6.6 |
| [GU] |
v7.4.4 -> 7.6.6 |
| [GT] |
v7.4.4 -> 7.6.6 |
| [GY] |
v7.4.4 -> 7.6.6 |
| [HT] |
v7.4.4 -> 7.6.6 |
| [HN] |
v7.4.4 -> 7.6.6 |
| [HK] |
v7.4.4 -> 7.6.6 |
| [HU] |
v7.4.4 -> 7.6.6 |
| [IS] |
v7.4.4 -> 7.6.6 |
| [IN] |
v7.4.4 -> 7.6.6 |
| [ID] |
v7.4.4 -> 7.6.6 |
| [IQ] |
v7.4.4 -> 7.6.6 |
| [IE] |
v7.4.4 -> 7.6.6 |
| [IM] |
v7.4.4 -> 7.6.6 |
| [IL] |
v7.4.4 -> 7.6.6 |
| [IT] |
v7.4.4 -> 7.6.6 |
| [CI] |
v7.4.4 -> 7.6.6 |
| [JM] |
v7.4.4 -> 7.6.6 |
| [JO] |
v7.4.4 -> 7.6.6 |
| [KZ] |
v7.4.4 -> 7.6.6 |
| [KE] |
v7.4.4 -> 7.6.6 |
| [KR] |
v7.4.4 -> 7.6.6 |
| [KW] |
v7.4.4 -> 7.6.6 |
| [LA] |
v7.4.4 -> 7.6.6 |
| [LV] |
v7.4.4 -> 7.6.6 |
| [LB] |
v7.4.4 -> 7.6.6 |
| [LS] |
v7.4.4 -> 7.6.6 |
| [LR] |
v7.4.4 -> 7.6.6 |
| [LY] |
v7.4.4 -> 7.6.6 |
| [LI] |
v7.4.4 -> 7.6.6 |
| [LT] |
v7.4.4 -> 7.6.6 |
| [LU] |
v7.4.4 -> 7.6.6 |
| [MO] |
v7.4.4 -> 7.6.6 |
| [MK] |
v7.4.4 -> 7.6.6 |
| [MG] |
v7.4.4 -> 7.6.6 |
| [MW] |
v7.4.4 -> 7.6.6 |
| [MY] |
v7.4.4 -> 7.6.6 |
| [MV] |
v7.4.4 -> 7.6.6 |
| [ML] |
v7.4.4 -> 7.6.6 |
| [MT] |
v7.4.4 -> 7.6.6 |
| [MH] |
v7.4.4 -> 7.6.6 |
| [MQ] |
v7.4.4 -> 7.6.6 |
| [MR] |
v7.4.4 -> 7.6.6 |
| [MU] |
v7.4.4 -> 7.6.6 |
| [YT] |
v7.4.4 -> 7.6.6 |
| [MX] |
v7.4.4 -> 7.6.6 |
| [FM] |
v7.4.4 -> 7.6.6 |
| [MD] |
v7.4.4 -> 7.6.6 |
| [MC] |
v7.4.4 -> 7.6.6 |
| [MN] |
v7.4.4 -> 7.6.6 |
| [MA] |
v7.4.4 -> 7.6.6 |
| [MZ] |
v7.4.4 -> 7.6.6 |
| [MM] |
v7.4.4 -> 7.6.6 |
| [NA] |
v7.4.4 -> 7.6.6 |
| [NP] |
v7.4.4 -> 7.6.6 |
| [NL] |
v7.4.4 -> 7.6.6 |
| [AN] |
v7.4.4 -> 7.6.6 |
| [AW] |
v7.4.4 -> 7.6.6 |
| [NZ] |
v7.4.4 -> 7.6.6 |
| [NI] |
v7.4.4 -> 7.6.6 |
| [NE] |
v7.4.4 -> 7.6.6 |
| [NG] |
v7.4.4 -> 7.6.6 |
| [NO] |
v7.4.4 -> 7.6.6 |
| [MP] |
v7.4.4 -> 7.6.6 |
| [OM] |
v7.4.4 -> 7.6.6 |
| [PK] |
v7.4.4 -> 7.6.6 |
| [PW] |
v7.4.4 -> 7.6.6 |
| [PA] |
v7.4.4 -> 7.6.6 |
| [PG] |
v7.4.4 -> 7.6.6 |
| [PY] |
v7.4.4 -> 7.6.6 |
| [PE] |
v7.4.4 -> 7.6.6 |
| [PH] |
v7.4.4 -> 7.6.6 |
| [PL] |
v7.4.4 -> 7.6.6 |
| [PT] |
v7.4.4 -> 7.6.6 |
| [PR] |
v7.4.4 -> 7.6.6 |
| [QA] |
v7.4.4 -> 7.6.6 |
| [RE] |
v7.4.4 -> 7.6.6 |
| [RO] |
v7.4.4 -> 7.6.6 |
| [RU] |
v7.4.4 -> 7.6.6 |
| [RW] |
v7.4.4 -> 7.6.6 |
| [BL] |
v7.4.4 -> 7.6.6 |
| [KN] |
v7.4.4 -> 7.6.6 |
| [LC] |
v7.4.4 -> 7.6.6 |
| [MF] |
v7.4.4 -> 7.6.6 |
| [PM] |
v7.4.4 -> 7.6.6 |
| [VC] |
v7.4.4 -> 7.6.6 |
| [SA] |
v7.4.4 -> 7.6.6 |
| [SN] |
v7.4.4 -> 7.6.6 |
| [RS] |
v7.4.4 -> 7.6.6 |
| [ME] |
v7.4.4 -> 7.6.6 |
| [SL] |
v7.4.4 -> 7.6.6 |
| [SG] |
v7.4.4 -> 7.6.6 |
| [SK] |
v7.4.4 -> 7.6.6 |
| [SI] |
v7.4.4 -> 7.6.6 |
| [SO] |
v7.4.4 -> 7.6.6 |
| [ZA] |
v7.4.4 -> 7.6.6 |
| [ES] |
v7.4.4 -> 7.6.6 |
| [LK] |
v7.4.4 -> 7.6.6 |
| [SR] |
v7.4.4 -> 7.6.6 |
| [SZ] |
v7.4.4 -> 7.6.6 |
| [SE] |
v7.4.4 -> 7.6.6 |
| [CH] |
v7.4.4 -> 7.6.6 |
| [TW] |
v7.4.4 -> 7.6.6 |
| [TZ] |
v7.4.4 -> 7.6.6 |
| [TH] |
v7.4.4 -> 7.6.6 |
| [TL] |
v7.6.3 -> 7.6.6 |
| [TG] |
v7.4.4 -> 7.6.6 |
| [TT] |
v7.4.4 -> 7.6.6 |
| [TN] |
v7.4.4 -> 7.6.6 |
| [TR] |
v7.4.4 -> 7.6.6 |
| [TM] |
v7.4.4 -> 7.6.6 |
| [AE] |
v7.4.4 -> 7.6.6 |
| [TC] |
v7.4.4 -> 7.6.6 |
| [UG] |
v7.4.4 -> 7.6.6 |
| [UA] |
v7.4.4 -> 7.6.6 |
| [GB] |
v7.4.4 -> 7.6.6 |
| [US] |
v7.4.4 -> 7.6.6 |
| [PS] |
v7.4.4 -> 7.6.6 |
| [UY] |
v7.4.4 -> 7.6.6 |
| [UZ] |
v7.4.4 -> 7.6.6 |
| [VU] |
v7.4.4 -> 7.6.6 |
| [VE] |
v7.4.4 -> 7.6.6 |
| [VN] |
v7.4.4 -> 7.6.6 |
| [VI] |
v7.4.4 -> 7.6.6 |
| [WF] |
v7.4.4 -> 7.6.6 |
| [YE] |
v7.4.4 -> 7.6.6 |
| [ZM] |
v7.4.4 -> 7.6.6 |
| [ZW] |
v7.4.4 -> 7.6.6 |
| [JP] |
v7.4.4 -> 7.6.6 |
| [CA] |
v7.4.4 -> 7.6.6 |
- radio_1 - Radio-1 config for Wi-Fi 2.4GHz type: dict
more...
| Supported Version Ranges |
| radio_1 |
v7.4.4 -> 7.6.6 |
- band - Wi-Fi band selection 2.4GHz / 5GHz. type: str choices: 2.4GHz
more...
|
Supported Version Ranges |
| band |
v7.4.4 -> 7.6.6 |
| [2.4GHz] |
v7.4.4 -> 7.6.6 |
- bandwidth - Wi-Fi channel bandwidth. type: str choices: auto, 20MHz, 40MHz, 80MHz
more...
|
Supported Version Ranges |
| bandwidth |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [20MHz] |
v7.4.4 -> 7.6.6 |
| [40MHz] |
v7.4.4 -> 7.6.6 |
| [80MHz] |
v7.4.4 -> 7.6.6 |
- beacon_interval - Wi-Fi beacon interval in miliseconds (100 - 3500). type: int
more...
|
Supported Version Ranges |
| beacon_interval |
v7.4.4 -> 7.6.6 |
- bss_color - Wi-Fi 802.11AX BSS color value (0 - 63, 0 = disable). type: int
more...
|
Supported Version Ranges |
| bss_color |
v7.4.4 -> 7.6.6 |
- bss_color_mode - Wi-Fi 802.11AX BSS color mode. type: str choices: auto, static
more...
|
Supported Version Ranges |
| bss_color_mode |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [static] |
v7.4.4 -> 7.6.6 |
- channel - Wi-Fi channels. type: list choices: CH1, CH2, CH3, CH4, CH5, CH6, CH7, CH8, CH9, CH10, CH11
more...
|
Supported Version Ranges |
| channel |
v7.4.4 -> 7.6.6 |
| [CH1] |
v7.4.4 -> 7.6.6 |
| [CH2] |
v7.4.4 -> 7.6.6 |
| [CH3] |
v7.4.4 -> 7.6.6 |
| [CH4] |
v7.4.4 -> 7.6.6 |
| [CH5] |
v7.4.4 -> 7.6.6 |
| [CH6] |
v7.4.4 -> 7.6.6 |
| [CH7] |
v7.4.4 -> 7.6.6 |
| [CH8] |
v7.4.4 -> 7.6.6 |
| [CH9] |
v7.4.4 -> 7.6.6 |
| [CH10] |
v7.4.4 -> 7.6.6 |
| [CH11] |
v7.4.4 -> 7.6.6 |
- extension_channel - Wi-Fi extension channel. type: str choices: auto, higher, lower
more...
|
Supported Version Ranges |
| extension_channel |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [higher] |
v7.4.4 -> 7.6.6 |
| [lower] |
v7.4.4 -> 7.6.6 |
- guard_interval - Wi-Fi guard interval. type: str choices: auto, 400ns, 800ns
more...
|
Supported Version Ranges |
| guard_interval |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [400ns] |
v7.4.4 -> 7.6.6 |
| [800ns] |
v7.4.4 -> 7.6.6 |
- lan_ext_vap - Wi-Fi LAN-Extention VAP. Select only one VAP. Source extension-controller.extender-vap.name. type: str
more...
|
Supported Version Ranges |
| lan_ext_vap |
v7.4.4 -> 7.6.6 |
- local_vaps - Wi-Fi local VAP. Select up to three VAPs. type: list member_path: wifi/radio_1/local_vaps:name
more...
| Supported Version Ranges |
| local_vaps |
v7.4.4 -> 7.6.6 |
- name - Wi-Fi local VAP name. Source extension-controller.extender-vap.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.4.4 -> 7.6.6 |
- max_clients - Maximum number of Wi-Fi radio clients (0 - 512, 0 = unlimited). type: int
more...
|
Supported Version Ranges |
| max_clients |
v7.4.4 -> 7.6.6 |
- mode - Wi-Fi radio mode AP(LAN mode) / Client(WAN mode). type: str choices: AP, Client
more...
|
Supported Version Ranges |
| mode |
v7.4.4 -> 7.6.6 |
| [AP] |
v7.4.4 -> 7.6.6 |
| [Client] |
v7.4.4 -> 7.6.6 |
- operating_standard - Wi-Fi operating standard. type: str 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
more...
|
Supported Version Ranges |
| operating_standard |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [11A-N-AC-AX] |
v7.4.4 -> 7.6.6 |
| [11A-N-AC] |
v7.4.4 -> 7.6.6 |
| [11A-N] |
v7.4.4 -> 7.6.6 |
| [11A] |
v7.4.4 -> 7.6.6 |
| [11N-AC-AX] |
v7.4.4 -> 7.6.6 |
| [11AC-AX] |
v7.4.4 -> 7.6.6 |
| [11AC] |
v7.4.4 -> 7.6.6 |
| [11N-AC] |
v7.4.4 -> 7.6.6 |
| [11B-G-N-AX] |
v7.4.4 -> 7.6.6 |
| [11B-G-N] |
v7.4.4 -> 7.6.6 |
| [11B-G] |
v7.4.4 -> 7.6.6 |
| [11B] |
v7.4.4 -> 7.6.6 |
| [11G-N-AX] |
v7.4.4 -> 7.6.6 |
| [11N-AX] |
v7.4.4 -> 7.6.6 |
| [11AX] |
v7.4.4 -> 7.6.6 |
| [11G-N] |
v7.4.4 -> 7.6.6 |
| [11N] |
v7.4.4 -> 7.6.6 |
| [11G] |
v7.4.4 -> 7.6.6 |
- power_level - Wi-Fi power level in percent (0 - 100, 0 = auto). type: int
more...
|
Supported Version Ranges |
| power_level |
v7.4.4 -> 7.6.6 |
- set_80211d - Enable/disable Wi-Fi 802.11d. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| set_80211d |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
- status - Enable/disable Wi-Fi radio. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| status |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
- radio_2 - Radio-2 config for Wi-Fi 5GHz type: dict
more...
| Supported Version Ranges |
| radio_2 |
v7.4.4 -> 7.6.6 |
- band - Wi-Fi band selection 2.4GHz / 5GHz. type: str choices: 5GHz
more...
|
Supported Version Ranges |
| band |
v7.4.4 -> 7.6.6 |
| [5GHz] |
v7.4.4 -> 7.6.6 |
- bandwidth - Wi-Fi channel bandwidth. type: str choices: auto, 20MHz, 40MHz, 80MHz
more...
|
Supported Version Ranges |
| bandwidth |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [20MHz] |
v7.4.4 -> 7.6.6 |
| [40MHz] |
v7.4.4 -> 7.6.6 |
| [80MHz] |
v7.4.4 -> 7.6.6 |
- beacon_interval - Wi-Fi beacon interval in miliseconds (100 - 3500). type: int
more...
|
Supported Version Ranges |
| beacon_interval |
v7.4.4 -> 7.6.6 |
- bss_color - Wi-Fi 802.11AX BSS color value (0 - 63, 0 = disable). type: int
more...
|
Supported Version Ranges |
| bss_color |
v7.4.4 -> 7.6.6 |
- bss_color_mode - Wi-Fi 802.11AX BSS color mode. type: str choices: auto, static
more...
|
Supported Version Ranges |
| bss_color_mode |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [static] |
v7.4.4 -> 7.6.6 |
- channel - Wi-Fi channels. type: list 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
more...
|
Supported Version Ranges |
| channel |
v7.4.4 -> 7.6.6 |
| [CH36] |
v7.4.4 -> 7.6.6 |
| [CH40] |
v7.4.4 -> 7.6.6 |
| [CH44] |
v7.4.4 -> 7.6.6 |
| [CH48] |
v7.4.4 -> 7.6.6 |
| [CH52] |
v7.4.4 -> 7.6.6 |
| [CH56] |
v7.4.4 -> 7.6.6 |
| [CH60] |
v7.4.4 -> 7.6.6 |
| [CH64] |
v7.4.4 -> 7.6.6 |
| [CH100] |
v7.4.4 -> 7.6.6 |
| [CH104] |
v7.4.4 -> 7.6.6 |
| [CH108] |
v7.4.4 -> 7.6.6 |
| [CH112] |
v7.4.4 -> 7.6.6 |
| [CH116] |
v7.4.4 -> 7.6.6 |
| [CH120] |
v7.4.4 -> 7.6.6 |
| [CH124] |
v7.4.4 -> 7.6.6 |
| [CH128] |
v7.4.4 -> 7.6.6 |
| [CH132] |
v7.4.4 -> 7.6.6 |
| [CH136] |
v7.4.4 -> 7.6.6 |
| [CH140] |
v7.4.4 -> 7.6.6 |
| [CH144] |
v7.4.4 -> 7.6.6 |
| [CH149] |
v7.4.4 -> 7.6.6 |
| [CH153] |
v7.4.4 -> 7.6.6 |
| [CH157] |
v7.4.4 -> 7.6.6 |
| [CH161] |
v7.4.4 -> 7.6.6 |
| [CH165] |
v7.4.4 -> 7.6.6 |
- extension_channel - Wi-Fi extension channel. type: str choices: auto, higher, lower
more...
|
Supported Version Ranges |
| extension_channel |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [higher] |
v7.4.4 -> 7.6.6 |
| [lower] |
v7.4.4 -> 7.6.6 |
- guard_interval - Wi-Fi guard interval. type: str choices: auto, 400ns, 800ns
more...
|
Supported Version Ranges |
| guard_interval |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [400ns] |
v7.4.4 -> 7.6.6 |
| [800ns] |
v7.4.4 -> 7.6.6 |
- lan_ext_vap - Wi-Fi LAN-Extention VAP. Select only one VAP. Source extension-controller.extender-vap.name. type: str
more...
|
Supported Version Ranges |
| lan_ext_vap |
v7.4.4 -> 7.6.6 |
- local_vaps - Wi-Fi local VAP. Select up to three VAPs. type: list member_path: wifi/radio_2/local_vaps:name
more...
| Supported Version Ranges |
| local_vaps |
v7.4.4 -> 7.6.6 |
- name - Wi-Fi local VAP name. Source extension-controller.extender-vap.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.4.4 -> 7.6.6 |
- max_clients - Maximum number of Wi-Fi radio clients (0 - 512, 0 = unlimited). type: int
more...
|
Supported Version Ranges |
| max_clients |
v7.4.4 -> 7.6.6 |
- mode - Wi-Fi radio mode AP(LAN mode) / Client(WAN mode). type: str choices: AP, Client
more...
|
Supported Version Ranges |
| mode |
v7.4.4 -> 7.6.6 |
| [AP] |
v7.4.4 -> 7.6.6 |
| [Client] |
v7.4.4 -> 7.6.6 |
- operating_standard - Wi-Fi operating standard. type: str 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
more...
|
Supported Version Ranges |
| operating_standard |
v7.4.4 -> 7.6.6 |
| [auto] |
v7.4.4 -> 7.6.6 |
| [11A-N-AC-AX] |
v7.4.4 -> 7.6.6 |
| [11A-N-AC] |
v7.4.4 -> 7.6.6 |
| [11A-N] |
v7.4.4 -> 7.6.6 |
| [11A] |
v7.4.4 -> 7.6.6 |
| [11N-AC-AX] |
v7.4.4 -> 7.6.6 |
| [11AC-AX] |
v7.4.4 -> 7.6.6 |
| [11AC] |
v7.4.4 -> 7.6.6 |
| [11N-AC] |
v7.4.4 -> 7.6.6 |
| [11B-G-N-AX] |
v7.4.4 -> 7.6.6 |
| [11B-G-N] |
v7.4.4 -> 7.6.6 |
| [11B-G] |
v7.4.4 -> 7.6.6 |
| [11B] |
v7.4.4 -> 7.6.6 |
| [11G-N-AX] |
v7.4.4 -> 7.6.6 |
| [11N-AX] |
v7.4.4 -> 7.6.6 |
| [11AX] |
v7.4.4 -> 7.6.6 |
| [11G-N] |
v7.4.4 -> 7.6.6 |
| [11N] |
v7.4.4 -> 7.6.6 |
| [11G] |
v7.4.4 -> 7.6.6 |
- power_level - Wi-Fi power level in percent (0 - 100, 0 = auto). type: int
more...
|
Supported Version Ranges |
| power_level |
v7.4.4 -> 7.6.6 |
- set_80211d - Enable/disable Wi-Fi 802.11d. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| set_80211d |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
- status - Enable/disable Wi-Fi radio. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| status |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- name: FortiExtender extender profile configuration.
fortinet.fortios.fortios_extension_controller_extender_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
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: ""
switch_back_timer: "86400"
default_sim: "sim1"
gps: "disable"
multiple_PDN: "disable"
pdn1_dataplan: " (source extension-controller.dataplan.name)"
pdn2_dataplan: " (source extension-controller.dataplan.name)"
pdn3_dataplan: " (source extension-controller.dataplan.name)"
pdn4_dataplan: " (source extension-controller.dataplan.name)"
preferred_carrier: ""
redundant_intf: ""
redundant_mode: "disable"
sim1_pin: "disable"
sim1_pin_code: ""
sim2_pin: "disable"
sim2_pin_code: ""
modem2:
auto_switch:
dataplan: "disable"
disconnect: "disable"
disconnect_period: "600"
disconnect_threshold: "3"
signal: "disable"
switch_back: "time"
switch_back_time: ""
switch_back_timer: "86400"
default_sim: "sim1"
gps: "disable"
multiple_PDN: "disable"
pdn1_dataplan: " (source extension-controller.dataplan.name)"
pdn2_dataplan: " (source extension-controller.dataplan.name)"
pdn3_dataplan: " (source extension-controller.dataplan.name)"
pdn4_dataplan: " (source extension-controller.dataplan.name)"
preferred_carrier: ""
redundant_intf: ""
redundant_mode: "disable"
sim1_pin: "disable"
sim1_pin_code: ""
sim2_pin: "disable"
sim2_pin_code: ""
sms_notification:
alert:
data_exhausted: ""
fgt_backup_mode_switch: ""
low_signal_strength: ""
mode_switch: ""
os_image_fallback: ""
session_disconnect: ""
system_reboot: ""
receiver:
-
alert: "system-reboot"
name: "default_name_71"
phone_number: ""
status: "disable"
status: "disable"
enforce_bandwidth: "enable"
extension: "wan-extension"
id: "77"
lan_extension:
backhaul:
-
health_check_fail_cnt: "5"
health_check_interval: "5"
health_check_probe_cnt: "1"
health_check_probe_tm: "2"
health_check_recovery_cnt: "5"
name: "default_name_85"
port: "wan"
role: "primary"
weight: "1"
backhaul_interface: " (source system.interface.name)"
backhaul_ip: ""
downlinks:
-
name: "default_name_92"
port: "port1"
pvid: "1"
type: "port"
vap: " (source extension-controller.extender-vap.name)"
vids:
-
vid: ""
ipsec_tunnel: ""
link_loadbalance: "activebackup"
traffic_split_services:
-
address: " (source firewall.address.name)"
name: "default_name_103"
service: " (source firewall.service.custom.name)"
vsdb: "disable"
login_password: ""
login_password_change: "yes"
model: "FX201E"
name: "default_name_109"
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: " (source extension-controller.extender-vap.name)"
local_vaps:
-
name: "default_name_123 (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: " (source extension-controller.extender-vap.name)"
local_vaps:
-
name: "default_name_141 (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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
.. hint::
If you notice any issues in this documentation, you can create a pull request to improve it.