Модуль community.network.avi_webhook – Модуль для настройки объекта Webhook Avi RESTful

Примечание

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

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

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

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

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

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

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

Требования

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

avisdk

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version строка	Версия API Avi, используемая для API Avi и объектов. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, используемая при использовании avi_api_update_method как patch. Варианты: `"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 строка	Маркер csrf 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`
callback_url строка	URL обратного вызова для вебхука. Поле введено в 17.1.1.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
description строка	Поле введено в 17.1.1.
name строка / обязательно	Имя профиля вебхука. Поле введено в 17.1.1.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`

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

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Example to create Webhook object
  community.network.avi_webhook:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_webhook

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
obj словарь	Объект веб-хука (api/webhook) Возвращаемое значение: 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_webhook_module.html