avi_alertemailconfig - Модуль для настройки объекта AlertEmailConfig Avi RESTful
Новое в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта AlertEmailConfig.
- Больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлен в 2.5) | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | |
| api_version | По умолчанию: "16.4.4" | Версия API Avi, используемая для API Avi и объектов. |
| avi_api_patch_op (добавлен в 2.5) |
| Операция исправления, используемая при использовании avi_api_update_method в режиме исправления. |
| avi_api_update_method (добавлен в 2.5) |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в режим patch приведет к использованию HTTP PATCH. |
| avi_credentials (добавлен в 2.5) | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Контроллер. | |
| cc_emails | Уведомления копируются в список получателей электронной почты, разделенных запятыми. | |
| controller | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| description | Пользовательское описание объекта. | |
| name обязательно | Наглядное имя службы уведомлений по электронной почте. | |
| password | По умолчанию: "" | Пароль пользователя Avi в Avi контроллере. Значение по умолчанию — переменная среды AVI_PASSWORD. |
| state |
| Состояние, которое должно быть применено к сущности. |
| tenant | По умолчанию: "admin" | Имя домена, используемое для всех вызовов API Avi и контекста объекта. |
| tenant_ref | Ссылка на объект типа домен. | |
| tenant_uuid | По умолчанию: "" | UUID домена, используемого для всех вызовов API Avi и контекста объекта. |
| to_emails обязательно | Уведомления отправляются в список получателей электронной почты, разделенных запятыми. | |
| url | URL Avi контроллера объекта. | |
| username | По умолчанию: "" | Имя пользователя, используемое для доступа к Avi контроллеру. Значение по умолчанию — переменная среды AVI_USERNAME. |
| uuid | Уникальный идентификатор объекта. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create AlertEmailConfig object
avi_alertemailconfig:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_alertemailconfig
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj dict | успех, изменение | Объект AlertEmailConfig (api/alertemailconfig) |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка и обслуживание модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Gaurav Rastogi (grastogi@avinetworks.com)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/avi_alertemailconfig_module.html