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

Примечание

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

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

Для использования в книге задач укажите: community.network.avi_poolgroup.

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

Обзор

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

Требования

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

avisdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
api_context словарь			Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version строка		По умолчанию: "16.4.4"	Версия API Avi для использования с Avi API и объектами.
avi_api_patch_op строка		Варианты: add replace delete	Операция исправления, используемая при использовании avi_api_update_method как patch.
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 строка		Маркер csrftoken API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса
	password строка		Пароль контроллера 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 булево		Варианты: нет ← да	Отключает кэширование информации о сеансе avi как факта.
cloud_config_cksum строка			Контрольная сумма конфигурации облака для группы пулов. Внутренне устанавливается подключением к облаку.
cloud_ref строка			Ссылка на объект типа cloud.
controller строка		По умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
created_by строка			Имя пользователя, который создал объект.
deployment_policy_ref строка			При настройке менеджера автомасштабирования он автоматически продвинет новые пулы в производство, когда будут выполнены цели развертывания. Ссылка на объект типа poolgroupdeploymentpolicy.
description строка			Описание группы пулов.
fail_action строка			Включить действие — закрыть соединение, перенаправление HTTP или локальный HTTP-ответ — при сбое группы пулов. По умолчанию соединение будет закрыто, если группа пулов выйдет из строя.
implicit_priority_labels булево		Варианты: нет да	Присутствует ли неявный набор меток приоритета. Поле введено в 17.1.9, 17.2.3. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.
members строка			Список членов группы пулов, объект типа poolgroupmember.
min_servers строка			Минимальное количество серверов для распределения трафика. Допустимые значения — 1–65535. Специальные значения — 0 — «отключено». Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 0.
name строка / обязательно			Имя группы пулов.
password строка		По умолчанию: ""	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
priority_labels_ref строка			Uuid меток приоритета. Если не указано, метка приоритета члена группы пулов будет интерпретироваться как число, при этом большее число считается более высоким приоритетом. Ссылка на объект типа prioritylabels.
service_metadata строка			Метаданные, относящиеся к услуге, предоставляемой этой группой пулов. В средах openshift/kubernetes хранится информация о метаданных приложения. Любой введенный пользователем текст в этом поле будет перезаписан системой Avi Vantage. Поле введено в 17.2.14, 18.1.5, 18.2.1.
state строка		Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
tenant строка		По умолчанию: "admin"	Имя тенента, используемое для всех вызовов API Avi и контекста объекта.
tenant_ref строка			Ссылка на объект типа tenant.
tenant_uuid строка		По умолчанию: ""	UUID тенента, используемого для всех вызовов API Avi и контекста объекта.
url строка			URL контроллера Avi для объекта.
username строка		По умолчанию: ""	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid строка			Uuid группы пулов.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Example to create PoolGroup object
  community.network.avi_poolgroup:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_poolgroup

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
obj словарь	success, changed	Объект PoolGroup (api/poolgroup)

Авторы

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_poolgroup_module.html