avi_alertemailconfig – Модуль для настройки объекта Avi RESTful AlertEmailConfig
Новый в версии 2.4.
Обзор
- Этот модуль используется для конфигурации объекта AlertEmailConfig
- дополнительные примеры см. на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context - добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | |
| api_version - | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. |
| 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 Credentials, который можно использовать вместо перечисления данных входа в контроллер 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 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 словарь | success, changed | Объект AlertEmailConfig (api/alertemailconfig) |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/avi_alertemailconfig_module.html