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, который может быть использован вместо перечисления данных входа в систему контроллера 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. Единицы (СООТНОШЕНИЕ). | |
| tenant строка | По умолчанию: "admin" | Имя клиента, используемое для всех вызовов API Avi и контекста объекта. |
| tenant_ref - | Ссылка на объект типа клиент. | |
| 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 Network см. на странице 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 словарь | success, changed | Объект PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/avi_poolgroupdeploymentpolicy_module.html