модуль fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile — настройка профиля расширителя FortiExtender.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile.
Добавлено в fortinet.fortimanager 2.2.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
extensioncontroller_extenderprofile dictionary | Набор параметров верхнего уровня. |
|
_is_factory_setting string |
Является ли настройка заводской. Варианты:
|
|
allowaccess list / elements=string |
Управление доступом к управляемому расширителю. Варианты:
|
|
bandwidth_limit псевдонимы: bandwidth-limit integer |
Ограничение пропускной способности расширения LAN FortiExtender |
|
cellular dictionary |
Сотовая связь. |
|
controller_report псевдонимы: controller-report dictionary |
Отчет контроллера. |
|
interval integer |
Интервал отправки отчета контроллера. |
|
signal_threshold псевдонимы: signal-threshold integer |
Пороговый уровень сигнала для отчета контроллера. |
|
status string |
Состояние отчета контроллера FortiExtender. Варианты:
|
|
dataplan any |
(список) Названия тарифных планов передачи данных. |
|
modem1 dictionary |
Модем 1. |
|
auto_switch псевдонимы: auto-switch dictionary |
Автоматическое переключение. |
|
dataplan string |
Автоматическое переключение на основе использования данных. Варианты:
|
|
disconnect string |
Автоматическое переключение при отключении. Варианты:
|
|
disconnect_period псевдонимы: disconnect-period integer |
Автоматическое переключение на основе периода отключения. |
|
disconnect_threshold псевдонимы: disconnect-threshold integer |
Автоматическое переключение на основе порогового значения отключений. |
|
signal string |
Автоматическое переключение на основе уровня сигнала. Варианты:
|
|
switch_back псевдонимы: switch-back list / elements=string |
Автоматическое переключение с несколькими вариантами возвратного переключения. Варианты:
|
|
switch_back_time псевдонимы: switch-back-time string |
Автоматическое переключение на предпочтительную SIM-карту/оператора в указанное время UTC |
|
switch_back_timer псевдонимы: switch-back-timer integer |
Автоматическое переключение на предпочтительную SIM-карту/оператора по истечении заданного времени |
|
conn_status псевдонимы: conn-status integer |
Состояние подключения. |
|
default_sim псевдонимы: default-sim string |
Выбор SIM-карты по умолчанию. Варианты:
|
|
gps string |
Включение или отключение GPS FortiExtender. Варианты:
|
|
modem_id псевдонимы: modem-id integer |
Идентификатор модема. |
|
multiple_PDN псевдонимы: multiple-PDN string |
Включение или отключение нескольких PDN. Варианты:
|
|
pdn1_dataplan псевдонимы: pdn1-dataplan any |
(список) Тарифный план PDN1. |
|
pdn2_dataplan псевдонимы: pdn2-dataplan any |
(список) Тарифный план PDN2. |
|
pdn3_dataplan псевдонимы: pdn3-dataplan any |
(список) Тарифный план PDN3. |
|
pdn4_dataplan псевдонимы: pdn4-dataplan any |
(список) Тарифный план PDN4. |
|
preferred_carrier псевдонимы: preferred-carrier string |
Предпочтительный оператор связи. |
|
redundant_intf псевдонимы: redundant-intf string |
Резервный интерфейс. |
|
redundant_mode псевдонимы: redundant-mode string |
Режим FortiExtender. Варианты:
|
|
sim1_pin псевдонимы: sim1-pin string |
SIM-карта Варианты:
|
|
sim1_pin_code псевдонимы: sim1-pin-code any |
(список) SIM-карта |
|
sim2_pin псевдонимы: sim2-pin string |
SIM-карта Варианты:
|
|
sim2_pin_code псевдонимы: sim2-pin-code any |
(список) SIM-карта |
|
modem2 dictionary |
Модем 2. |
|
auto_switch псевдонимы: auto-switch dictionary |
Автоматическое переключение. |
|
dataplan string |
Автоматическое переключение на основе использования данных. Варианты:
|
|
disconnect string |
Автоматическое переключение при отключении. Варианты:
|
|
disconnect_period псевдонимы: disconnect-period integer |
Автоматическое переключение на основе периода отключения. |
|
disconnect_threshold псевдонимы: disconnect-threshold integer |
Автоматическое переключение на основе порогового значения отключений. |
|
signal string |
Автоматическое переключение на основе уровня сигнала. Варианты:
|
|
switch_back псевдонимы: switch-back list / elements=string |
Автоматическое переключение с несколькими вариантами возвратного переключения. Варианты:
|
|
switch_back_time псевдонимы: switch-back-time string |
Автоматическое переключение на предпочтительную SIM-карту/оператора в указанное время UTC |
|
switch_back_timer aliases: switch-back-timer integer |
Автоматически переключиться на предпочтительную SIM-карту/оператора по истечении заданного времени |
|
conn_status aliases: conn-status integer |
Состояние подключения. |
|
default_sim aliases: default-sim string |
Выбор SIM-карты по умолчанию. Варианты:
|
|
gps string |
Включение или отключение GPS в FortiExtender. Варианты:
|
|
modem_id aliases: modem-id integer |
Идентификатор модема. |
|
multiple_PDN aliases: multiple-PDN string |
Включение или отключение нескольких PDN. Варианты:
|
|
pdn1_dataplan aliases: pdn1-dataplan any |
(список) План передачи данных PDN1. |
|
pdn2_dataplan aliases: pdn2-dataplan any |
(список) План передачи данных PDN2. |
|
pdn3_dataplan aliases: pdn3-dataplan any |
(список) План передачи данных PDN3. |
|
pdn4_dataplan aliases: pdn4-dataplan any |
(список) План передачи данных PDN4. |
|
preferred_carrier aliases: preferred-carrier string |
Предпочтительный оператор связи. |
|
redundant_intf aliases: redundant-intf string |
Резервный интерфейс. |
|
redundant_mode aliases: redundant-mode string |
Режим FortiExtender. Варианты:
|
|
sim1_pin aliases: sim1-pin string |
SIM-карта Варианты:
|
|
sim1_pin_code aliases: sim1-pin-code any |
(список) SIM-карта |
|
sim2_pin aliases: sim2-pin string |
SIM-карта Варианты:
|
|
sim2_pin_code aliases: sim2-pin-code any |
(список) SIM-карта |
|
sms_notification aliases: sms-notification dictionary |
Уведомления SMS. |
|
alert dictionary |
Предупреждение. |
|
data_exhausted aliases: data-exhausted string |
Текст для отображения при исчерпании лимита данных. |
|
fgt_backup_mode_switch aliases: fgt-backup-mode-switch string |
Текст для отображения при переключении режима резервирования FortiGate. |
|
low_signal_strength aliases: low-signal-strength string |
Текст для отображения при низком уровне сигнала. |
|
mode_switch aliases: mode-switch string |
Текст для отображения при переключении режима. |
|
os_image_fallback aliases: os-image-fallback string |
Текст для отображения при возврате к предыдущему образу ОС. |
|
session_disconnect aliases: session-disconnect string |
Текст для отображения при отключении сеанса. |
|
system_reboot aliases: system-reboot string |
Текст для отображения при перезагрузке системы. |
|
receiver list / elements=dictionary |
Получатель. |
|
alert list / elements=string |
Несколько параметров предупреждений. Варианты:
|
|
name string |
Имя получателя SMS-уведомлений FortiExtender. |
|
phone_number aliases: phone-number string |
Номер телефона получателя. |
|
status string |
Состояние получателя SMS-уведомлений. Варианты:
|
|
status string |
Состояние SMS-уведомлений FortiExtender. Варианты:
|
|
enforce_bandwidth aliases: enforce-bandwidth string |
Включение или отключение ограничения пропускной способности интерфейса расширения LAN. Варианты:
|
|
extension string |
Параметр расширения. Варианты:
|
|
id integer / обязательный |
Идентификатор. |
|
lan_extension aliases: lan-extension dictionary |
Расширение LAN. |
|
backhaul list / elements=dictionary |
Канал связи с основной сетью. |
|
health_check_fail_cnt aliases: health-check-fail-cnt integer |
Количество сбоев, после которого канал считается недоступным |
|
health_check_interval aliases: health-check-interval integer |
Интервал проверки работоспособности в секундах |
|
health_check_probe_cnt aliases: health-check-probe-cnt integer |
Количество проб проверки работоспособности, отправляемых за один интервал |
|
health_check_probe_tm aliases: health-check-probe-tm integer |
Тайм-аут пробы проверки работоспособности в секундах |
|
health_check_recovery_cnt aliases: health-check-recovery-cnt integer |
Количество успешных проверок, после которого канал считается доступным |
|
name string |
Имя канала связи с основной сетью расширения LAN FortiExtender. |
|
port string |
Порт восходящего канала FortiExtender. Варианты:
|
|
role string |
Порт восходящего канала FortiExtender. Варианты:
|
|
weight integer |
Параметр веса WRR. |
|
backhaul_interface aliases: backhaul-interface string |
Интерфейс фазы 1 IPsec. |
|
backhaul_ip aliases: backhaul-ip string |
IPv4-адрес/FQDN фазы 1 IPsec. |
|
downlinks list / elements=dictionary |
Нисходящие каналы. |
|
name string |
Имя записи конфигурации нисходящего канала расширения LAN FortiExtender. |
|
port string |
Порт нисходящего канала расширения LAN FortiExtender. Варианты:
|
|
pvid integer |
PVID нисходящего канала расширения LAN FortiExtender. |
|
type string |
Тип нисходящего канала расширения LAN FortiExtender [port/vap]. Варианты:
|
|
vap any |
(список) VAP нисходящего канала расширения LAN FortiExtender. |
|
vids any |
(список) VID нисходящего канала расширения LAN FortiExtender. |
|
ipsec_tunnel aliases: ipsec-tunnel string |
Имя туннеля IPsec. |
|
link_loadbalance aliases: link-loadbalance string |
Стратегия балансировки нагрузки каналов расширения LAN. Варианты:
|
|
traffic_split_services aliases: traffic-split-services list / elements=dictionary |
Службы распределения трафика. |
|
address any |
(список) Выбор адреса. |
|
name string |
Имя записи разделения туннеля расширения LAN FortiExtender. |
|
service any |
(список) Выбор службы. |
|
vsdb string |
Выбор vsdb [включить/отключить]. Варианты:
|
|
login_password aliases: login-password any |
(список) Установка пароля администратора для управляемых расширителей. |
|
login_password_change aliases: login-password-change string |
Изменение или сброс пароля администратора управляемого расширителя Варианты:
|
|
model string |
Модель. Варианты:
|
|
name string |
Имя профиля FortiExtender. |
|
wifi dictionary |
Wi-Fi. |
|
country string |
Страна, в которой будет работать это устройство FEX Варианты:
|
|
DFS string |
Включение/отключение каналов DFS радиомодуля Wi-Fi 5G. Варианты:
|
|
radio_1 aliases: radio-1 dictionary |
Радиомодуль 1. |
|
band string |
Выбор диапазона Wi-Fi 2. Варианты:
|
|
bandwidth string |
Ширина канала Wi-Fi. Варианты:
|
|
beacon_interval aliases: beacon-interval integer |
Интервал маяковых кадров Wi-Fi в миллисекундах |
|
bss_color aliases: bss-color integer |
Wi-Fi 802. |
|
bss_color_mode aliases: bss-color-mode string |
Wi-Fi 802. Варианты:
|
|
channel list / elements=string |
Каналы Wi-Fi. Варианты:
|
|
d80211d aliases: 80211d string |
Включение/отключение Wi-Fi 802. Варианты:
|
|
extension_channel aliases: extension-channel string |
Дополнительный канал Wi-Fi. Варианты:
|
|
guard_interval aliases: guard-interval string |
Защитный интервал Wi-Fi. Варианты:
|
|
lan_ext_vap aliases: lan-ext-vap any |
(список) VAP расширения LAN Wi-Fi. |
|
local_vaps aliases: local-vaps any |
(список) Локальный VAP Wi-Fi. |
|
max_clients aliases: max-clients integer |
Максимальное количество клиентов радиомодуля Wi-Fi |
|
mode string |
Режим точки доступа радиомодуля Wi-Fi Варианты:
|
|
operating_standard aliases: operating-standard string |
Стандарт Wi-Fi. Варианты:
|
|
power_level aliases: power-level integer |
Уровень мощности Wi-Fi в процентах |
|
radio_id псевдонимы: radio-id integer |
Идентификатор радиомодуля. |
|
status string |
Включить/отключить радиомодуль Wi-Fi. Варианты:
|
|
radio_2 псевдонимы: radio-2 dictionary |
Радиомодуль 2. |
|
band string |
Выбор диапазона Wi-Fi 2. Варианты:
|
|
bandwidth string |
Ширина канала Wi-Fi. Варианты:
|
|
beacon_interval псевдонимы: beacon-interval integer |
Интервал маяковых кадров Wi-Fi в миллисекундах |
|
bss_color псевдонимы: bss-color integer |
Wi-Fi 802. |
|
bss_color_mode псевдонимы: bss-color-mode string |
Wi-Fi 802. Варианты:
|
|
channel list / элементы=string |
Каналы Wi-Fi. Варианты:
|
|
d80211d псевдонимы: 80211d string |
Включить/отключить Wi-Fi 802. Варианты:
|
|
extension_channel псевдонимы: extension-channel string |
Расширенный канал Wi-Fi. Варианты:
|
|
guard_interval псевдонимы: guard-interval string |
Защитный интервал Wi-Fi. Варианты:
|
|
lan_ext_vap псевдонимы: lan-ext-vap any |
(список) Точка доступа VAP Wi-Fi LAN-Extension. |
|
local_vaps псевдонимы: local-vaps any |
(список) Локальная точка доступа VAP Wi-Fi. |
|
max_clients псевдонимы: max-clients integer |
Максимальное количество клиентов радиомодуля Wi-Fi |
|
mode string |
Режим радиомодуля Wi-Fi AP Варианты:
|
|
operating_standard псевдонимы: operating-standard string |
Стандарт работы Wi-Fi. Варианты:
|
|
power_level псевдонимы: power-level integer |
Уровень мощности Wi-Fi в процентах |
|
radio_id псевдонимы: radio-id integer |
Идентификатор радиомодуля. |
|
status string |
Включить/отключить радиомодуль Wi-Fi. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, для которых переопределяются условия сбоя. |
rc_succeeded list / элементы=integer | Список кодов rc, для которых переопределяются условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание создать, обновить или удалить объект. Варианты:
|
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы, например «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании появляются предупреждения об устаревании. Это предупреждение можно игнорировать, задав deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля завершается с ошибкой, если возвращается ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: FortiExtender extender profile configuration.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
extensioncontroller_extenderprofile:
id: 0 # Required variable, integer
# 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>
# multiple_PDN: <value in [disable, enable]>
# pdn1_dataplan: <list or string>
# pdn2_dataplan: <list or string>
# pdn3_dataplan: <list or string>
# pdn4_dataplan: <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>
# multiple_PDN: <value in [disable, enable]>
# pdn1_dataplan: <list or string>
# pdn2_dataplan: <list or string>
# pdn3_dataplan: <list or string>
# pdn4_dataplan: <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]>
# lan_extension:
# backhaul:
# - name: <string>
# port: <value in [wan, lte1, lte2, ...]>
# role: <value in [primary, secondary]>
# weight: <integer>
# health_check_fail_cnt: <integer>
# health_check_interval: <integer>
# health_check_probe_cnt: <integer>
# health_check_probe_tm: <integer>
# health_check_recovery_cnt: <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>
# vids: <list or integer>
# traffic_split_services:
# - address: <list or string>
# name: <string>
# service: <list or string>
# vsdb: <value in [disable, enable]>
# 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]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный запрошенный URL. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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/fortimanager/fmgr_extensioncontroller_extenderprofile_module.html