community.network.avi_poolgroupdeploymentpolicy модуль – Модуль для настройки объекта PoolGroupDeploymentPolicy Avi RESTful
Примечание
Этот модуль входит в коллекцию community.network (версия 5.0.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в Требования.
Для использования в книге задач укажите: community.network.avi_poolgroupdeploymentpolicy.
Описание
- Этот модуль используется для конфигурации объекта PoolGroupDeploymentPolicy
- Больше примеров на https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_poolgroupdeploymentpolicy
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. |
api_version строка | Версия API Avi для использования с API Avi и объектами. По умолчанию: |
auto_disable_old_prod_pools логическое значение | Автоматически отключит старые производственные пулы после появления нового кандидата в производство. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
avi_api_patch_op строка | Операция обновления при использовании avi_api_update_method как patch. Варианты:
|
avi_api_update_method строка | Метод обновления объекта по умолчанию — HTTP PUT. Установка в patch переопределяет это поведение на использование HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера |
|
csrftoken строка |
Токен csrf API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken По умолчанию: |
|
tenant строка |
Домен контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID домена контроллера Avi По умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact логическое значение | Отключает кэширование информации о сеансе avi в качестве факта. Варианты:
|
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды |
description строка | Пользовательское описание объекта. |
evaluation_duration строка | Продолжительность периода оценки для автоматического развертывания. Допустимые значения: 60-86400. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300. |
name string / обязательно | Имя политики развертывания группы пулов. |
password строка | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения |
rules строка | Список pgdeploymentrule. |
scheme строка | Схема развертывания. Варианты перечисления — BLUE_GREEN, CANARY. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как BLUE_GREEN. |
state строка | Состояние, которое должно быть применено к объекту. Варианты:
|
target_test_traffic_ratio строка | Целевое соотношение трафика перед тем, как пул станет рабочим. Допустимые значения — 1–100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 100. |
tenant строка | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_ref строка | Ссылка на объект типа арендатор. |
tenant_uuid строка | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
test_traffic_ratio_rampup строка | Соотношение трафика, которое отправляется в тестируемый пул. Соотношение тестирования 100 означает сине-зеленое развертывание. Допустимые значения — 1–100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 100. |
url строка | URL контроллера Avi для объекта. |
username строка | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения |
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
community.network.avi_poolgroupdeploymentpolicy:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_poolgroupdeploymentpolicy
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
obj словарь | Объект PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) Возвращаемое значение: success, changed |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_poolgroupdeploymentpolicy_module.html
