avi_poolgroup – Модуль для настройки объекта PoolGroup Avi RESTful
Новый в версии 2.3.
Обзор
- Этот модуль используется для настройки объекта PoolGroup
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context - Добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | |
| api_version - | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. |
| avi_api_patch_op - Добавлен в 2.5 |
| Операция обновления для использования при использовании avi_api_update_method как patch. |
| avi_api_update_method - Добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. |
| avi_credentials - Добавлен в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | |
| cloud_config_cksum - | Контрольная сумма конфигурации облака для poolgroup. Внутренне устанавливается облачным адаптером. | |
| cloud_ref - | Ссылка на объект типа cloud. | |
| controller - | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| created_by - | Имя пользователя, создавшего объект. | |
| deployment_policy_ref - | При настройке диспетчера автомасштабирования новые пулы автоматически будут переведены в производство, когда будут достигнуты цели развертывания. Ссылка на объект типа poolgroupdeploymentpolicy. | |
| description - | Описание группы пулов. | |
| fail_action - | Включение действия — закрытие соединения, HTTP-перенаправление или локальный HTTP-ответ — при возникновении сбоя в группе пулов. По умолчанию соединение будет закрыто в случае сбоя группы пулов. | |
| implicit_priority_labels boolean Добавлен в 2.5 |
| Указывает, генерируется ли неявный набор меток приоритета. Поле введено в 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. | |
| state - |
| Состояние, которое должно быть применено к объекту. |
| 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
avi_poolgroup:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_poolgroup
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменилось | Объект PoolGroup (api/poolgroup) |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Gaurav Rastogi (grastogi@avinetworks.com)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/avi_poolgroup_module.html
