Модуль fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_alert — Список уведомлений об SMS-оповещениях.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_alert.
Добавлена в fortinet.fortimanager 2.1.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, используя источники данных, перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в True только в случае расхождений между схемой модуля и структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
extender-profile строка | Устарело, используйте «extender_profile» |
extender_profile строка | Параметр (extender-profile) в запрошенном URL. |
extendercontroller_extenderprofile_cellular_smsnotification_alert словарь | Настройка параметров верхнего уровня. |
|
data_exhausted строка |
Устарело, переименуйте на data_exhausted. Строка отображения при исчерпании данных. |
|
fgt_backup_mode_switch строка |
Устарело, переименуйте на fgt_backup_mode_switch. Строка отображения при переключении резервного режима FortiGate. |
|
low_signal_strength строка |
Устарело, переименуйте на low_signal_strength. Строка отображения при низкой силе сигнала. |
|
mode_switch строка |
Устарело, переименуйте на mode_switch. Строка отображения при переключении режима. |
|
os_image_fallback строка |
Устарело, переименуйте на os_image_fallback. Строка отображения при возвращении к предыдущей ОС. |
|
session_disconnect строка |
Устарело, переименуйте на session_disconnect. Строка отображения при разъединении сеанса. |
|
system_reboot строка |
Устарело, переименуйте на system_reboot. Строка отображения при перезагрузке системы. |
forticloud_access_token строка | Авторизует Ansible-клиент с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список кодов rc, по которым условия завершения выполнение будут переопределены. |
rc_succeeded список / элементы=целое | Список кодов rc, по которым условия успешного завершения будут переопределены. |
workspace_locking_adom строка | ADOM для блокировки FortiManager в режиме рабочей области; значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout целое | Максимальное время ожидания (в секундах) до освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: SMS alert list.
fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_alert:
# 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>
extender_profile: <your own value>
extendercontroller_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 словарь | Результат запроса. Возвращается: всегда |
|
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_extendercontroller_extenderprofile_cellular_smsnotification_alert_module.html
