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. Указание на исправление изменит поведение на использование HTTP PATCH. |
| avi_credentials (добавлен в 2.5) | Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в контроллер Avi. | |
| cc_emails | Уведомления копируются в список получателей электронной почты, разделенных запятыми. | |
| controller | Значение по умолчанию: | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная среды AVI_CONTROLLER. |
| description | Определяемое пользователем описание объекта. | |
| name обязательно | Наглядное имя службы уведомлений по электронной почте. | |
| password | Значение по умолчанию: | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная среды AVI_PASSWORD. |
| state |
| Состояние, которое должно быть применено к сущности. |
| tenant | Значение по умолчанию: admin | Имя домена, используемое для всех вызовов API Avi и контекста объекта. |
| tenant_ref | Это ссылка на объект типа домена. | |
| tenant_uuid | Значение по умолчанию: | Уникальный идентификатор домена, используемый для всех вызовов API Avi и контекста объекта. |
| to_emails обязательно | Уведомления отправляются в список получателей электронной почты, разделенных запятыми. | |
| url | URL контроллера Avi объекта. | |
| username | Значение по умолчанию: | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию - переменная среды AVI_USERNAME. |
| uuid | Уникальный идентификатор объекта. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на 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 | success, changed | Объект AlertEmailConfig (api/alertemailconfig) |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- 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.5/modules/avi_alertemailconfig_module.html