avi_webhook – Модуль для настройки RESTful объекта Webhook Avi
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта Webhook
- больше примеров на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context словарь Добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить одно входное окно и повторно использовать сеанс. | |
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi, которая должна использоваться для API Avi и объектов. |
| 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, который может быть использован вместо перечисления данных входа в Avi контроллер. | |
| callback_url - | URL обратного вызова для веб-хука. Поле добавлено в 17.1.1. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. |
| description - | Поле добавлено в 17.1.1. | |
| name - / обязательно | Имя профиля веб-хука. Поле добавлено в 17.1.1. | |
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. |
| state - |
| Состояние, которое должно быть применено к сущности. |
| tenant строка | По умолчанию: "admin" | Имя домена, используемого для всех вызовов API Avi и контекста объекта. |
| tenant_ref - | Ссылка на объект типа домен. Поле добавлено в 17.1.1. | |
| tenant_uuid строка | По умолчанию: "" | UUID домена, используемого для всех вызовов API Avi и контекста объекта. |
| url - | URL контроллера Avi для объекта. | |
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру 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
avi_webhook:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_webhook
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменённые значения | Объект веб-хука (api/webhook) |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/avi_webhook_module.html
