cisco.dnac.network_device_v1_info 模块 – 网络设备 V1 信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。
要在剧本中使用它，请指定： cisco.dnac.network_device_v1_info。
cisco.dnac 3.1.0 中的新增功能
概要
获取所有网络设备 V1。
按 ID 获取网络设备 V1。
根据筛选条件（例如管理 IP 地址、MAC 地址、主机名等）返回网络设备列表。
返回给定设备 ID 的网络设备详细信息。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
AssociatedWlcIp 查询参数。 |
|
CollectionInterval 查询参数。 |
|
CollectionStatus 查询参数。 |
|
DeviceSupportLevel 查询参数。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
ErrorCode 查询参数。 |
|
ErrorDescription 查询参数。 |
|
Family 查询参数。 |
|
附加标头。 |
|
Hostname 查询参数。 |
|
Id 查询参数。接受逗号分隔的 ID 并返回给定 ID 的网络设备列表。如果提供了无效或未找到的 ID，则列表中将返回 null 条目。 |
|
License.name 查询参数。 |
|
License.status 查询参数。 |
|
License.type 查询参数。 |
|
Limit 查询参数。1 <= limit <= 500 最大。结果中要返回的设备数量。 |
|
Location 查询参数。 |
|
LocationName 查询参数。 |
|
MacAddress 查询参数。 |
|
ManagementIpAddress 查询参数。 |
|
Module+equpimenttype 查询参数。 |
|
Module+name 查询参数。 |
|
Module+operationstatecode 查询参数。 |
|
Module+partnumber 查询参数。 |
|
Module+servicestate 查询参数。 |
|
Module+vendorequipmenttype 查询参数。 |
|
NotSyncedForMinutes 查询参数。 |
|
Offset 查询参数。Offset >= 1 X 表示从第 X 个设备开始的结果。 |
|
PlatformId 查询参数。 |
|
ReachabilityStatus 查询参数。 |
|
Role 查询参数。 |
|
SerialNumber 查询参数。 |
|
Series 查询参数。 |
|
SoftwareType 查询参数。 |
|
SoftwareVersion 查询参数。 |
|
Type 查询参数。 |
|
UpTime 查询参数。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用针对 JSON 架构的请求正文验证。 选项
|
备注
注意
使用的 SDK 方法为 devices.Devices.get_device_by_id_v1、devices.Devices.get_device_list_v1，
使用的路径为 get /dna/intent/api/v1/network-device、get /dna/intent/api/v1/network-device/{id}，
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参见
另请参见
- Cisco DNA Center 设备 GetDeviceByIDV1 文档
GetDeviceByIDV1 API 的完整参考。
- Cisco DNA Center 设备 GetDeviceListV1 文档
GetDeviceListV1 API 的完整参考。
示例
- name: Get all Network Device V1
cisco.dnac.network_device_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}}"
hostname: []
managementIpAddress: []
macAddress: []
locationName: []
serialNumber: []
location: []
family: []
type: []
series: []
collectionStatus: []
collectionInterval: []
notSyncedForMinutes: []
errorCode: []
errorDescription: []
softwareVersion: []
softwareType: []
platformId: []
role: []
reachabilityStatus: []
upTime: []
associatedWlcIp: []
license_name: []
license_type: []
license_status: []
module_name: []
module_equpimenttype: []
module_servicestate: []
module_vendorequipmenttype: []
module_partnumber: []
module_operationstatecode: []
id: string
deviceSupportLevel: string
offset: 0
limit: 0
register: result
- name: Get Network Device V1 by id
cisco.dnac.network_device_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}}"
id: string
register: result
返回值
常见的返回值已在此处记录，以下是此模块独有的字段
键 |
描述 |
|---|---|
Cisco DNAC Python SDK返回的响应的字典或列表 返回值：始终返回 示例： |