avi – Просмотр объектов Avi
Новое в версии 2.9.
Обзор
- При заданном object_type, извлечь все объекты этого типа или конкретный объект, соответствующий имени/uuid, предоставленным в параметрах.
- Для поиска одного объекта. Если вы хотите получить список, вы можете передать параметр wantlist=True в плагин.
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии | |
|---|---|---|---|---|
| api_context словарь добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сессии и CSRF-токен. Это позволяет пользователю выполнить одно входное окно и повторно использовать сессию. | |||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | ||
| avi_credentials словарь добавлен в 2.5 | Словарь данных аутентификации 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 boolean добавлен в 2.6 |
| Отключает кеширование информации о сессии Avi в качестве факта. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | ||
| obj_name - | Имя объекта для запроса | |||
| obj_type - / обязательно | Тип объекта для запроса | |||
| obj_uuid - | UUID объекта для запроса | |||
| 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.
Примеры
# Lookup query for all the objects of a specific type.
- debug: msg="{{ lookup('avi', avi_credentials=avi_credentials, obj_type='virtualservice') }}"
# Lookup query for an object with the given name and type.
- debug: msg="{{ lookup('avi', avi_credentials=avi_credentials, obj_name='vs1', obj_type='virtualservice', wantlist=True) }}"
# Lookup query for an object with the given UUID and type.
- debug: msg="{{ lookup('avi', obj_uuid='virtualservice-5c0e183a-690a-45d8-8d6f-88c30a52550d', obj_type='virtualservice') }}"
# We can replace lookup with query function to always the get the output as list.
# This is helpful for looping.
- debug: msg="{{ query('avi', obj_uuid='virtualservice-5c0e183a-690a-45d8-8d6f-88c30a52550d', obj_type='virtualservice') }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного поиска:
| Ключ | Возвращено | Описание |
|---|---|---|
| _raw список / элементы=словарь | Один или несколько объектов, возвращенных API ``Avi``. |
Статус
- Этот поиск не гарантирует обратную совместимость интерфейса. [превью]
- Этот поиск поддерживается сообществом Ansible. [сообщество]
Авторы
- Sandeep Bandi <sandeepb@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.9/plugins/lookup/avi.html
