cisco.catalystcenter.pnp_device_info module -- Information module for Pnp Device
Note
This module is part of the cisco.catalystcenter collection (version 2.3.1).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.pnp_device_info.
New in cisco.catalystcenter 3.1.0
Synopsis
Get all Pnp Device.
Get Pnp Device by id.
Returns device details specified by device id. - > Returns list of devices from Plug & Play based on filter criteria. Returns 50 devices by default. This endpoint supports Pagination and Sorting.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.1.6.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Additional headers. |
|
Hostname query parameter. Device Hostname. |
|
Id path parameter. |
|
LastContact query parameter. Device Has Contacted lastContact > 0. Choices: |
|
Limit query parameter. The number of records to show for this page. The minimum and maximum values are 0 and 500, respectively. |
|
MacAddress query parameter. Device Mac Address. |
|
Name query parameter. Device Name. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 0. The Minimum value is 0. |
|
OnbState query parameter. Device Onboarding State. |
|
Pid query parameter. Device ProductId. |
|
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 Catalyst 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 uses the embedded connection manager from Cisco CATALYST SDK
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) GetDeviceListSiteManagement
Complete reference of the GetDeviceListSiteManagement API.
Examples
---
- name: Get all Pnp Device
cisco.catalystcenter.pnp_device_info:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_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 by id
cisco.catalystcenter.pnp_device_info:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_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 |
|---|---|