community.network.avi_api_version – Модуль версии API Avi
Примечание
Этот плагин входит в состав коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в книге задач, укажите: community.network.avi_api_version.
Обзор
- Этот модуль может использоваться для получения версии REST API Avi. https://avinetworks.com/
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить одно входа и повторно использовать сеанс. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия API Avi, которая должна использоваться для API Avi и объектов. | |
| avi_credentials словарь | Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера | ||
| csrftoken строка | CSRF-токен API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| password строка | Пароль пользователя Avi в контроллере Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с CSRF-токен | ||
| tenant строка | Значение по умолчанию: "admin" | Тенейнт контроллера Avi | |
| tenant_uuid строка | UUID тенейнта контроллера Avi | ||
| timeout строка | Значение по умолчанию: 300 | Тайм-аут запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact логическое значение |
| Отключает кэширование информации о сеансе avi в качестве факта. | |
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию – переменная среды AVI_CONTROLLER. | |
| password строка | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию – переменная среды AVI_PASSWORD. | |
| tenant строка | Значение по умолчанию: "admin" | Имя тенейнта, используемое для всех вызовов API Avi и контекста объекта. | |
| tenant_uuid строка | Значение по умолчанию: "" | UUID тенейнта, используемого для всех вызовов API Avi и контекста объекта. | |
| username строка | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию – переменная среды AVI_USERNAME. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице 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 словарь | успех, изменён | Ресурс REST Avi |
Авторы
- Vilian Atmadzhov (@vivobg) <vilian.atmadzhov@paddypowerbetfair.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_api_version_module.html
