community.network.avi поиск – Поиск объектов ``Avi``
Примечание
Этот плагин поиска входит в состав коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать её в книге задач, укажите: community.network.avi.
Описание
- В зависимости от типа объекта, получить все объекты этого типа или конкретный объект, соответствующий заданному имени/uuid с помощью опций.
- Для поиска одного объекта. Если вы хотите, чтобы вывод был списком, можно передать опцию wantlist=True в плагин.
Параметры ключевых слов
Это описывает параметры ключевых слов поиска. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('community.network.avi', key1=value1, key2=value2, ...) и query('community.network.avi', key1=value1, key2=value2, ...)
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, который включает текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить одно входное подключение и повторно использовать сеанс. |
api_version строка | Версия API Avi, которая должна использоваться для API Avi и объектов. Значение по умолчанию: |
avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. |
|
api_version строка |
Версия контроллера Avi Значение по умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера Avi |
|
csrftoken строка |
Маркер csrf API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса Значение по умолчанию: |
|
password строка |
Пароль пользователя Avi в контроллере Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken Значение по умолчанию: |
|
tenant строка |
Тенент контроллера Avi Значение по умолчанию: |
|
tenant_uuid строка |
UUID тенента контроллера Avi Значение по умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi Значение по умолчанию: |
|
token строка |
Токен API контроллера Avi Значение по умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact булево | Отключает кеширование информации о сеансе avi в качестве факта. Выбори:
|
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
obj_name строка | имя объекта для запроса |
obj_type строка / обязательно | тип объекта для запроса |
obj_uuid строка | UUID объекта для запроса |
password строка | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения |
tenant строка | Имя тенента, используемого для всех вызовов API Avi и контекста объекта. Значение по умолчанию: |
tenant_uuid строка | UUID тенента, используемого для всех вызовов API Avi и контекста объекта. Значение по умолчанию: |
username строка | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения |
Примечания
Примечание
- Дополнительную информацию об использовании 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') }}"
Возвращаемое значение
Ключ | Описание |
|---|---|
Возвращаемое значение список / элементы=словарь | Один или несколько объектов, возвращенных из API ``Avi``. Возвращено: успешно |
Ссылки на коллекцию
© 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_lookup.html
