avi_webhook – Модуль для настройки объекта Webhook Avi RESTful
Новое в версии 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 обратного вызова для webhook. Поле добавлено в 17.1.1. | |
| controller - | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная окружения AVI_CONTROLLER. |
| description - | Поле добавлено в 17.1.1. | |
| name - / обязательно | Имя профиля webhook. Поле добавлено в 17.1.1. | |
| password - | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная окружения AVI_PASSWORD. |
| state - |
| Состояние, которое должно быть применено к сущности. |
| tenant - | Значение по умолчанию: "admin" | Имя домена, используемого для всех вызовов API Avi и контекста объекта. |
| tenant_ref - | Ссылка на объект типа tenant. Поле добавлено в 17.1.1. | |
| tenant_uuid - | Значение по умолчанию: "" | UUID домена, используемого для всех вызовов API Avi и контекста объекта. |
| url - | URL контроллера Avi объекта. | |
| username - | Значение по умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию - переменная окружения AVI_USERNAME. |
| uuid - | Uuid профиля webhook. Поле добавлено в 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 словарь | success, changed | Объект webhook (api/webhook) |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Gaurav Rastogi (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.7/modules/avi_webhook_module.html
