Модуль community.network.avi_vsvip — Модуль для настройки объекта VsVip Avi RESTful
Примечание
Этот модуль входит в коллекцию community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в плейбуке укажите: community.network.avi_vsvip.
Обзор
- Этот модуль используется для конфигурации объекта VsVip
- Дополнительные примеры можно найти по адресу https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_vsvip
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, содержащий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. |
api_version строка | Версия 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 строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера |
|
csrftoken строка |
Маркер CSRF API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: |
|
tenant строка |
Теней контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID арендатора контроллера Avi По умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact логическое | Отключает кеширование информации о сессии avi в качестве факта. Варианты:
|
cloud_ref строка | Ссылка на объект типа cloud. Поле введено в 17.1.1. |
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
dns_info строка | Данные службы обнаружения, включая полное доменное имя, тип и время жизни записи DNS. Поле введено в 17.1.1. |
east_west_placement логическое | Вынужденное размещение на всех сетевых двигателях в группе сетевых двигателей (только контейнерные облака). Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
name строка / обязательно | Имя объекта vsvip. Поле введено в 17.1.1. |
пароль строка | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды |
состояние строка | Состояние, которое должно быть применено к объекту. Варианты:
|
аренда строка | Имя аренды, используемой для всех вызовов API Avi и контекста объекта. По умолчанию: |
аренда_ссылка строка | Ссылка на объект типа аренды. Поле введено в версии 17.1.1. |
уникальный_идентификатор_аренды строка | Уникальный идентификатор (UUID) аренды, используемой для всех вызовов API Avi и контекста объекта. По умолчанию: |
url строка | URL контроллера Avi для объекта. |
использовать_стандартный_alb булево | Это переопределяет значение по умолчанию на уровне облака и должно соответствовать значению se group, в котором оно будет использоваться, если значение se group use_standard_alb установлено. Используется только при использовании fip для vs в облаке Azure. Поле введено в версии 18.2.3. Варианты:
|
имя_пользователя строка | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды |
уникальный_идентификатор строка | Уникальный идентификатор (UUID) объекта vsvip. Поле введено в версии 17.1.1. |
vip строка | Список виртуальных IP-адресов служб и других общих объектов. Поле введено в версии 17.1.1. |
vrf_context_ссылка строка | Виртуальный контекст маршрутизации, к которому привязана виртуальная служба. Используется для изоляции набора сетей, к которым подключено приложение. Это ссылка на объект типа vrfcontext. Поле введено в версии 17.1.1. |
vsvip_cloud_config_cksum строка | Контрольная сумма конфигурации облака для vsvip. Внутренне устанавливается облачным соединителем. Поле введено в версиях 17.2.9 и 18.1.2. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице 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) Возвращаемое значение: success, changed |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_vsvip_module.html
