fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile модуль — Настройка профиля расширителя FortiExtender.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/отключить ведение журнала для задачи. Варианты:
|
extensioncontroller_extenderprofile словарь | Настройка верхнего уровня параметров. |
|
_is_factory_setting строка |
Является ли фабричным значением. Варианты:
|
|
allowaccess список / элементы=строка |
Управление доступом к управляемому расширителю. Варианты:
|
|
bandwidth_limit целое число |
Устарело, пожалуйста, переименуйте на bandwidth_limit. Пропускная способность расширения FortiExtender LAN. |
|
cellular словарь |
Мобильная связь. |
|
controller_report словарь |
Устарело, пожалуйста, переименуйте на controller_report. Отчет контроллера. |
|
interval целое число |
Интервал отчета контроллера. |
|
signal_threshold целое число |
Устарело, пожалуйста, переименуйте на signal_threshold. Порог сигнала отчета контроллера. |
|
status строка |
Статус отчета контроллера FortiExtender. Варианты:
|
|
dataplan любой |
(список) Имена планов данных. |
|
modem1 словарь |
Модем1. |
|
auto_switch словарь |
Устарело, пожалуйста, переименуйте на auto_switch. Автоматический переход. |
|
dataplan строка |
Автоматический переход на основе использования данных. Варианты:
|
|
disconnect строка |
Автоматический переход при отключении. Варианты:
|
|
disconnect_period целое число |
Устарело, пожалуйста, переименуйте на disconnect_period. Автоматический переход по интервалу отключения. |
|
disconnect_threshold целое число |
Устарело, пожалуйста, переименуйте на disconnect_threshold. Автоматический переход по порогу отключения... |
|
signal string |
Автоматическое переключение на основе силы сигнала. Choices:
|
|
switch-back list / elements=string |
Устарело, переименуйте в switch_back. Автоматическое переключение с несколькими вариантами обратного переключения. Choices:
|
|
switch-back-time string |
Устарело, переименуйте в switch_back_time. Автоматическое переключение на предпочтительную SIM-карту/оператора… |
|
switch-back-timer integer |
Устарело, переименуйте в switch_back_timer. Автоматическое переключение на предпочтительную SIM-карту/оператора… |
|
conn-status integer |
Устарело, переименуйте в conn_status. Статус соединения. |
|
default-sim string |
Устарело, переименуйте в default_sim. Выбор SIM-карты по умолчанию. Choices:
|
|
gps string |
Включение/отключение GPS FortiExtender. Choices:
|
|
modem-id integer |
Устарело, переименуйте в modem_id. ID модема. |
|
preferred-carrier string |
Устарело, переименуйте в preferred_carrier. Предпочтительный оператор. |
|
redundant-intf string |
Устарело, переименуйте в redundant_intf. Резервный интерфейс. |
|
redundant-mode string |
Устарело, переименуйте в redundant_mode. Режим FortiExtender. Choices:
|
|
sim1-pin string |
Устарело, переименуйте в sim1_pin. SIM Choices:
|
|
sim1-pin-code any |
(list) Устарело, переименуйте в sim1_pin_code. SIM |
|
sim2-pin string |
Устарело, переименуйте в sim2_pin. SIM Choices:
|
|
sim2-pin-code any |
(list) Устарело, переименуйте в sim2_pin_code. SIM |
|
modem2 dictionary |
Модем2. |
|
auto-switch dictionary |
Устарело, переименуйте в auto_switch. Автоматическое переключение. |
|
dataplan string |
Автоматическое переключение на основе использования данных. Choices:
|
|
disconnect string |
Автоматическое переключение при отключении. Choices:
|
|
disconnect-period integer |
Устарело, переименуйте в disconnect_period. Автоматическое переключение на основе периода отключения. |
|
disconnect-threshold integer |
Устарело, переименуйте в disconnect_threshold. Автоматическое переключение на основе порогового значения отключения… |
|
signal string |
Автоматическое переключение на основе уровня сигнала. Choices:
|
|
switch-back list / elements=string |
Устарело, переименуйте в switch_back. Автоматическое переключение с несколькими вариантами переключения назад. Choices:
|
|
switch-back-time string |
Устарело, переименуйте в switch_back_time. Автоматическое переключение на предпочтительную SIM-карту/оператора… |
|
switch-back-timer integer |
Устарело, переименуйте в switch_back_timer. Автоматическое переключение на предпочтительную SIM-карту/оператора… |
|
conn-status integer |
Устарело, переименуйте в conn_status. Состояние соединения. |
|
default-sim string |
Устарело, переименуйте в default_sim. Выбор SIM-карты по умолчанию. Choices:
|
|
gps string |
Включение/выключение GPS FortiExtender. Choices:
|
|
modem-id integer |
Устарело, переименуйте в modem_id. Идентификатор модема. |
|
preferred-carrier string |
Устарело, переименуйте в preferred_carrier. Предпочтительный оператор связи. |
|
redundant-intf string |
Устарело, переименуйте в redundant_intf. Резервный интерфейс. |
|
redundant-mode string |
Устарело, переименуйте в redundant_mode. Режим FortiExtender. Choices:
|
|
sim1-pin string |
Устарело, переименуйте в sim1_pin. SIM Choices:
|
|
sim1-pin-code any |
(list) Устарело, переименуйте в sim1_pin_code. SIM |
|
sim2-pin string |
Устарело, переименуйте в sim2_pin. SIM Choices:
|
|
sim2-pin-code any |
(list) Устарело, переименуйте в sim2_pin_code. SIM |
|
sms-notification dictionary |
Устарело, переименуйте в sms_notification. SMS-уведомление. |
|
alert dictionary |
Предупреждение. |
|
data-exhausted string |
Устарело, пожалуйста, переименуйте на data_exhausted. Строка отображения при исчерпании данных. |
|
fgt-backup-mode-switch string |
Устарело, пожалуйста, переименуйте на fgt_backup_mode_switch. Строка отображения при переключении резервного режима FortiGate… |
|
low-signal-strength string |
Устарело, пожалуйста, переименуйте на low_signal_strength. Строка отображения при низкой силе сигнала. |
|
mode-switch string |
Устарело, пожалуйста, переименуйте на mode_switch. Строка отображения при переключении режима. |
|
os-image-fallback string |
Устарело, пожалуйста, переименуйте на os_image_fallback. Строка отображения при откате к предыдущей… |
|
session-disconnect string |
Устарело, пожалуйста, переименуйте на session_disconnect. Строка отображения при разрыве сессии. |
|
system-reboot string |
Устарело, пожалуйста, переименуйте на system_reboot. Строка отображения при перезагрузке системы. |
|
receiver list / elements=dictionary |
Получатель. |
|
alert list / elements=string |
Множественные варианты оповещения. Варианты:
|
|
name string |
Имя получателя уведомлений по SMS от FortiExtender. |
|
phone-number string |
Устарело, пожалуйста, переименуйте на phone_number. Номер телефона получателя. |
|
status string |
Статус получателя уведомлений по SMS. Варианты:
|
|
status string |
Статус уведомлений по SMS от FortiExtender. Варианты:
|
|
enforce-bandwidth string |
Устарело, пожалуйста, переименуйте на enforce_bandwidth. Включить/выключить принудительное ограничение пропускной способности на интерфейсе расширения LAN. Варианты:
|
|
extension string |
Параметр расширения. Варианты:
|
|
id integer / обязательно |
Идентификатор. |
|
lan-extension dictionary |
Устарело, пожалуйста, переименуйте на lan_extension. Расширение LAN. |
|
backhaul list / elements=dictionary |
Обратный канал. |
|
name string |
Имя обратного канала расширения LAN FortiExtender. |
|
порт строка |
Порт канала связи FortiExtender. Выбор:
|
|
роль строка |
Порт канала связи FortiExtender. Выбор:
|
|
вес целое число |
Параметр веса WRR. |
|
интерфейс-канал-связи строка |
Устарело, пожалуйста, переименуйте на backhaul_interface. Интерфейс фазы 1 IPsec. |
|
ip-канал-связи строка |
Устарело, пожалуйста, переименуйте на backhaul_ip. IPsec фазы 1 IPv4/FQDN. |
|
каналы-выхода список / элементы=словарь |
Каналы выхода. |
|
имя строка |
Имя записи конфигурации канала выхода FortiExtender LAN. |
|
порт строка |
Порт канала выхода FortiExtender LAN. Выбор:
|
|
pvid целое число |
PVID канала выхода FortiExtender LAN. |
|
тип строка |
Тип канала выхода FortiExtender LAN [порт/vap]. Выбор:
|
|
vap любой |
(список) FortiExtender LAN - vap канала выхода. |
|
ipsec-туннель строка |
Устарело, пожалуйста, переименуйте на ipsec_tunnel. Имя туннеля IPsec. |
|
балансировка-нагрузки-канала строка |
Устарело, пожалуйста, переименуйте на link_loadbalance. Стратегия балансировки нагрузки канала LAN. Выбор:
|
|
пароль-логина любой |
(список) Устарело, пожалуйста, переименуйте на login_password. Установите пароль администратора управляемых расширителей. |
|
изменение-пароля-логина строка |
Устарело, пожалуйста, переименуйте на login_password_change. Изменить или сбросить пароль администратора управляемого расширителя. Выбор:
|
|
модель строка |
Модель. Выбор:
|
|
имя строка |
Имя профиля FortiExtender. |
|
wifi словарь |
Wifi. |
|
country string |
Страна, в которой будет работать этот FEX Варианты:
|
|
DFS string |
Вкл./выкл. канала DFS Wi-Fi 5G радио. Варианты:
|
|
radio-1 dictionary |
Устарело, пожалуйста, переименуйте на radio_1. Радио 1. |
|
80211d string |
Устарело, пожалуйста, переименуйте на d80211d. Вкл./выкл. Wi-Fi 802. Варианты:
|
|
band string |
Выбор диапазона Wi-Fi 2. Варианты:
|
|
bandwidth string |
Ширина канала Wi-Fi. Варианты:
|
|
beacon-interval integer |
Устарело, пожалуйста, переименуйте на beacon_interval. Интервал меток Wi-Fi в миллисекундах. |
|
bss-color integer |
Устарело, переименуйте в bss_color. Wi-Fi 802. |
|
bss-color-mode string |
Устарело, переименуйте в bss_color_mode. Wi-Fi 802. Варианты:
|
|
channel list / elements=string |
Wi-Fi каналы. Варианты:
|
|
extension-channel string |
Устарело, переименуйте в extension_channel. Расширительный канал Wi-Fi. Варианты:
|
|
guard-interval string |
Устарело, переименуйте в guard_interval. Защитный интервал Wi-Fi. Варианты:
|
|
lan-ext-vap any |
(список) Устарело, переименуйте в lan_ext_vap. Wi-Fi LAN-расширение VAP. |
|
local-vaps any |
(список) Устарело, переименуйте в local_vaps. Локальный Wi-Fi VAP. |
|
max-clients integer |
Устарело, переименуйте в max_clients. Максимальное количество клиентов Wi-Fi радио. |
|
mode string |
Режим Wi-Fi радио AP Варианты:
|
|
operating-standard string |
Устарело, переименуйте в operating_standard. Стандарт работы Wi-Fi. Варианты:
|
|
power-level integer |
Устарело, переименуйте в power_level. Уровень мощности Wi-Fi в процентах |
|
radio-id integer |
Устарело, переименуйте в radio_id. ID радио. |
|
status string |
Включить/выключить Wi-Fi радио. Варианты:
|
|
radio-2 dictionary |
Устарело, переименуйте в radio_2. Радио 2. |
|
80211d string |
Устарело, переименуйте в d80211d. Включить/выключить Wi-Fi 802. Варианты:
|
|
band string |
Выбор диапазона Wi-Fi 2. Варианты:
|
|
bandwidth string |
Пропускная способность канала Wi-Fi. Варианты:
|
|
beacon-interval integer |
Устарело, пожалуйста, переименуйте на beacon_interval. Интервал сигнала Wi-Fi в миллисекундах |
|
bss-color integer |
Устарело, пожалуйста, переименуйте на bss_color. Wi-Fi 802. |
|
bss-color-mode string |
Устарело, пожалуйста, переименуйте на bss_color_mode. Wi-Fi 802. Варианты:
|
|
channel list / elements=string |
Каналы Wi-Fi. Варианты:
|
|
extension-channel string |
Устарело, пожалуйста, переименуйте на extension_channel. Расширенный канал Wi-Fi. Варианты:
|
|
guard-interval string |
Устарело, пожалуйста, переименуйте на guard_interval. Защитный интервал Wi-Fi. Варианты:
|
|
lan-ext-vap any |
(список) Устарело, пожалуйста, переименуйте на lan_ext_vap. Wi-Fi VAP расширения LAN. |
|
local-vaps any |
(список) Устарело, пожалуйста, переименуйте на local_vaps. Wi-Fi локальный VAP. |
|
max-clients integer |
Устарело, пожалуйста, переименуйте на max_clients. Максимальное количество клиентов Wi-Fi радио |
|
mode string |
Режим Wi-Fi радио AP Варианты:
|
|
operating-standard string |
Устарело, пожалуйста, переименуйте на operating_standard. Стандарт работы Wi-Fi. Варианты:
|
|
power-level integer |
Устарело, пожалуйста, переименуйте на power_level. Уровень мощности Wi-Fi в процентах |
|
radio-id integer |
Устарело, пожалуйста, переименуйте на radio_id. Идентификатор радио. |
|
status string |
Включить/выключить Wi-Fi радио. Варианты:
|
forticloud_access_token string | Авторизовать Ansible-клиент с помощью маркера доступа к API forticloud. |
proposed_method string | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, с которыми условия отказа будут переопределены. |
rc_succeeded список / элементы=целое число | Список кодов rc, по которым будут переопределены условия успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют имя с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- В этом модуле FortiManager поддерживается работа в режиме блокировки рабочего пространства; параметры workspace_locking_adom и workspace_locking_timeout на верхнем уровне помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться сбоем при возвращении ненулевого кода rc. Вы также можете переопределить условия сбоя или успеха с помощью параметров rc_failed и rc_succeeded
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: FortiExtender extender profile configuration.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
extensioncontroller_extenderprofile:
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>
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>
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]>
id: <integer>
lan_extension:
backhaul:
-
name: <string>
port: <value in [wan, lte1, lte2, ...]>
role: <value in [primary, secondary]>
weight: <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>
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 словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на коллекции
© 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/fortimanager/fmgr_extensioncontroller_extenderprofile_module.html