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 для использования с Avi API и объектами. | |
| 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 Controller. | ||
| api_version - | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера | ||
| csrftoken - | Токен csrf контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password - | Пароль пользователя Avi в контроллере Avi | ||
| port - | Порт контроллера Avi | ||
| session_id - | Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken | ||
| tenant - | По умолчанию: "admin" | Тенент контроллера Avi | |
| tenant_uuid - | Уникальный идентификатор UUID клиента | ||
| timeout - | По умолчанию: 300 | Время ожидания запроса контроллера Avi | |
| token - | Токен API контроллера Avi | ||
| username - | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact логическое значение добавлен в 2.6 |
| Отключает кэширование информации о сессии 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 словарь | успех, изменилось | Объект 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.9/modules/avi_alertemailconfig_module.html
