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 |
| Автоматически отключает старые производственные пулы после появления нового кандидата. Значение по умолчанию, если не указано в 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 Controller. | |
| 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. Единицы (СООТНОШЕНИЕ). | |
| tenant | Значение по умолчанию: admin | Имя клиента, используемое для всех вызовов API Avi и контекста объекта. |
| tenant_ref | Ссылка на объект типа tenant. | |
| 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 | Настроенный веб-хук с 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 dict | success, changed | Объект PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- Гaurav 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_poolgroupdeploymentpolicy_module.html