Spec-Zone.ru › Ansible 2.11

community.network.avi_serviceengine – Модуль для настройки объекта ServiceEngine Avi RESTful

Примечание

Этот плагин является частью коллекции community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Чтобы использовать его в книге задач, укажите: community.network.avi_serviceengine.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Этот модуль используется для конфигурации объекта ServiceEngine
  • Дополнительные примеры на https://github.com/avinetworks/devops

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • avisdk

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_context
словарь
Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF.
Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version
строка
По умолчанию:
"16.4.4"
Версия API Avi для использования с API Avi и объектами.
availability_zone
строка
Зона доступности serviceengine.
avi_api_patch_op
строка
    Варианты:
  • add
  • replace
  • delete
Операция исправления, используемая при использовании avi_api_update_method как patch.
avi_api_update_method
строка
    Варианты:
  • put ←
  • patch
Метод по умолчанию для обновления объекта — 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
boolean
    Варианты:
  • нет ←
  • да
Отключает кэширование информации о сессии avi в качестве факта.
cloud_ref
строка
Ссылка на объект типа cloud.
container_mode
boolean
    Варианты:
  • нет
  • да
Флаг Boolean для установки container_mode.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
container_type
строка
Варианты перечисления — container_type_bridge, container_type_host, container_type_host_dpdk.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как CONTAINER_TYPE_HOST.
controller
строка
По умолчанию:
""
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.
controller_created
boolean
    Варианты:
  • нет
  • да
Флаг Boolean для установки controller_created.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
controller_ip
строка
Controller_ip serviceengine.
data_vnics
строка
Список vnic.
enable_state
строка
Для отключения se задайте это поле соответствующим образом.
Варианты перечисления — SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SE_STATE_ENABLED.
flavor
строка
Flavor serviceengine.
host_ref
строка
Ссылка на объект типа vimgrhostruntime.
hypervisor
строка
Варианты перечисления — default, vmware_esx, kvm, vmware_vsan, xen.
mgmt_vnic
строка
Настройки vnic для serviceengine.
name
строка
Имя объекта.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как имя VM неизвестно.
password
строка
По умолчанию:
""
Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD.
resources
строка
Настройки ресурсов serviceengine.
se_group_ref
строка
Ссылка на объект типа serviceenginegroup.
state
строка
    Варианты:
  • отсутствует
  • наличие ←
Состояние, которое должно быть применено к сущности.
tenant
строка
По умолчанию:
"admin"
Имя тенента, используемое для всех вызовов API Avi и контекста объекта.
tenant_ref
строка
Ссылка на объект типа tenant.
tenant_uuid
строка
По умолчанию:
""
UUID тенента, используемого для всех вызовов API Avi и контекста объекта.
url
строка
URL контроллера Avi объекта.
username
строка
По умолчанию:
""
Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME.
uuid
строка
Уникальный идентификатор объекта.

Примечания

Примечание

  • Дополнительную информацию об использовании 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)



Авторы

  • 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_serviceengine_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API