community.network.avi_tenant – Модуль для настройки объекта Tenant Avi RESTful
Примечание
Этот плагин входит в состав коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.avi_tenant.
Обзор
- Этот модуль используется для настройки объекта Tenant.
- Дополнительные примеры см. на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| 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-токен 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 логическое |
| Отключает кеширование информации о сеансе avi в качестве факта. | |
| config_settings строка | Настройки конфигурации подструктуры для подструктуры. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| created_by строка | Создатель этой подструктуры. | ||
| description строка | Определяемая пользователем информация об объекте. | ||
| local логическое |
| Логический флаг для установки local. Значение по умолчанию, когда не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| name строка / требуется | Имя объекта. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя подструктуры, используемой для всех вызовов API Avi и контекста объекта. | |
| tenant_uuid строка | По умолчанию: "" | UUID подструктуры, используемой для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Create Tenant using Service Engines in provider mode
community.network.avi_tenant:
controller: '{{ controller }}'
password: '{{ password }}'
username: '{{ username }}'
config_settings:
se_in_provider_context: false
tenant_access_to_provider_se: true
tenant_vrf: false
description: VCenter, Open Stack, AWS Virtual services
local: true
name: Demo
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменения | Объект Tenant (api/tenant) |
Авторы
- 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_tenant_module.html