community.network.avi_poolgroup – Модуль для настройки объекта PoolGroup Avi RESTful
Примечание
Этот плагин является частью коллекции community.network (версия 1.3.0).
Для его установки используйте: 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 для использования с API Avi и объектами. | |
| avi_api_patch_op строка |
| Операция обновления при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера | ||
| csrftoken строка | CSRF-токен 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 строка | Контрольная сумма конфигурации облака для poolgroup. Внутренне устанавливается соединителем облака. | ||
| 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 строка |
| Состояние, которое должно быть применено к сущности. | |
| 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 словарь | успех, изменения | Объект PoolGroup (api/poolgroup) |
Авторы
- Gaurav Rastogi (@grastogi23) <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.10/collections/community/network/avi_poolgroup_module.html
