Модуль fortinet.fortios.fortios_extension_controller_extender_profile — настройка профиля FortiExtender в FortiOS и FortiGate от Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: 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.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
extension_controller_extender_profile dictionary | Конфигурация профиля FortiExtender. |
|
allowaccess list / elements=string |
Управление доступом к управлению подключенным расширителем. Разделяйте записи пробелом. Варианты:
|
|
bandwidth_limit integer |
Ограничение пропускной способности расширения LAN FortiExtender (Мбит/с). |
|
cellular dictionary |
Конфигурация сотовой связи FortiExtender. |
|
controller_report dictionary |
Конфигурация отчета контроллера FortiExtender. |
|
interval integer |
Интервал отправки отчетов контроллера. |
|
signal_threshold integer |
Пороговый уровень сигнала для отчетов контроллера. |
|
status string |
Состояние отчета контроллера FortiExtender. Варианты:
|
|
dataplan list / elements=dictionary |
Названия тарифных планов. |
|
name string / обязательный |
Название тарифного плана. Источник: 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 (HH:MM). |
|
switch_back_timer integer |
Автоматическое переключение на предпочтительную SIM-карту/оператора по истечении указанного времени (3600–2147483647 с). |
|
default_sim string |
Выбор SIM-карты по умолчанию. Варианты:
|
|
gps string |
Включение/отключение GPS FortiExtender. Варианты:
|
|
multiple_PDN string |
Включение/отключение нескольких PDN. Варианты:
|
|
pdn1_dataplan string |
Тарифный план PDN1. Источник: extension-controller.dataplan.name. |
|
pdn2_dataplan string |
Тарифный план PDN2. Источник: extension-controller.dataplan.name. |
|
pdn3_dataplan string |
Тарифный план PDN3. Источник: extension-controller.dataplan.name. |
|
pdn4_dataplan string |
Тарифный план PDN4. Источник: extension-controller.dataplan.name. |
|
preferred_carrier string |
Предпочтительный оператор связи. |
|
redundant_intf string |
Резервный интерфейс. |
|
redundant_mode string |
Режим FortiExtender. Варианты:
|
|
sim1_pin string |
SIM-карта Варианты:
|
|
sim1_pin_code string |
SIM-карта |
|
sim2_pin string |
SIM-карта Варианты:
|
|
sim2_pin_code string |
SIM-карта |
|
modem2 dictionary |
Параметры конфигурации модема 2. |
|
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 (HH:MM). |
|
switch_back_timer integer |
Автоматическое переключение на предпочтительную SIM-карту/оператора по истечении указанного времени (3600–2147483647 с). |
|
default_sim string |
Выбор SIM-карты по умолчанию. Варианты:
|
|
gps string |
Включение/отключение GPS FortiExtender. Варианты:
|
|
multiple_PDN string |
Включение/отключение нескольких PDN. Варианты:
|
|
pdn1_dataplan string |
Тарифный план PDN1. Источник: extension-controller.dataplan.name. |
|
pdn2_dataplan string |
Тарифный план PDN2. Источник: extension-controller.dataplan.name. |
|
pdn3_dataplan string |
Тарифный план PDN3. Источник: extension-controller.dataplan.name. |
|
pdn4_dataplan string |
Тарифный план PDN4. Источник: extension-controller.dataplan.name. |
|
preferred_carrier string |
Предпочтительный оператор связи. |
|
redundant_intf string |
Резервный интерфейс. |
|
redundant_mode string |
Режим FortiExtender. Варианты:
|
|
sim1_pin string |
SIM-карта Варианты:
|
|
sim1_pin_code string |
SIM-карта |
|
sim2_pin string |
SIM-карта Варианты:
|
|
sim2_pin_code string |
SIM-карта |
|
sms_notification dictionary |
Настройка уведомлений FortiExtender по SMS через сотовую сеть. |
|
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 / обязательный |
Имя получателя 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. |
|
health_check_fail_cnt integer |
Количество сбоев, после которого канал считается недоступным (1–10). |
|
health_check_interval integer |
Интервал проверки работоспособности в секундах (1–3600). |
|
health_check_probe_cnt integer |
Количество проб проверки работоспособности, отправляемых за один интервал (1–10). |
|
health_check_probe_tm integer |
Время ожидания ответа на пробу проверки работоспособности в секундах (1–10). |
|
health_check_recovery_cnt integer |
Количество успешных проверок, после которого канал считается доступным (1–10). |
|
name string / обязательный |
Имя транспортного канала расширения LAN FortiExtender. |
|
port string |
Порт восходящего канала FortiExtender. Варианты:
|
|
role string |
Порт восходящего канала FortiExtender. Варианты:
|
|
weight integer |
Параметр веса WRR. |
|
backhaul_interface string |
Интерфейс phase1 IPsec. Источник: system.interface.name. |
|
backhaul_ip string |
IPv4-адрес/FQDN phase1 IPsec. Используется для указания внешнего IP-адреса/FQDN, когда устройство FortiGate находится за устройством NAT. |
|
downlinks list / elements=dictionary |
Настройка интерфейса нисходящего канала FortiExtender для расширения LAN. |
|
name string / обязательный |
Имя записи конфигурации нисходящего канала расширения LAN FortiExtender. |
|
port string |
Порт нисходящего канала расширения LAN FortiExtender. Варианты:
|
|
pvid integer |
PVID нисходящего канала расширения LAN FortiExtender (1–4089). |
|
type string |
Тип нисходящего канала расширения LAN FortiExtender [порт/VAP]. Варианты:
|
|
vap string |
VAP нисходящего канала расширения LAN FortiExtender. Источник: extension-controller.extender-vap.name. |
|
vids list / elements=dictionary |
VID нисходящего канала расширения LAN FortiExtender. |
|
vid integer / обязательный |
Введите номера VID (1–4089), разделяя их пробелами. Допускается до 50 VID. См. <a href=’#notes’>Примечания</a>. |
|
ipsec_tunnel string |
Имя туннеля IPsec. |
|
link_loadbalance string |
Стратегия балансировки нагрузки каналов расширения LAN. Варианты:
|
|
traffic_split_services list / elements=dictionary |
Настройка интерфейса разделения трафика FortiExtender для расширения LAN. |
|
address string |
Выбор адреса. Источник: firewall.address.name. |
|
name string / обязательный |
Имя записи разделения туннеля расширения LAN FortiExtender. |
|
service string |
Выбор службы. Источник: firewall.service.custom.name. |
|
vsdb string |
Указать, должен ли трафик потокового видео проходить через локальную WAN-сеть [включить/отключить]. Варианты:
|
|
login_password string |
Задать пароль администратора управляемого экстендера. |
|
login_password_change string |
Изменить или сбросить пароль администратора управляемого экстендера (yes, default или no). Варианты:
|
|
model string |
Модель. Варианты:
|
|
name string / required |
Имя профиля FortiExtender. |
|
wifi dictionary |
Конфигурация Wi-Fi FortiExtender. |
|
country string |
Страна, в которой будет работать это устройство FEX. Варианты:
|
|
radio_1 dictionary |
Конфигурация радиомодуля 1 для Wi-Fi 2,4 ГГц |
|
band string |
Выбор диапазона Wi-Fi: 2,4 ГГц / 5 ГГц. Варианты:
|
|
bandwidth string |
Ширина канала Wi-Fi. Варианты:
|
|
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. Варианты:
|
|
channel list / elements=string |
Каналы Wi-Fi. Варианты:
|
|
extension_channel string |
Расширенный канал Wi-Fi. Варианты:
|
|
guard_interval string |
Защитный интервал Wi-Fi. Варианты:
|
|
lan_ext_vap string |
VAP расширения LAN для Wi-Fi. Выберите только один 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) / Client (режим WAN). Варианты:
|
|
operating_standard string |
Стандарт Wi-Fi. Варианты:
|
|
power_level integer |
Уровень мощности Wi-Fi в процентах (0–100, 0 = автоматически). |
|
set_80211d string |
Включить/отключить Wi-Fi 802.11d. Варианты:
|
|
status string |
Включить/отключить радиомодуль Wi-Fi. Варианты:
|
|
radio_2 dictionary |
Конфигурация радиомодуля 2 для Wi-Fi 5 ГГц |
|
band string |
Выбор диапазона Wi-Fi: 2,4 ГГц / 5 ГГц. Варианты:
|
|
bandwidth string |
Ширина канала Wi-Fi. Варианты:
|
|
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. Варианты:
|
|
channel list / elements=string |
Каналы Wi-Fi. Варианты:
|
|
extension_channel string |
Расширенный канал Wi-Fi. Варианты:
|
|
guard_interval string |
Защитный интервал Wi-Fi. Варианты:
|
|
lan_ext_vap string |
VAP расширения LAN для Wi-Fi. Выберите только один 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) / Client (режим WAN). Варианты:
|
|
operating_standard string |
Стандарт работы Wi-Fi. Варианты:
|
|
power_level integer |
Уровень мощности Wi-Fi в процентах (0–100, 0 = автоматически). |
|
set_80211d string |
Включить/отключить Wi-Fi 802.11d. Варианты:
|
|
status string |
Включить/отключить радиомодуль Wi-Fi. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операций с элементами. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi.
- Модуль поддерживает check_mode.
Примеры
- 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"
multiple_PDN: "disable"
pdn1_dataplan: "<your_own_value> (source extension-controller.dataplan.name)"
pdn2_dataplan: "<your_own_value> (source extension-controller.dataplan.name)"
pdn3_dataplan: "<your_own_value> (source extension-controller.dataplan.name)"
pdn4_dataplan: "<your_own_value> (source extension-controller.dataplan.name)"
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"
multiple_PDN: "disable"
pdn1_dataplan: "<your_own_value> (source extension-controller.dataplan.name)"
pdn2_dataplan: "<your_own_value> (source extension-controller.dataplan.name)"
pdn3_dataplan: "<your_own_value> (source extension-controller.dataplan.name)"
pdn4_dataplan: "<your_own_value> (source extension-controller.dataplan.name)"
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_71"
phone_number: "<your_own_value>"
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: "<your_own_value> (source system.interface.name)"
backhaul_ip: "<your_own_value>"
downlinks:
-
name: "default_name_92"
port: "port1"
pvid: "1"
type: "port"
vap: "<your_own_value> (source extension-controller.extender-vap.name)"
vids:
-
vid: "<you_own_value>"
ipsec_tunnel: "<your_own_value>"
link_loadbalance: "activebackup"
traffic_split_services:
-
address: "<your_own_value> (source firewall.address.name)"
name: "default_name_103"
service: "<your_own_value> (source firewall.service.custom.name)"
vsdb: "disable"
login_password: "<your_own_value>"
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: "<your_own_value> (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: "<your_own_value> (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"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_extension_controller_extender_profile_module.html