Модуль fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_receiver — список получателей SMS-уведомлений.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать ее в плейбуке, укажите: fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_receiver.
Добавлено в fortinet.fortimanager 2.1.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. |
extendercontroller_extenderprofile_cellular_smsnotification_receiver dictionary | Заданные параметры верхнего уровня. |
|
alert list / элементы=string |
Несколько параметров оповещения. Варианты:
|
|
name string / обязательный |
Имя получателя SMS-уведомлений FortiExtender. |
|
phone_number псевдонимы: phone-number string |
Номер телефона получателя. |
|
status string |
Статус получателя SMS-уведомлений. Варианты:
|
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 | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state 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.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: SMS notification receiver list.
fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_receiver:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
extender_profile: <your own value>
state: present # <value in [present, absent]>
extendercontroller_extenderprofile_cellular_smsnotification_receiver:
name: "your value" # Required variable, string
# alert: ["system-reboot", "data-exhausted", "session-disconnect",
# "low-signal-strength", "mode-switch", "os-image-fallback",
# "fgt-backup-mode-switch"]
# phone_number: <string>
# status: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_extendercontroller_extenderprofile_cellular_smsnotification_receiver_module.html
