community.network.avi_poolgroupdeploymentpolicy – Модуль для настройки объекта PoolGroupDeploymentPolicy Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.avi_poolgroupdeploymentpolicy.
Обзор
- Этот модуль используется для конфигурации объекта PoolGroupDeploymentPolicy
- Дополнительные примеры см. на странице https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, который включает текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi, используемая для Avi API и объектов. | |
| auto_disable_old_prod_pools булево |
| Автоматически отключит старые производственные пулы после появления нового кандидата на производство. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| avi_api_patch_op строка |
| Операция исправления, используемая при использовании avi_api_update_method как исправление. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка значения patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера | ||
| csrftoken строка | Маркер csrftoken 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 в качестве факта. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | |
| description строка | Определяемая пользователем строка описания объекта. | ||
| evaluation_duration строка | Продолжительность периода оценки для автоматического развертывания. Допустимые значения — 60–86400. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300. | ||
| name строка / обязательно | Имя политики развертывания группы пулов. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. | |
| rules строка | Список pgdeploymentrule. | ||
| scheme строка | Схема развертывания. Варианты перечисления — BLUE_GREEN, CANARY. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как BLUE_GREEN. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| target_test_traffic_ratio строка | Целевое соотношение трафика перед тем, как пул станет производственным. Допустимые значения — 1–100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 100. | ||
| tenant строка | По умолчанию: "admin" | Имя тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Ссылка на объект типа tenant. | ||
| tenant_uuid строка | По умолчанию: "" | UUID тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| test_traffic_ratio_rampup строка | Соотношение трафика, отправляемого в тестовый пул. Тестовое соотношение 100 означает blue green. Допустимые значения — 1–100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 100. | ||
| url строка | URL контроллера Avi для объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | |
| uuid строка | Uuid политики развертывания группы пулов. | ||
| webhook_ref строка | Настроенный webhook с URL-адресом, который контроллер Avi вернет информацию о группе пулов, старом и новом пуле, и текущем развертывании результаты правил. Это ссылка на объект типа webhook. Поле введено в версии 17.1.1. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create PoolGroupDeploymentPolicy object
community.network.avi_poolgroupdeploymentpolicy:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_poolgroupdeploymentpolicy
Возвращаемые значения
Общие возвращаемые значения описаны на странице здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменение | Объект PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) |
Авторы
- 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.10/collections/community/network/avi_poolgroupdeploymentpolicy_module.html
