Модуль fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_smsnotification_alert – Список SMS-сообщений об оповещениях.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_smsnotification_alert.
Новое в fortinet.fortimanager 2.2.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
extender-profile строка | Устаревшее, пожалуйста, используйте “extender_profile” |
extender_profile строка | Параметр (extender-profile) в запрошенном URL. |
extensioncontroller_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 строка | Область, которую необходимо заблокировать для 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 помогают в этом.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой код 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_extensioncontroller_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>
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 словарь | Результат запроса. Возвращается: всегда |
|
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_cellular_smsnotification_alert_module.html
