community.network.avi_poolgroupdeploymentpolicy – Модуль для настройки объекта PoolGroupDeploymentPolicy Avi RESTful

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Чтобы использовать его в книге задач, укажите: community.network.avi_poolgroupdeploymentpolicy.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль используется для настройки объекта PoolGroupDeploymentPolicy
Дополнительные примеры на https://github.com/avinetworks/devops

Требования

Ниже перечислены требования, необходимые на хосте, выполняющем этот модуль.

avisdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
api_context словарь			Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version строка		По умолчанию: "16.4.4"	Версия API Avi для использования с Avi API и объектами.
auto_disable_old_prod_pools логическое значение		Варианты: no yes	Автоматически отключит старые пулы производства, как только появится новый кандидат на производство. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
avi_api_patch_op строка		Варианты: add replace delete	Операция исправления, используемая при использовании avi_api_update_method как исправления.
avi_api_update_method строка		Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH.
avi_credentials словарь			Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в систему контроллера Avi.
	api_version строка	По умолчанию: "16.4.4"	Версия контроллера Avi
	controller строка		IP-адрес или SQDN контроллера
	csrftoken строка		Токен csrf контроллера API Avi для повторного использования существующего сеанса с идентификатором сеанса
	password строка		Пароль пользователя Avi в контроллере Avi
	port строка		Порт контроллера Avi
	session_id строка		Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с токеном csrf
	tenant строка	По умолчанию: "admin"	Тенент контроллера Avi
	tenant_uuid строка		UUID тенента контроллера Avi
	timeout строка	По умолчанию: 300	Таймаут запроса контроллера Avi
	token строка		Токен API контроллера Avi
	username строка		Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логическое значение		Варианты: no ← yes	Отключает кеширование информации о сеансе 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 строка		Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
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 строка			Веб-хук, настроенный с 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)

Авторы

Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_poolgroupdeploymentpolicy_module.html