community.network.avi 查询 – 查询 ``Avi`` 对象。

注意

此查询插件是 community.network 集合 (版本 5.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.network。

要在 playbook 中使用它，请指定： community.network.avi。

注意

community.network 集合已弃用，并将从 Ansible 12 中删除。请参阅 讨论主题 以了解更多信息。

已弃用

在版本中移除：

6.0.0

原因：

此集合及其中的所有内容均未维护且已弃用。

替代方案：

未知。

概要

  • 给定一个 object_type，获取该类型的所有对象，或获取通过选项给定的名称/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

字典

包含当前会话 ID 和 CSRF 令牌的 Avi API 上下文。

这允许用户执行单次登录并重用会话。

api_version

字符串

用于 Avi API 和对象的 Avi API 版本。

默认值： "16.4.4"

avi_credentials

字典

Avi 凭据字典，可用于代替枚举 Avi Controller 登录详细信息。

api_version

字符串

Avi 控制器版本

默认值： "16.4.4"

controller

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于与 session id 重用现有会话

默认值： ""

password

字符串

Avi 控制器密码

port

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API session id，用于与 csrftoken 重用现有会话

默认值： ""

tenant

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

timeout

字符串

Avi 控制器请求超时

默认值： 300

token

字符串

Avi 控制器 API 令牌

默认值： ""

username

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

禁用将 avi 会话信息作为事实缓存。

选项

  • false ← (默认)

  • true

controller

字符串

控制器的 IP 地址或主机名。默认值为环境变量 AVI_CONTROLLER。

obj_name

字符串

要查询的对象的名称

obj_type

字符串 / 必需

要查询的对象类型

obj_uuid

字符串

要查询的对象的 UUID

password

字符串

Avi 控制器中 Avi 用户的密码。默认值为环境变量 AVI_PASSWORD。

tenant

字符串

用于所有 Avi API 调用和对象上下文的租户名称。

默认值： "admin"

tenant_uuid

字符串

用于所有 Avi API 调用和对象上下文的租户 UUID。

默认值： ""

username

字符串

用于访问 Avi 控制器的用户名。默认值为环境变量 AVI_USERNAME。

备注

注意

示例

# 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') }}"

返回值

键

描述

返回值

列表 / 元素=字典

从 ``Avi`` API 返回的一个或多个对象。

返回： 成功

状态

  • 此查询将在 6.0.0 版本中移除。 *[已弃用]*

  • 更多信息请参见 已弃用。

作者

  • Sandeep Bandi (@sabandi)

提示

每个条目类型的配置项具有从低到高的优先级顺序。例如，列表中靠后的变量将覆盖靠前的变量。