community.network.avi_webhook – Модуль для настройки объекта Webhook Avi RESTful
Примечание
Этот плагин является частью коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в playbook укажите: community.network.avi_webhook.
Обзор
- Этот модуль используется для настройки объекта Webhook
- больше примеров на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и CSRF-токен. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования Avi API и объектов. | |
| avi_api_patch_op строка |
| Операция обновления для использования при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение для использования HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера | ||
| csrftoken строка | CSRF-токен API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| password строка | Пароль пользователя Avi в контроллере Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken | ||
| tenant строка | По умолчанию: "admin" | Тенент контроллера Avi | |
| tenant_uuid строка | UUID тенента контроллера Avi | ||
| timeout строка | По умолчанию: 300 | Тайм-аут запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact булево |
| Отключает кэширование информации о сеансе 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 см. на странице 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 словарь | success, changed | Объект webhook (api/webhook) |
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_webhook_module.html
