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 bool |
| Автоматически отключит старые пулы производства, как только появится новый кандидат на производство. Значение по умолчанию, если не указано в 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, который можно использовать вместо перечисления данных входа в систему контроллера 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. | |
| 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
avi_poolgroupdeploymentpolicy:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_poolgroupdeploymentpolicy
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj dict | success, changed | Объект PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) |
Статус
Данный модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/avi_poolgroupdeploymentpolicy_module.html
