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 для использования с API Avi и объектами. |
| 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 bool (добавлен в 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 см. на 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 dict | success, changed | Объект PoolGroup (api/poolgroup) |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом Ansible, см. на этой странице.
Автор
- Гaurav 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.6/modules/avi_poolgroup_module.html
