community.network.avi_alertemailconfig модуль — Модуль для настройки объекта AlertEmailConfig Avi RESTful

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Чтобы использовать его в плейбуке, укажите: community.network.avi_alertemailconfig.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль используется для настройки объекта AlertEmailConfig
дополнительные примеры на https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_alertemailconfig

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст Avi API, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version строка	Версия Avi API, используемая для Avi API и объектов. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, используемая при использовании avi_api_update_method в качестве исправления. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в значение «patch» переопределяет это поведение, чтобы использовать HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в систему контроллера Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
csrftoken строка	Маркер csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
password строка	Пароль пользователя Avi в контроллере Avi
port строка	Порт контроллера Avi
session_id строка	Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с маркёром csrftoken По умолчанию: `""`
tenant строка	Подписчик контроллера Avi По умолчанию: `"admin"`
tenant_uuid строка	UUID подписчика контроллера Avi По умолчанию: `""`
timeout строка	Таймаут запроса контроллера Avi По умолчанию: `300`
token строка	Токен API контроллера Avi По умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact булево	Отключает кеширование информации о сессии Avi в качестве факта. Варианты: `false` ← (по умолчанию) `true`
cc_emails строка	Уведомления отправляются на перечисленные через запятую адреса электронной почты.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
description строка	Пользовательское описание объекта.
name строка / обязательно	Наименование службы уведомлений по электронной почте.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`

state string	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя клиента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа tenant.
tenant_uuid string	UUID клиента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
to_emails string / обязательно	Уведомления отправляются указанным в списке через запятую получателям электронной почты.
url string	URL контроллера Avi для объекта.
username string	Имя пользователя, используемого для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid string	Уникальный идентификатор объекта.

Примечания

Примечание

Дополнительную информацию об использовании 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) Возвращается: success, changed

Авторы

Gaurav Rastogi (@grastogi23)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_alertemailconfig_module.html