cisco.dnac.pnp_device_v1 module – Resource module for Pnp Device V1
Note
This module is part of the cisco.dnac collection (version 6.25.0).
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_v1.
New in cisco.dnac 3.1.0
Synopsis
Manage operations create, update and delete of the resource Pnp Device V1.
Adds a device to the PnP database.
Deletes specified device from PnP database.
Updates device details specified by device id in PnP database.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Pnp Device’s deviceInfo. |
|
Description. |
|
Device Sudi Serial Nos. |
|
Hostname. |
|
Mac Address. |
|
Pid. |
|
Serial Number. |
|
Site Id. |
|
Stack. Choices:
|
|
Pnp Device’s stackInfo. |
|
Is Full Ring. Choices:
|
|
Pnp Device’s stackMemberList. |
|
Hardware Version. |
|
License Level. |
|
License Type. |
|
Mac Address. |
|
Pid. |
|
Priority. |
|
Role. |
|
Serial Number. |
|
Software Version. |
|
Stack Number. |
|
State. |
|
Sudi Serial Number. |
|
Stack Ring Protocol. |
|
Supports Stack Workflows. Choices:
|
|
Total Member Count. |
|
Valid License Levels. |
|
Is Sudi Required. Choices:
|
|
User Mic Numbers. |
|
List of Secure Unique Device Identifier (SUDI) serial numbers to perform SUDI authorization, Required if sudiRequired is true. |
|
Workflow Id. |
|
Workflow Name. |
|
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: |
|
Id. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.add_device, device_onboarding_pnp.DeviceOnboardingPnp.delete_device_by_id_from_pnp_v1, device_onboarding_pnp.DeviceOnboardingPnp.update_device_v1,
Paths used are post /dna/intent/api/v1/onboarding/pnp-device, delete /dna/intent/api/v1/onboarding/pnp-device/{id}, put /dna/intent/api/v1/onboarding/pnp-device/{id},
Does not support
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) AddDeviceV1
Complete reference of the AddDeviceV1 API.
- Cisco DNA Center documentation for Device Onboarding (PnP) DeleteDeviceByIdFromPnPV1
Complete reference of the DeleteDeviceByIdFromPnPV1 API.
- Cisco DNA Center documentation for Device Onboarding (PnP) UpdateDeviceV1
Complete reference of the UpdateDeviceV1 API.
Examples
- name: Create
cisco.dnac.pnp_device_v1:
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}}"
state: present
deviceInfo:
description: string
deviceSudiSerialNos:
- string
hostname: string
macAddress: string
pid: string
serialNumber: string
siteId: string
stack: true
stackInfo:
isFullRing: true
stackMemberList:
- hardwareVersion: string
licenseLevel: string
licenseType: string
macAddress: string
pid: string
priority: 0
role: string
serialNumber: string
softwareVersion: string
stackNumber: 0
state: string
sudiSerialNumber: string
stackRingProtocol: string
supportsStackWorkflows: true
totalMemberCount: 0
validLicenseLevels:
- string
sudiRequired: true
userMicNumbers:
- string
userSudiSerialNos:
- string
workflowId: string
workflowName: string
- name: Update by id
cisco.dnac.pnp_device_v1:
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}}"
state: present
deviceInfo:
hostname: string
pid: string
serialNumber: string
stack: true
sudiRequired: true
userSudiSerialNos:
- string
id: string
- name: Delete by id
cisco.dnac.pnp_device_v1:
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}}"
state: absent
id: string
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: |