cisco.dnac.interfaces_query 模块 – 接口查询资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,请参阅 要求 以了解详细信息。
要在剧本中使用它,请指定:cisco.dnac.interfaces_query
。
cisco.dnac 6.15.0 中的新增功能
概要
此模块表示模块 interfaces_query_v1 的别名。
注意
此模块具有相应的 action 插件。
要求
在执行此模块的主机上需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
接口查询的 aggregateAttributes。 |
|
函数。 |
|
名称。 |
|
属性。 |
|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值: |
|
结束时间。 |
|
接口查询的 filters。 |
|
接口查询的 filters。 |
|
过滤器。 |
|
键。 |
|
逻辑运算符。 |
|
运算符。 |
|
值。 |
|
键。 |
|
逻辑运算符。 |
|
运算符。 |
|
值。 |
|
接口查询的 page。 |
|
限制。 |
|
偏移量。 |
|
接口查询的 sortBy。 |
|
名称。 |
|
顺序。 |
|
开始时间。 |
|
用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求体的标志。 选项
|
|
视图。 |
备注
注意
使用的 SDK 方法是 devices.Devices.gets_the_list_of_interfaces_across_the_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1,
使用的路径是 post /dna/data/api/v1/interfaces/query,
需要注意的是,此模块是 interfaces_query_v1 的别名。
不支持
check_mode
插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 文档,了解 Devices GetsTheListOfInterfacesAcrossTheNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctionsV1。
GetsTheListOfInterfacesAcrossTheNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctionsV1 API 的完整参考。
示例
- name: Create
cisco.dnac.interfaces_query:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
aggregateAttributes:
- function: string
name: string
attributes:
- string
endTime: 0
filters:
- filters:
- filters:
- string
key: string
logicalOperator: string
operator: string
value: {}
key: string
logicalOperator: string
operator: string
value: {}
page:
limit: 0
offset: 0
sortBy:
- name: string
order: string
startTime: 0
views:
- string
返回值
公共返回值已记录在 此处,以下是此模块特有的字段。
键 |
描述 |
---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表。 返回值: 始终 示例: |