community.network.avi_alertemailconfig – Модуль для настройки объекта AlertEmailConfig Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.avi_alertemailconfig.
Описание
- Этот модуль используется для настройки объекта AlertEmailConfig.
- Дополнительные примеры на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| avi_api_patch_op строка |
| Операция исправления для использования при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или доменное имя контроллера | ||
| csrftoken строка | Маркер csrf контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password строка | Пароль пользователя Avi в контроллере Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с маркером csrf | ||
| tenant строка | По умолчанию: "admin" | Домен контроллера Avi | |
| tenant_uuid строка | UUID домена контроллера Avi | ||
| timeout строка | По умолчанию: 300 | Таймаут запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact булево |
| Отключает кеширование информации о сессии 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 Network см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create AlertEmailConfig object
community.network.avi_alertemailconfig:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_alertemailconfig
Возвращаемые значения
Общие возвращаемые значения описаны в этом месте. Ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращено | Описание |
|---|---|---|
| obj словарь | успех, изменён | Объект AlertEmailConfig (api/alertemailconfig) |
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_alertemailconfig_module.html
