avi_poolgroup - Модуль для настройки PoolGroup Avi RESTful Object
Новый в версии 2.3.
Обзор
- Этот модуль используется для конфигурации объекта PoolGroup
- Дополнительные примеры можно найти по адресу https://github.com/avinetworks/devops
Требования (к хосту, на котором выполняется модуль)
- avisdk
Параметры
| параметр | обязательно | по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| api_version | нет | Версия API Avi для использования с Avi API и объектами. | ||
| cloud_config_cksum | нет | Контрольная сумма конфигурации облака для poolgroup. Внутренне устанавливается облачным соединителем. | ||
| cloud_ref | нет | Ссылка на объект типа cloud. | ||
| controller | нет | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | ||
| created_by | нет | Имя пользователя, создавшего объект. | ||
| deployment_policy_ref | нет | При настройке диспетчера автоматического масштабирования новые пулы автоматически будут переведены в производство, когда будут достигнуты цели развертывания. Ссылка на объект типа poolgroupdeploymentpolicy. | ||
| description | нет | Описание группы пулов. | ||
| fail_action | нет | Активировать действие — закрыть соединение, перенаправить HTTP или отправить локальный HTTP-ответ — при сбое группы пулов. По умолчанию соединение будет закрыто, если группа пулов откажет. | ||
| members | нет | Список объектов членов группы пулов типа poolgroupmember. | ||
| min_servers | нет | Минимальное количество серверов для распределения трафика. Допустимые значения: 1–65535. Специальные значения: 0 — «выключить». Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| name | да | Название группы пулов. | ||
| password | нет | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | ||
| priority_labels_ref | нет | Уникальный идентификатор (UUID) меток приоритета. Если не указано, метка приоритета члена группы пулов интерпретируется как число, при этом большее число соответствует более высокому приоритету. Ссылка на объект типа prioritylabels. | ||
| state | нет | present |
| Состояние, которое должно быть применено к сущности. |
| tenant | нет | admin | Имя клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref | нет | Ссылка на объект типа tenant. | ||
| tenant_uuid | нет | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. | ||
| url | нет | URL контроллера Avi объекта. | ||
| username | нет | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | ||
| uuid | нет | Уникальный идентификатор (UUID) группы пулов. |
Примеры
- name: Example to create PoolGroup object
avi_poolgroup:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_poolgroup
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения. Следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| obj | Объект PoolGroup (api/poolgroup) | успех, изменено | словарь |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Для получения помощи в разработке модулей ознакомьтесь с документацией Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_poolgroup_module.html
