community.network.avi – Поиск объектов Avi.
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.avi.
Обзор
- На основе типа объекта, извлечь все объекты этого типа или конкретный объект, соответствующий имени/UUID, указанному в опциях.
- Для поиска одного объекта. Если вам нужно, чтобы результат был списком, вы можете передать опцию wantlist=True в плагин.
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии | |
|---|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | |||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. | ||
| avi_credentials словарь | Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в контроллер Avi. | |||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | ||
| controller строка | IP-адрес или SQDN контроллера | |||
| csrftoken строка | Маркер csrftoken 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 в качестве факта. | ||
| 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.
- ansible.builtin.debug: msg="{{ lookup('community.network.avi', avi_credentials=avi_credentials, obj_type='virtualservice') }}"
# Lookup query for an object with the given name and type.
- ansible.builtin.debug: msg="{{ lookup('community.network.avi', avi_credentials=avi_credentials, obj_name='vs1', obj_type='virtualservice', wantlist=True) }}"
# Lookup query for an object with the given UUID and type.
- ansible.builtin.debug: msg="{{ lookup('community.network.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.
- ansible.builtin.debug: msg="{{ query('community.network.avi', obj_uuid='virtualservice-5c0e183a-690a-45d8-8d6f-88c30a52550d', obj_type='virtualservice') }}"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого поиска:
| Ключ | Возвращённое | Описание |
|---|---|---|
| _raw список / элементы=словарь | успех | Один или более объектов, возвращенных API ``Avi``. |
Авторы
- Sandeep Bandi (@sabandi) <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.10/collections/community/network/avi_lookup.html
