модуль fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_modem2_autoswitch — настройка автоматического переключения FortiExtender.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_modem2_autoswitch.
Добавлено в fortinet.fortimanager 2.2.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в случае различий между схемой модуля и структурой API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
extender-profile string | Устарел; используйте «extender_profile» |
extender_profile string | Параметр (extender-profile) в запрошенном URL. |
extensioncontroller_extenderprofile_cellular_modem2_autoswitch dictionary | Набор параметров верхнего уровня. |
|
dataplan string |
Автоматическое переключение на основе использования данных. Варианты:
|
|
disconnect string |
Автоматическое переключение при отключении. Варианты:
|
|
disconnect_period псевдонимы: disconnect-period integer |
Автоматическое переключение на основе периода отключения. |
|
disconnect_threshold псевдонимы: disconnect-threshold integer |
Автоматическое переключение на основе порогового значения отключения. |
|
signal string |
Автоматическое переключение на основе уровня сигнала. Варианты:
|
|
switch_back псевдонимы: switch-back list / элементы=string |
Автоматическое переключение с несколькими вариантами возврата к исходному подключению. Варианты:
|
|
switch_back_time псевдонимы: switch-back-time string |
Автоматическое переключение на предпочтительную SIM-карту/оператора в указанное время UTC |
|
switch_back_timer псевдонимы: switch-back-timer integer |
Автоматическое переключение на предпочтительную SIM-карту/оператора по истечении заданного времени |
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 | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
workspace_locking_adom string | ADOM, который необходимо заблокировать в FortiManager, работающем в режиме рабочей области. Значением может быть global или другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0 все входные аргументы именуются с использованием соглашения underscore (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: FortiExtender auto switch configuration.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_modem2_autoswitch:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
extender_profile: <your own value>
extensioncontroller_extenderprofile_cellular_modem2_autoswitch:
# 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>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_cellular_modem2_autoswitch_module.html
