Модуль fortinet.fortios.fortios_extension_controller_extender_profile – Настройка профиля расширителя FortiExtender в FortiOS и FortiGate от Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Для использования в playbook, укажите: fortinet.fortios.fortios_extension_controller_extender_profile.
Новое в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), разрешая пользователю устанавливать и изменять функцию extension_controller и категорию extender_profile. Примеры включают все параметры, и значения должны быть скорректированы под источники данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токенная аутентификация. Создаётся в GUI Fortigate. |
enable_log boolean | Включить/Выключить логирование для задачи. Варианты:
|
extension_controller_extender_profile dictionary | Конфигурация профиля FortiExtender extender. |
|
allowaccess list / elements=string |
Управление доступом к управляемому устройству extender. Разделяйте записи пробелом. Варианты:
|
|
bandwidth_limit integer |
Ограничение полосы пропускания расширения LAN FortiExtender (Mbps). |
|
cellular dictionary |
Конфигурация сотовой связи FortiExtender. |
|
controller_report dictionary |
Конфигурация отчёта контроллера FortiExtender. |
|
interval integer |
Интервал отчёта контроллера. |
|
signal_threshold integer |
Пороговое значение сигнала отчёта контроллера. |
|
status string |
Статус отчёта контроллера FortiExtender. Варианты:
|
|
dataplan list / elements=dictionary |
Имена тарифных планов. |
|
name string / required |
Имя тарифного плана. Источник extension-controller.dataplan.name. |
|
modem1 dictionary |
Параметры конфигурации модема 1. |
|
auto_switch dictionary |
Конфигурация автоматического переключения FortiExtender. |
|
dataplan string |
Автоматическое переключение на основе использования данных. Варианты:
|
|
disconnect string |
Автоматическое переключение при отключении. Варианты:
|
|
disconnect_period integer |
Автоматическое переключение на основе периода отключения. |
|
disconnect_threshold integer |
Автоматическое переключение на основе порогового значения отключения. |
|
signal string |
Автоматическое переключение на основе силы сигнала. Варианты:
|
|
switch_back list / elements=string |
Автоматическое переключение с несколькими вариантами обратного переключения. Варианты:
|
|
switch_back_time string |
Автоматическое переключение на предпочтительный SIM/оператор в указанное время по UTC (ЧЧ:ММ). |
|
switch_back_timer integer |
Автоматическое переключение на предпочтительный SIM/оператор через указанное время (3600 - 2147483647 сек). |
|
default_sim string |
Выбор SIM по умолчанию. Варианты:
|
|
gps string |
Включение/выключение GPS FortiExtender. Варианты:
|
|
preferred_carrier string |
Предпочтительный оператор. |
|
redundant_intf string |
Резервный интерфейс. |
|
redundant_mode string |
Режим FortiExtender. Choices:
|
|
sim1_pin string |
SIM Choices:
|
|
sim1_pin_code string |
SIM |
|
sim2_pin string |
SIM Choices:
|
|
sim2_pin_code string |
SIM |
|
modem2 dictionary |
Параметры конфигурации для модема 2. |
|
auto_switch dictionary |
Конфигурация автоматического переключения FortiExtender. |
|
dataplan string |
Автоматическое переключение на основе использования данных. Choices:
|
|
disconnect string |
Автоматическое переключение при отключении. Choices:
|
|
disconnect_period integer |
Автоматическое переключение на основе периода отключения. |
|
disconnect_threshold integer |
Автоматическое переключение на основе порога отключения. |
|
signal string |
Автоматическое переключение на основе силы сигнала. Choices:
|
|
switch_back list / elements=string |
Автоматическое переключение с несколькими вариантами переключения назад. Choices:
|
|
switch_back_time string |
Автоматическое переключение на предпочтительную SIM-карту/оператора в указанное время в формате UTC (ЧЧ:ММ). |
|
switch_back_timer integer |
Автоматическое переключение на предпочтительную SIM-карту/оператора через указанное время (3600 - 2147483647 сек). |
|
default_sim string |
Выбор SIM-карты по умолчанию. Choices:
|
|
gps string |
Включение/выключение GPS FortiExtender. Choices:
|
|
preferred_carrier string |
Предпочтительный оператор. |
|
redundant_intf string |
Резервный интерфейс. |
|
redundant_mode string |
Режим FortiExtender. Choices:
|
|
sim1_pin string |
SIM Choices:
|
|
sim1_pin_code string |
SIM |
|
sim2_pin string |
SIM Choices:
|
|
sim2_pin_code string |
SIM |
|
sms_notification dictionary |
Конфигурация SMS-уведомлений FortiExtender. |
|
alert dictionary |
Список SMS-оповещений. |
|
data_exhausted string |
Строка отображения при исчерпании данных. |
|
fgt_backup_mode_switch string |
Строка отображения при переключении резервного режима FortiGate. |
|
low_signal_strength string |
Строка отображения при низком уровне сигнала. |
|
mode_switch string |
Строка отображения при переключении режима. |
|
os_image_fallback string |
Строка отображения при откате к предыдущему образу ОС. |
|
session_disconnect string |
Строка отображения при отключении сессии. |
|
system_reboot string |
Строка отображения при перезагрузке системы. |
|
receiver list / elements=dictionary |
Список получателей SMS-уведомлений. |
|
alert list / elements=string |
Несколько вариантов оповещений. Варианты:
|
|
name string / required |
Имя получателя SMS-уведомлений FortiExtender. |
|
phone_number string |
Номер телефона получателя. Формат: [+][код страны][код региона][местный номер телефона]. Например, +16501234567. |
|
status string |
Статус получателя SMS-уведомлений. Варианты:
|
|
status string |
Статус SMS-уведомлений FortiExtender. Варианты:
|
|
enforce_bandwidth string |
Включить/выключить принудительное ограничение пропускной способности на интерфейсе расширения LAN. Варианты:
|
|
extension string |
Вариант расширения. Варианты:
|
|
id integer |
Идентификатор. |
|
lan_extension dictionary |
Конфигурация расширения LAN FortiExtender. |
|
backhaul list / elements=dictionary |
Конфигурация туннеля обратного канала расширения LAN. |
|
name string / required |
Имя обратного канала расширения LAN FortiExtender. |
|
port string |
Порт восходящей линии связи FortiExtender. Варианты:
|
|
role string |
Порт восходящей линии связи FortiExtender. Варианты:
|
|
weight integer |
Параметр веса WRR. |
|
backhaul_interface string |
IPsec phase1 interface. Source system.interface.name. |
|
backhaul_ip string |
IPsec phase1 IPv4/FQDN. Используется для указания внешнего IP/FQDN, когда устройство FortiGate находится за устройством NAT. |
|
ipsec_tunnel string |
Имя туннеля IPsec. |
|
link_loadbalance string |
Стратегия балансировки нагрузки канала расширения LAN. Choices:
|
|
login_password string |
Установите пароль администратора для управляемого расширителя. |
|
login_password_change string |
Измените или сбросьте пароль администратора управляемого расширителя (yes, default или no). Choices:
|
|
model string |
Модель. Choices:
|
|
name string / required |
Имя профиля FortiExtender. |
|
wifi dictionary |
Конфигурация Wi-Fi FortiExtender. |
|
country string |
Страна, в которой будет работать этот FEX. Choices:
|
|
radio_1 dictionary |
Конфигурация Radio-1 для Wi-Fi 2.4GHz |
|
band string |
Выбор диапазона Wi-Fi 2.4GHz / 5GHz. Choices:
|
|
bandwidth string |
Пропускная способность Wi-Fi канала. Choices:
|
|
beacon_interval integer |
Интервал маяка Wi-Fi в миллисекундах (100 - 3500). |
|
bss_color integer |
Значение цвета BSS Wi-Fi 802.11AX (0 - 63, 0 = отключено). |
|
bss_color_mode string |
Режим цвета BSS Wi-Fi 802.11AX. Choices:
|
|
channel list / elements=string |
Каналы Wi-Fi. Choices:
|
|
extension_channel string |
Расширительный канал Wi-Fi. Choices:
|
|
guard_interval string |
Защитный интервал Wi-Fi. Choices:
|
|
lan_ext_vap string |
Wi-Fi LAN-Extention VAP. Выберите только один VAP. Источник extension-controller.extender-vap.name. |
|
local_vaps list / elements=dictionary |
Локальный VAP Wi-Fi. Выберите до трёх VAP. |
|
name string / required |
Имя локального VAP Wi-Fi. Источник extension-controller.extender-vap.name. |
|
max_clients integer |
Максимальное количество клиентов Wi-Fi (0 - 512, 0 = неограниченное). |
|
mode string |
Режим радио Wi-Fi AP (режим LAN) / Клиент (режим WAN). Choices:
|
|
operating_standard string |
Стандарт работы Wi-Fi. Choices:
|
|
power_level integer |
Уровень мощности Wi-Fi в процентах (0 - 100, 0 = авто). |
|
set_80211d string |
Включить/отключить Wi-Fi 802.11d. Choices:
|
|
status string |
Включить/отключить радио Wi-Fi. Choices:
|
|
radio_2 dictionary |
Конфигурация Radio-2 для Wi-Fi 5GHz |
|
band string |
Выбор диапазона Wi-Fi 2.4GHz / 5GHz. Choices:
|
|
bandwidth string |
Пропускная способность Wi-Fi канала. Choices:
|
|
beacon_interval integer |
Интервал маяка Wi-Fi в миллисекундах (100 - 3500). |
|
bss_color integer |
Значение цвета BSS Wi-Fi 802.11AX (0 - 63, 0 = отключено). |
|
bss_color_mode string |
Режим цвета BSS Wi-Fi 802.11AX. Choices:
|
|
channel list / elements=string |
Каналы Wi-Fi. Choices:
|
|
extension_channel string |
Расширительный канал Wi-Fi. Choices:
|
|
guard_interval string |
Защитный интервал Wi-Fi. Choices:
|
|
lan_ext_vap string |
Wi-Fi LAN-Extention VAP. Выберите только один VAP. Источник extension-controller.extender-vap.name. |
|
local_vaps list / elements=dictionary |
Локальный VAP Wi-Fi. Выберите до трёх VAP. |
|
name string / required |
Имя локального VAP Wi-Fi. Источник extension-controller.extender-vap.name. |
|
max_clients integer |
Максимальное количество клиентов Wi-Fi (0 - 512, 0 = неограниченное). |
|
mode string |
Режим радио Wi-Fi AP (режим LAN) / Клиент (режим WAN). Choices:
|
|
operating_standard string |
Стандарт работы Wi-Fi. Choices:
|
|
power_level integer |
Уровень мощности Wi-Fi в процентах (0 - 100, 0 = авто). |
|
set_80211d string |
Включить/выключить Wi-Fi 802.11d. Choices:
|
|
status string |
Включить/выключить радио Wi-Fi. Choices:
|
member_path string | Путь к атрибуту члена для работы. Разделяется символом слеша, если атрибутов больше одного. Параметр, помеченный как member_path, является допустимым для выполнения операции с членом. |
member_state string | Добавить или удалить члена в указанном пути к атрибуту. Когда указан member_state, опция state игнорируется. Choices:
|
state string / required | Указывает, следует ли создать или удалить объект. Choices:
|
vdom string | Виртуальный домен, среди ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. Default: |
Примечания
Примечание
- Устаревший fortiosapi был объявлен устаревшим, httpapi является предпочтительным способом запуска playbooks
Примеры
- 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>"
ipsec_tunnel: "<your_own_value>"
link_loadbalance: "activebackup"
login_password: "<your_own_value>"
login_password_change: "yes"
model: "FX201E"
name: "default_name_81"
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_95 (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_113 (source extension-controller.extender-vap.name)"
max_clients: "0"
mode: "AP"
operating_standard: "auto"
power_level: "100"
set_80211d: "disable"
status: "disable"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, используемый для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при последней выполненной операции Возвращается: всегда Пример: |
mkey string | Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Указание результата операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_extension_controller_extender_profile_module.html