Модуль community.network.avi_api_version – Модуль версии API Avi

Примечание

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

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

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

Для использования в книге задач укажите: community.network.avi_api_version.

Краткое описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Краткое описание

Этот модуль может использоваться для получения версии API Avi REST. https://avinetworks.com/

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version строка	Версия API Avi для использования с API Avi и объектами. По умолчанию: `"16.4.4"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера Avi
csrftoken строка	Маркер API контроллера Avi csrftoken для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
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`
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
tenant строка	Имя тенента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
tenant_uuid строка	UUID тенента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
username строка	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Get AVI API version
  community.network.avi_api_version:
    controller: ""
    username: ""
    password: ""
    tenant: ""
  register: avi_controller_version

Значения возврата

Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
obj словарь	Ресурс Avi REST Возвращено: успех, изменено

Авторы

Vilian Atmadzhov (@vivobg)

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

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