cisco.dnac.interfaces_v1_info 模块 – 接口 V1 信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您正在使用 ansible 软件包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.dnac.interfaces_v1_info。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有接口 V1。
按 ID 获取接口 V1。
根据提供的查询参数检索所有网络设备的接口列表。将返回指定开始和结束时间范围内的最新接口数据。如果未指定开始和结束时间，则返回最新的可用数据。
返回给定接口实例 UUID 的接口数据以及统计数据。将返回指定开始和结束时间范围内的最新接口数据。如果未指定开始和结束时间，则返回给定接口 ID 的最新可用数据。有关 API 用法的详细信息，请参阅 OpenAPI 规范文档 - https //github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-interfaces-1.0.2-resolved.yaml。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
属性查询参数。可以在 attribute 字段中提供以下属性列表：id、adminStatus、description、duplexConfig、duplexOper、interfaceIfIndex、interfaceType、ipv4Address、ipv6AddressLi st、isL3Interface、isWan、macAddress、mediaType、name、operStatus、peerStackMember、peerStackPort、 portChannelId、portMode、portType、rxDiscards、rxError、rxRate、rxUtilization、speed、stackPortType、timestamp、txDis cards、txError、txRate、txUtilization、vlanId、networkDeviceId、networkDeviceIpAddress、networkDeviceMacAddress、sit eName、siteHierarchy、siteHierarchyId。如果属性列表过长，请改用“views”参数。示例：attributes=name（请求单个属性） attributes=name,description,duplexOper（用逗号分隔的多个属性）。 |
|
用于 Cisco DNA Center SDK 以启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
EndTime 查询参数。API 查询与资源相关的 DataSet 的结束时间。它必须以毫秒为单位的 UNIX 纪元时间指定。值为包含。 |
|
附加标头。 |
|
Id 路径参数。接口 UUID。 |
|
InterfaceId 查询参数。接口 UUID 列表。（例如，`6bef213c-19ca-4170-8375-b694e251101c`）示例 `interfaceId=6bef213c-19ca-4170-8375-b694e251101c`（单个接口 uuid）`interfaceId=6bef213c- 19ca-4170-8375-b694e251101c&32219612-819e-4b5e-a96b-cf22aca13dd9&2541e9a7-b80d-4955-8aa2-79b233318ba0`（用 & 分隔的多个接口 uuid）。 |
|
InterfaceName 查询参数。接口名称列表（例如，`GigabitEthernet1/0/1`）此字段支持基于通配符（`*`）字符的搜索。例如 `*1/0/1*` 或 `1/0/1*` 或 `*1/0/1` 示例 `interfaceNames=GigabitEthernet1/0/1`（单个接口名称）`interfaceNames=GigabitEthernet1/0/1&GigabitEthernet2/0/1&GigabitEthernet3/0/1`（用 & 分隔的多个接口名称）。 |
|
Limit 查询参数。要返回的最大记录数。 |
|
NetworkDeviceId 查询参数。网络设备 UUID 列表。（例如，`6bef213c-19ca-4170-8375-b694e251101c`）示例 `networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c`（请求单个 networkDeviceId）`networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b-cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2- 79b233318ba0`（用 & 分隔的多个 networkDeviceIds）。 |
|
NetworkDeviceIpAddress 查询参数。网络设备管理 IP 地址列表。（例如，`121.1.1.10`）此字段支持基于通配符（`*`）字符的搜索。例如 `*1.1*` 或 `1.1*` 或 `*1.1` 示例 `networkDeviceIpAddress=121.1.1.10` `networkDeviceIpAddress=121.1.1.10&networkDeviceIpAddress=172.20.1.10&networkDeviceIpAddress=10.10.20.10`（用 & 分隔的多个网络设备 IP 地址）。 |
|
NetworkDeviceMacAddress 查询参数。网络设备MAC地址列表。（例如：`64 f6 9d 07 9a 00`）此字段支持基于通配符（`*`）的搜索。例如 `*AB AB AB*` 或 `AB AB AB*` 或 `*AB AB AB` 示例 `networkDeviceMacAddress=64 f6 9d 07 9a 00` `networkDeviceMacAddress=64 f6 9d 07 9a 00&networkDeviceMacAddress=70 56 9d 07 ac 77`（使用 & 分隔符的多个 networkDevice MAC 地址）。 |
|
Offset 查询参数。指定 API 返回的所有记录中的起始点。它是一个基于1的偏移量。起始值为 1。 |
|
Order 查询参数。字段的排序顺序，升序或降序。 |
|
SiteHierarchy 查询参数。站点树的完整分层结构，从全局站点名称开始，到特定站点名称结束。根站点名为“Global”（例如：`Global/AreaName/BuildingName/FloorName`）此字段支持通配符星号（`*`）字符搜索。例如 `*/San*, */San, /San*` 示例 `?siteHierarchy=Global/AreaName/BuildingName/FloorName`（请求单个 siteHierarchy） `?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global /AreaName2/BuildingName2/FloorName2`（请求多个 siteHierarchies）。 |
|
SiteHierarchyId 查询参数。站点树的完整分层结构，以 ID 形式表示，从全局站点 UUID 开始，到特定站点 UUID 结束。（例如：`globalUuid/areaUuid/buildingUuid/floorUuid`）此字段支持通配符星号（`*`）字符搜索。例如 `*uuid*, *uuid, uuid*` 示例 `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `（请求单个 siteHierarchyId） `?siteHiera rchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUu id2`（请求多个 siteHierarchyIds）。 |
|
SiteId 查询参数。站点的 UUID。（例如：`flooruuid`）示例 `?siteId=id1`（请求单个 ID） `?siteId=id1&siteId=id2&siteId=id3`（请求多个 ID）。 |
|
SortBy 查询参数。响应中要排序的字段。 |
|
StartTime 查询参数。API 从中查询与资源相关的 DataSet 的起始时间。必须以毫秒为单位指定 UNIX 时间戳。值包含在内。如果未提供 `startTime`，API 将默认为当前时间。 |
|
Cisco DNA Center SDK 的标志，用于启用针对 JSON 架构的请求正文验证。 选项
|
|
View 查询参数。请求的特定摘要视图。这是一个可选参数，可以传递它来获取一个或多个与特定视图关联的字段。默认视图是 ``configuration``。### 每个视图提供的响应数据 1. **configuration** id,adminStatus,description,duplexConfig,duplexOper, interfaceIfIndex,interfaceType,ipv4Address,ipv6AddressList,isL3Interface,isWan,macAddress,mediaType,name,ope rStatus, portChannelId,portMode, portType,speed,timestamp,vlanId,networkDeviceId,networkDeviceIpAddress,netw orkDeviceMacAddress,siteName,siteHierarchy,siteHierarchyId 2. **statistics** id,name,rxDiscards,rxError,rxRa te,rxUtilization,txDiscards,txError,txRate,txUtilization,networkDeviceId,networkDeviceIpAddress,networkDevic eMacAddress,siteName,siteHierarchy,siteHierarchyId 3. **stackPort** id,name,peerStackMember,peerStackPort,st ackPortType,networkDeviceId,networkDeviceIpAddress,networkDeviceMacAddress,siteName,siteHierarchy,siteHierar chyId 默认视图为 configuration，如果需要访问其他视图，只需在查询参数中包含视图名称即可。示例 view=configuration（请求单个视图） view=configuration&view=statistic&stackPort（请求多个视图）。 |
注释
注意
使用的SDK方法为 devices.Devices.get_the_interface_data_for_the_given_interface_idinstance_uuid_along_with_the_statistics_data_v1, devices.Devices.gets_interfaces_along_with_statistics_data_from_all_network_devices_v1,
使用的路径为 get /dna/data/api/v1/interfaces, get /dna/data/api/v1/interfaces/{id},
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 文档，关于 Devices GetTheInterfaceDataForTheGivenInterfaceIdinstanceUuidAlongWithTheStatisticsDataV1
GetTheInterfaceDataForTheGivenInterfaceIdinstanceUuidAlongWithTheStatisticsDataV1 API 的完整参考。
- Cisco DNA Center 文档，关于 Devices GetsInterfacesAlongWithStatisticsDataFromAllNetworkDevicesV1
GetsInterfacesAlongWithStatisticsDataFromAllNetworkDevicesV1 API 的完整参考。
示例
- name: Get all Interfaces V1
cisco.dnac.interfaces_v1_info:
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}}"
headers: "{{my_headers | from_json}}"
startTime: 0
endTime: 0
limit: 0
offset: 0
sortBy: string
order: string
siteHierarchy: string
siteHierarchyId: string
siteId: string
view: string
attribute: string
networkDeviceId: string
networkDeviceIpAddress: string
networkDeviceMacAddress: string
interfaceId: string
interfaceName: string
register: result
- name: Get Interfaces V1 by id
cisco.dnac.interfaces_v1_info:
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}}"
headers: "{{my_headers | from_json}}"
startTime: 0
endTime: 0
view: string
attribute: string
id: string
register: result
返回值
常见的返回值已在 此处 记录，以下是此模块独有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回值：始终 示例： |