cisco.dnac.network_devices_v1_info 模块 – 网络设备 V1 的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在剧本中使用它，请指定：cisco.dnac.network_devices_v1_info。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有网络设备 V1。
按 ID 获取网络设备 V1。
根据提供的查询参数获取网络设备详细信息。当没有指定开始时间和结束时间时，返回最新的设备详细信息。有关 API 使用的详细信息，请参阅 Open API 规范文档 - https //github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml。
返回指定开始和结束时间范围内给定设备 Uuid 的设备数据。当没有指定开始和结束时间时，返回给定 ID 的最新可用数据。有关 API 使用的详细信息，请参阅 Open API 规范文档 - https //github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- AssuranceNetworkDevices-1.0.2-resolved.yaml。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
属性查询参数。网络设备模型属性列表。这有助于指定请求中感兴趣的字段。 |
|
用于启用 Cisco DNA Center SDK 调试的标志。 选择
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
用于启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认值： |
|
EndTime 查询参数。API 查询与资源相关的数据集的结束时间。必须以毫秒为单位的 UNIX epochtime 指定。值是包含性的。 |
|
Family 查询参数。网络设备系列名称列表。示例 family=交换机和集线器（单个网络设备系列名称）family=交换机和集线器&family=路由器&family=无线控制器（带有 & 分隔符的多个网络设备系列名称）。此字段不区分大小写。 |
|
其他标头。 |
|
HealthScore 查询参数。实体健康评分类别列表。示例 healthScore=良好, healthScore=良好&healthScore=一般（带有 & 分隔符的多个实体健康评分值）。此字段不区分大小写。 |
|
Id 查询参数。实体 Uuid 列表。（例如“6bef213c-19ca-4170-8375-b694e251101c”）示例 id=6bef213c-19ca-4170-8375-b694e251101c（请求单个实体 uuid）id=6bef213c-19ca-4170-8375- b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0（带有“&”分隔符的多个实体 uuid）。 |
|
Limit 查询参数。要返回的最大记录数。 |
|
MacAddress 查询参数。网络设备或客户端的 macAddress。此字段支持基于通配符（`*`）字符的搜索。例如 `*AB AB AB*` 或 `AB AB AB*` 或 `*AB AB AB` 示例 `macAddress=AB AB AB CD CD CD`（请求单个 macAddress）`macAddress=AB AB AB CD CD DC&macAddress=AB AB AB CD CD FE`（请求多个 macAddress）。 |
|
MaintenanceMode 查询参数。设备 maintenanceMode 状态 true 或 false。 选择
|
|
ManagementIpAddress 查询参数。实体管理 IP 地址列表。它可以是 Ipv4 或 Ipv6 地址，或两者的组合（例如“121.1.1.10”）。此字段支持基于通配符（`*`）字符的搜索。例如 `*1.1*` 或 `1.1*` 或 `*1.1` 示例 managementIpAddresses=121.1.1.10 managementIpAddresses=121.1.1.10&managementIpAddresses=172.20.1.10&managementIpAddresses=200 10&=managementIpAddresses172.20.3.4（带有 & 分隔符的多个实体 IP 地址）。 |
|
Offset 查询参数。指定 API 返回的所有记录中的起始点。它是一个基于 1 的偏移量。起始值为 1。 |
|
Order 查询参数。字段的排序顺序为升序或降序。 |
|
Role 查询参数。网络设备角色列表。示例 role=核心, role=核心&role=访问&role=路由器（带有 & 分隔符的多个网络设备角色）。此字段不区分大小写。 |
|
SerialNumber 查询参数。网络设备序列号列表。此字段支持基于通配符（`*`）字符的搜索。例如 `*MS1SV*` 或 `MS1SV*` 或 `*MS1SV` 示例 serialNumber=9FUFMS1SVAX serialNumber=9FUFMS1SVAX&FCW2333Q0BY&FJC240617JX（带有 & 分隔符的多个网络设备序列号）。 |
|
SiteHierarchy 查询参数。站点树的完整层次结构细分，从全局站点名称开始，到特定站点名称结束。根站点名为“全局”（例如 `Global/AreaName/BuildingName/FloorName`）。此字段支持通配符星号 (*) 字符搜索。例如，*/San*、*/San、/San* 示例 `?siteHierarchy=Global/AreaName/BuildingName/FloorName`（请求单个 siteHierarchy）`?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaNam e2/BuildingName2/FloorName2`（请求多个 siteHierarchy）。 |
|
SiteHierarchyId 查询参数。站点树的完整层级结构，以 ID 形式表示，从全局站点 UUID 开始，到特定站点 UUID 结束。（例如：`globalUuid/areaUuid/buildingUuid/floorUuid`）此字段支持通配符星号 (*) 字符搜索。例如：`*uuid*, *uuid, uuid*`。示例：`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid` (请求单个 siteHierarchyId) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (请求多个 siteHierarchyIds)。 |
|
SiteId 查询参数。站点的 UUID。（例如：`flooruuid`）此字段支持通配符星号 (*) 字符搜索。例如：`*flooruuid*, *flooruuid, flooruuid*`。示例：`?siteId=id1` (请求单个 ID) `?siteId=id1&siteId=id2&siteId=id3` (请求多个 ID)。 |
|
SoftwareVersion 查询参数。网络设备软件版本列表。此字段支持基于通配符 (`*`) 字符的搜索。例如：`*17.8*` 或 `*17.8` 或 `17.8*`。示例：softwareVersion=2.3.4.0（单个网络设备软件版本）softwareVersion=17.9.3.23&softwareVersion=17.7.1.2&softwareVersion=*.17.7（使用 & 分隔符的多个网络设备软件版本）。 |
|
SortBy 查询参数。响应中用于排序的字段。 |
|
StartTime 查询参数。API 查询与资源相关的数据集的起始时间。必须以 UNIX 纪元时间（毫秒）为单位指定。该值是包含在内的。如果未提供 `startTime`，API 将默认为当前时间。 |
|
Type 查询参数。网络设备类型列表。此字段支持基于通配符 (`*`) 字符的搜索。例如：`*9407R*` 或 `*9407R` 或 `9407R*`。示例：type=SwitchesCisco Catalyst 9407R Switch（单个网络设备类型）type=Cisco Catalyst 38xx stack-able ethernet switch&type=Cisco 3945 Integrated Services Router G2（使用 & 分隔符的多个网络设备类型）。 |
|
Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求主体。 选择
|
|
View 查询参数。网络设备模型视图列表。请参阅 ```NetworkDeviceView``` 以获取支持的列表。 |
注意
注意
使用的 SDK 方法是 devices.Devices.get_the_device_data_for_the_given_device_id_uuid_v1，devices.Devices.gets_the_network_device_details_based_on_the_provided_query_parameters_v1，
使用的路径是 get /dna/data/api/v1/networkDevices，get /dna/data/api/v1/networkDevices/{id}，
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中嵌入的连接管理器。
以 dnac_ 开头的参数供 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 文档，了解 Devices GetTheDeviceDataForTheGivenDeviceIdUuidV1
GetTheDeviceDataForTheGivenDeviceIdUuidV1 API 的完整参考。
- Cisco DNA Center 文档，了解 Devices GetsTheNetworkDeviceDetailsBasedOnTheProvidedQueryParametersV1
GetsTheNetworkDeviceDetailsBasedOnTheProvidedQueryParametersV1 API 的完整参考。
示例
- name: Get all Network Devices V1
cisco.dnac.network_devices_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
id: string
managementIpAddress: string
macAddress: string
family: string
type: string
role: string
serialNumber: string
maintenanceMode: True
softwareVersion: string
healthScore: string
view: string
attribute: string
register: result
- name: Get Network Devices V1 by id
cisco.dnac.network_devices_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 返回的响应的字典或列表 已返回： 始终 示例： |