fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_smsnotification_alert module – список SMS-оповещений.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_smsnotification_alert.
Добавлено в 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_smsnotification_alert dictionary | Набор параметров верхнего уровня. |
|
data_exhausted псевдонимы: data-exhausted string |
Строка для отображения при исчерпании трафика. |
|
fgt_backup_mode_switch псевдонимы: fgt-backup-mode-switch string |
Строка для отображения при переключении FortiGate в режим резервирования. |
|
low_signal_strength псевдонимы: low-signal-strength string |
Строка для отображения при низком уровне сигнала. |
|
mode_switch псевдонимы: mode-switch string |
Строка для отображения при переключении режима. |
|
os_image_fallback псевдонимы: os-image-fallback string |
Строка для отображения при возврате к предыдущему образу ОС. |
|
session_disconnect псевдонимы: session-disconnect string |
Строка для отображения при отключении сеанса. |
|
system_reboot псевдонимы: system-reboot string |
Строка для отображения при перезагрузке системы. |
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Метод, переопределяющий метод базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note 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.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: SMS alert list.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_smsnotification_alert:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
extender_profile: <your own value>
extensioncontroller_extenderprofile_cellular_smsnotification_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>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса к API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=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_smsnotification_alert_module.html
