community.network.avi_tenant модуль — Модуль для настройки объекта Tenant Avi RESTful

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

Возможно, у вас уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в playbook, укажите: community.network.avi_tenant.

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

Описание

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

Псевдонимы: network.avi.avi_tenant

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version строка	Версия API Avi, используемая для API Avi и объектов. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, используемая при использовании avi_api_update_method как исправление. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в значение patch переопределяет это поведение для использования HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в систему контроллера Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
csrftoken строка	Маркер CSRF API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса По умолчанию: `""`
password строка	Пароль контроллера Avi
port строка	Порт контроллера Avi
session_id строка	Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken По умолчанию: `""`
tenant строка	Тенейнт контроллера Avi По умолчанию: `"admin"`
tenant_uuid строка	UUID тенейнта контроллера Avi По умолчанию: `""`
timeout строка	Тайм-аут запроса контроллера Avi По умолчанию: `300`
token строка	Токен API контроллера Avi По умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact булево	Отключает кеширование информации о сеансе avi в качестве факта. Варианты: `false` ← (по умолчанию) `true`
config_settings строка	Настройки конфигурации тенейнта для тенейнта.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
created_by строка	Создатель этого тенейнта.
description строка	Определяемое пользователем описание объекта.
local булево	Флаг булевого типа для установки local. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты: `false` `true`
name строка / обязательно	Имя объекта.

END_OF_DOCUMENT_MARKER

пароль строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная окружения `AVI_PASSWORD`.
состояние строка	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
арендатор строка	Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
uuid_арендатора строка	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
url строка	URL контроллера Avi для объекта.
имя_пользователя строка	Имя пользователя, используемое для доступа к контроллеру 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 словарь	Объект арендатора (api/tenant) Возвращаемое значение: success, changed

Авторы

Gaurav Rastogi (@grastogi23)

Ссылки на коллекцию

© 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_tenant_module.html