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 для использования с Avi API и объектами. |
| 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 см. на странице 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 dict | success, changed | Объект Webhook (api/webhook) |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/avi_webhook_module.html
