avi_poolgroup – Модуль для настройки объекта PoolGroup Avi RESTful
Обзор
- Этот модуль используется для настройки объекта 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 контроллер. | ||
| api_version - | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера Avi | ||
| 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 логическое добавлено в 2.6 |
| Отключает кеширование информации о сессии avi в качестве факта. | |
| cloud_config_cksum - | Контрольная сумма конфигурации облака для группы пулов. Внутренне устанавливается соединителем облака. | ||
| cloud_ref - | Ссылка на объект типа облако. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная окружения AVI_CONTROLLER. | |
| created_by - | Имя пользователя, создавшего объект. | ||
| deployment_policy_ref - | При настройке менеджера автоматического масштабирования новые пулы автоматически будут продвинуты в производство, когда будут достигнуты цели развертывания. Ссылка на объект типа poolgroupdeploymentpolicy. | ||
| description - | Описание группы пулов. | ||
| fail_action - | Включить действие - закрыть соединение, перенаправление HTTP или локальный HTTP ответ - при сбое группы пулов. По умолчанию соединение будет закрыто в случае сбоя группы пулов. | ||
| implicit_priority_labels логическое добавлено в 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. | ||
| service_metadata - добавлено в 2.9 | Метаданные, относящиеся к предоставляемому этой группой пулов сервису. В средах 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 см. на странице 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) |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/avi_poolgroup_module.html
