cisco.dnac.pnp_device_info module – Information module for Pnp Device
Note
This module is part of the cisco.dnac collection (version 6.13.3).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.pnp_device_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Pnp Device.
Get Pnp Device by id.
Returns device details specified by device id.
Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.6.0
python >= 3.9
Parameters
Parameter |
Comments |
|---|---|
CmState query parameter. Device Connection Manager State. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
Hostname query parameter. Device Hostname. |
|
Id path parameter. |
|
LastContact query parameter. Device Has Contacted lastContact > 0. Choices:
|
|
Limit query parameter. Limits number of results. |
|
MacAddress query parameter. Device Mac Address. |
|
Name query parameter. Device Name. |
|
Offset query parameter. Index of first result. |
|
OnbState query parameter. Device Onboarding State. |
|
Pid query parameter. Device ProductId. |
|
ProjectId query parameter. Device Project Id. |
|
ProjectName query parameter. Device Project Name. |
|
SerialNumber query parameter. Device Serial Number. |
|
SiteName query parameter. Device Site Name. |
|
SmartAccountId query parameter. Device Smart Account. |
|
Sort query parameter. Comma seperated list of fields to sort on. |
|
SortOrder query parameter. Sort Order Ascending (asc) or Descending (des). |
|
Source query parameter. Device Source. |
|
State query parameter. Device State. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
VirtualAccountId query parameter. Device Virtual Account. |
|
WorkflowId query parameter. Device Workflow Id. |
|
WorkflowName query parameter. Device Workflow Name. |
Notes
Note
SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.get_device_by_id, device_onboarding_pnp.DeviceOnboardingPnp.get_device_list,
Paths used are get /dna/intent/api/v1/onboarding/pnp-device, get /dna/intent/api/v1/onboarding/pnp-device/{id},
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Device Onboarding (PnP) GetDeviceById
Complete reference of the GetDeviceById API.
- Cisco DNA Center documentation for Device Onboarding (PnP) GetDeviceList2
Complete reference of the GetDeviceList2 API.
Examples
- name: Get all Pnp Device
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: []
cmState: []
name: []
pid: []
source: []
projectId: []
workflowId: []
projectName: []
workflowName: []
smartAccountId: []
virtualAccountId: []
lastContact: True
macAddress: string
hostname: string
siteName: string
register: result
- name: Get Pnp Device 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |