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 как patch. |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта - HTTP PUT. Установка на patch переопределит это поведение, чтобы использовать 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. | |
| 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 словарь | успех, изменение | Объект AlertEmailConfig (api/alertemailconfig) |
Статус
- Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Gaurav Rastogi (@grastogi23) <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.8/modules/avi_alertemailconfig_module.html