community.network.avi_serviceengine – Модуль для настройки объекта ServiceEngine Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: 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 для использования в Avi API и объектах. | |
| availability_zone строка | Зона доступности serviceengine. | ||
| avi_api_patch_op строка |
| Операция обновления для использования при использовании avi_api_update_method в качестве обновления. | |
| 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 | ||
| 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. | ||
| 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-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | |
| controller_created логическое |
| Флаг логического типа для установки controller_created. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| controller_ip строка | 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 строка | Тип 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 см. по адресу 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/avi_serviceengine_module.html
