community.network.avi_poolgroup модуль — Модуль для настройки объекта PoolGroup Avi RESTful
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные требования, см. Требования для получения подробностей.
Для использования его в плейбуке укажите: community.network.avi_poolgroup.
Обзор
- Этот модуль используется для конфигурации объекта PoolGroup.
- Другие примеры находятся по адресу https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_poolgroup
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. |
api_version строка | Версия API Avi, используемая для Avi API и объектов. По умолчанию: |
avi_api_patch_op строка | Операция исправления, используемая при использовании avi_api_update_method как исправление. Варианты:
|
avi_api_update_method строка | Метод обновления объекта по умолчанию — HTTP PUT. Установка значения «patch» переопределит это поведение, чтобы использовать HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера |
|
csrftoken строка |
Маркер csrftoken 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 в качестве факта. Варианты:
|
cloud_config_cksum строка | Контрольная сумма конфигурации облака для группы пулов. Внутренне задаётся коннектором облака. |
cloud_ref строка | Ссылка на объект типа облако. |
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
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. Значение по умолчанию — переменная среды |
priority_labels_ref строка | Уникальный идентификатор (UUID) меток приоритета. Если не указано, метка приоритета члена группы пулов будет интерпретироваться как число, при этом большее число означает более высокий приоритет. Ссылка на объект типа prioritylabels. |
service_metadata строка | Метаданные, относящиеся к предоставляемому этой группой пулов сервису. В средах openshift/kubernetes хранится информация о метаданных приложения. Любой ввод пользователя в это поле будет перезаписан системой avi vantage. Поле введено в 17.2.14,18.1.5,18.2.1. |
state строка | Состояние, которое должно быть применено к сущности. Варианты:
|
tenant строка | Имя арендатора, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: |
tenant_ref строка | Ссылка на объект типа tenant. |
tenant_uuid строка | Уникальный идентификатор (UUID) арендатора, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: |
url строка | URL контроллера Avi для объекта. |
username строка | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды |
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 словарь | Объект PoolGroup (api/poolgroup) Возвращается: 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_poolgroup_module.html
