avi_poolgroupdeploymentpolicy – Модуль для настройки объекта PoolGroupDeploymentPolicy Avi RESTful
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта PoolGroupDeploymentPolicy
- Дополнительные примеры см. на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context - Добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | |
| api_version - | По умолчанию: "16.4.4" | Версия API Avi, используемая для API Avi и объектов. |
| auto_disable_old_prod_pools boolean |
| Автоматически отключит старые производственные пулы после появления нового кандидата для производства. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| 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 Credentials, который можно использовать вместо перечисления данных входа в систему контроллера Avi. | |
| cloud_ref - | Ссылка на объект типа cloud. | |
| 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. Единицы (RATIO). | |
| tenant - | По умолчанию: "admin" | Имя клиента, используемое для всех вызовов API Avi и контекста объекта. |
| tenant_ref - | Ссылка на объект типа клиент. | |
| tenant_uuid - | По умолчанию: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. |
| test_traffic_ratio_rampup - | Отношение трафика, который отправляется в тестовый пул. Тестовое отношение 100 означает сине-зеленое. Допустимые значения — 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
avi_poolgroupdeploymentpolicy:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_poolgroupdeploymentpolicy
Значения возврата
Общие значения возврата документированы здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменилось | Объект PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом 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_poolgroupdeploymentpolicy_module.html