cisco.dnac.network_devices_interfaces_query 模块 – 网络设备接口查询的资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.network_devices_interfaces_query。
cisco.dnac 6.14.0 中的新增功能
概要
此模块表示模块 network_devices_interfaces_query_v2 的别名。
注意
此模块具有相应的 action 插件。
要求
在执行此模块的主机上需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
DeviceId 路径参数。网络设备 ID。 |
|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
以毫秒为单位的 UTC 时间戳。 |
|
网络设备接口查询的查询。 |
|
所需字段名称，默认为全部。 |
|
网络设备接口查询的过滤器。 |
|
应应用过滤器的字段名称。 |
|
支持的操作符为 eq、in、like。 |
|
字段的值。 |
|
网络设备接口查询的页码。 |
|
记录数，最大值为 1000。 |
|
记录偏移值，默认为 0。 |
|
网络设备接口查询的 orderBy。 |
|
用于排序的字段名称。 |
|
可能的值 asc、des。 |
|
以毫秒为单位的 UTC 时间戳。 |
|
用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求体的标志。 选项
|
备注
注意
使用的 SDK 方法为 devices.Devices.get_device_interface_stats_info_v2，
使用的路径为 post /dna/intent/api/v2/networkDevices/{deviceId}/interfaces/query，
需要注意的是，此模块是 network_devices_interfaces_query_v2 的别名。
不支持
check_mode插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 设备 GetDeviceInterfaceStatsInfoV2 文档
GetDeviceInterfaceStatsInfoV2 API 的完整参考。
示例
- name: Create
cisco.dnac.network_devices_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}}"
deviceId: string
endTime: 0
query:
fields:
- {}
filters:
- key: string
operator: string
value: string
page:
limit: 0
offset: 0
orderBy:
- name: string
order: string
startTime: 0
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表。 返回： 始终 示例： |