community.network.avi_vsvip – Модуль для настройки объекта VsVip Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network
Для использования в книге задач укажите: community.network.avi_vsvip
Обзор
- Этот модуль используется для конфигурации объекта VsVip
- больше примеров на https://github.com/avinetworks/devops
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. | |
| 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 контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| password строка | Пароль пользователя Avi в контроллере 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_ref строка | Ссылка на объект типа cloud. Поле введено в 17.1.1. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| dns_info строка | Данные, специфичные для обнаружения служб, включая полное доменное имя, тип и время жизни записи DNS. Поле введено в 17.1.1. | ||
| east_west_placement логический |
| Принудительное размещение на всех серверных узлах в группе серверных узлов (только облака контейнеров). Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| name строка / обязательно | Имя объекта vsvip. Поле введено в 17.1.1. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Ссылка на объект типа tenant. Поле введено в 17.1.1. | ||
| tenant_uuid строка | По умолчанию: "" | UUID тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi объекта. | ||
| use_standard_alb логический |
| Это переопределяет значение по умолчанию на уровне облака и должно совпадать со значением se group, в котором оно будет использоваться, если значение use_standard_alb группы se установлено. Это используется только при использовании fip для vs в облаке Azure. Поле введено в 18.2.3. | |
| username строка | По умолчанию: "" | Имя пользователя, используемого для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Uuid объекта vsvip. Поле введено в 17.1.1. | ||
| vip строка | Список виртуальных IP-адресов служб и других общих сущностей. Поле введено в 17.1.1. | ||
| vrf_context_ref строка | Виртуальный контекст маршрутизации, к которому привязана виртуальная служба. Это используется для обеспечения изоляции набора сетей, к которым подключено приложение. Это ссылка на объект типа vrfcontext. Поле введено в 17.1.1. | ||
| vsvip_cloud_config_cksum строка | Контрольная сумма конфигурации облака для vsvip. Внутренне устанавливается соединителем облака. Поле введено в 17.2.9, 18.1.2. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create VsVip object
community.network.avi_vsvip:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_vsvip
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменение | Объект VsVip (api/vsvip) |
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_vsvip_module.html
