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. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера Avi | ||
| 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 булево добавлен в 2.6 |
| Отключает кеширование информации о сеансе 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 означает синий-зеленый. Допустимые значения — 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 словарь | успех, изменения | Объект PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/avi_poolgroupdeploymentpolicy_module.html