cisco.dnac.pnp_device_info 模块 – PnP 设备信息信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在剧本中使用它，请指定：cisco.dnac.pnp_device_info。
cisco.dnac 3.1.0 中的新增功能
概要
此模块代表模块 pnp_device_v1_info 的别名。
注意
此模块具有相应的 action 插件。
要求
在执行此模块的主机上需要以下要求。
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。 默认值： |
|
附加头。 |
|
主机名查询参数。设备主机名。 |
|
Id 路径参数。 |
|
LastContact 查询参数。设备已联系 lastContact > 0。 选项
|
|
Limit 查询参数。限制结果数量。 |
|
MacAddress 查询参数。设备 MAC 地址。 |
|
Name 查询参数。设备名称。 |
|
Offset 查询参数。第一个结果的索引。 |
|
OnbState 查询参数。设备上线状态。 |
|
Pid 查询参数。设备产品 ID。 |
|
SerialNumber 查询参数。设备序列号。 |
|
SiteName 查询参数。设备站点名称。 |
|
SmartAccountId 查询参数。设备智能帐户。 |
|
Sort 查询参数。要排序的字段的逗号分隔列表。 |
|
SortOrder 查询参数。排序顺序升序 (asc) 或降序 (des)。 |
|
Source 查询参数。设备来源。 |
|
State 查询参数。设备状态。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
|
VirtualAccountId 查询参数。设备虚拟帐户。 |
|
WorkflowId 查询参数。设备工作流程 ID。 |
|
WorkflowName 查询参数。设备工作流程名称。 |
注释
注意
使用的 SDK 方法是 device_onboarding_pnp.DeviceOnboardingPnp.get_device_by_id_v1、device_onboarding_pnp.DeviceOnboardingPnp.get_device_list，
使用的路径是 get /dna/intent/api/v1/onboarding/pnp-device、get /dna/intent/api/v1/onboarding/pnp-device/{id}，
需要注意的是，此模块是 pnp_device_v1_info 的别名。
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 设备上线 (PnP) GetDeviceByIdV1 文档
GetDeviceByIdV1 API 的完整参考。
- Cisco DNA Center 设备上线 (PnP) GetDeviceListSiteManagementV1 文档
GetDeviceListSiteManagementV1 API 的完整参考。
示例
- name: Get all Pnp Device Info
cisco.dnac.pnp_device_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}}"
limit: 0
offset: 0
sort: []
sortOrder: string
serialNumber: []
state_: []
onbState: []
name: []
pid: []
source: []
workflowId: []
workflowName: []
smartAccountId: []
virtualAccountId: []
lastContact: True
macAddress: string
hostname: string
siteName: string
register: result
- name: Get Pnp Device Info by id
cisco.dnac.pnp_device_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返回的响应的字典或列表 返回值：始终返回 Sample: |