community.network.avi_serviceengine модуль — Модуль для настройки объекта ServiceEngine Avi RESTful
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: community.network.avi_serviceengine.
Обзор
- Этот модуль используется для конфигурирования объекта ServiceEngine
- Дополнительные примеры на https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_serviceengine
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и токен CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. |
api_version строка | Версия API Avi, используемая для Avi API и объектов. По умолчанию: |
availability_zone строка | Availability_zone сервисного узла. |
avi_api_patch_op строка | Операция обновления, используемая при использовании avi_api_update_method как patch. Варианты:
|
avi_api_update_method строка | Метод обновления объекта по умолчанию — HTTP PUT. Установка значения patch переопределяет это поведение на использование HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь Avi Credentials, который может использоваться вместо перечисления данных входа в Avi Controller. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера Avi |
|
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. |
container_mode логическое значение | Флаг логического типа для установки container_mode. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
container_type строка | Перечисление вариантов — container_type_bridge, container_type_host, container_type_host_dpdk. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как CONTAINER_TYPE_HOST. |
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
controller_created boolean | Флаг булевого типа для установки controller_created. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
controller_ip string | Controller_ip сервисного движка. |
data_vnics string | Список vnic. |
enable_state string | Для отключения se необходимо правильно установить это поле. Варианты перечисления - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SE_STATE_ENABLED. |
flavor string | Настройка сервисного движка. |
host_ref string | Ссылка на объект типа vimgrhostruntime. |
hypervisor string | Варианты перечисления - default, vmware_esx, kvm, vmware_vsan, xen. |
mgmt_vnic string | Настройка vnic для сервисного движка. |
name string | Имя объекта. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как VM name unknown. |
password string | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная окружения |
resources string | Настройки ресурсов для сервисного движка. |
se_group_ref string | Ссылка на объект типа serviceenginegroup. |
state string | Состояние, которое должно быть применено к сущности. Варианты:
|
tenant string | Имя домена, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_ref string | Ссылка на объект типа tenant. |
tenant_uuid string | UUID домена, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
url string | URL контроллера Avi для объекта. |
username string | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию - переменная окружения |
uuid string | Уникальный идентификатор объекта. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create ServiceEngine object
community.network.avi_serviceengine:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_serviceengine
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
obj словарь | Объект ServiceEngine (api/serviceengine) Возвращаемое значение: 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_serviceengine_module.html
