cisco.dnac.pnp_intent module – Resource module for Site and PnP related functions
Note
This module is part of the cisco.dnac collection (version 6.6.1).
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_intent
.
New in cisco.dnac 6.6.0
Synopsis
Manage operations add device, claim device and unclaim device of Onboarding Configuration(PnP) resource
API to add device to pnp inventory and claim it to a site.
API to delete device from the pnp inventory.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk == 2.4.5
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
List of details of device being managed. |
|
Pnp Device’s deviceInfo. |
|
Pnp Device’s aaaCredentials. |
|
Pnp Device’s password. |
|
Pnp Device’s username. |
|
Pnp Device’s addedOn. |
|
Pnp Device’s addnMacAddrs. |
|
Pnp Device’s agentType. |
|
Pnp Device’s authenticatedSudiSerialNo. |
|
Pnp Device’s authStatus. |
|
Pnp Device’s capabilitiesSupported. |
|
Pnp Device’s cmState. |
|
Pnp Device’s description. |
|
Pnp Device’s deviceSudiSerialNos. |
|
Pnp Device’s deviceType. |
|
Pnp Device’s featuresSupported. |
|
Pnp Device’s fileSystemList. |
|
Pnp Device’s freespace. |
|
Pnp Device’s name. |
|
Readable flag. Choices:
|
|
Pnp Device’s size. |
|
Pnp Device’s type. |
|
Writeable flag. Choices:
|
|
Pnp Device’s firstContact. |
|
Pnp Device’s hostname. |
|
Pnp Device’s httpHeaders. |
|
Pnp Device’s key. |
|
Pnp Device’s value. |
|
Pnp Device’s imageFile. |
|
Pnp Device’s imageVersion. |
|
Pnp Device’s ipInterfaces. |
|
Pnp Device’s ipv4Address. |
|
Pnp Device’s ipv6AddressList. |
|
Pnp Device’s macAddress. |
|
Pnp Device’s name. |
|
Pnp Device’s status. |
|
Pnp Device’s lastContact. |
|
Pnp Device’s lastSyncTime. |
|
Pnp Device’s lastUpdateOn. |
|
Pnp Device’s location. |
|
Pnp Device’s address. |
|
Pnp Device’s altitude. |
|
Pnp Device’s latitude. |
|
Pnp Device’s longitude. |
|
Pnp Device’s siteId. |
|
Pnp Device’s macAddress. |
|
Pnp Device’s mode. |
|
Pnp Device’s name. |
|
Pnp Device’s neighborLinks. |
|
Pnp Device’s localInterfaceName. |
|
Pnp Device’s localMacAddress. |
|
Pnp Device’s localShortInterfaceName. |
|
Pnp Device’s remoteDeviceName. |
|
Pnp Device’s remoteInterfaceName. |
|
Pnp Device’s remoteMacAddress. |
|
Pnp Device’s remotePlatform. |
|
Pnp Device’s remoteShortInterfaceName. |
|
Pnp Device’s remoteVersion. |
|
Pnp Device’s onbState. |
|
Pnp Device’s pid. |
|
Pnp Device’s pnpProfileList. |
|
Pnp Device’s createdBy. |
|
DiscoveryCreated flag. Choices:
|
|
Pnp Device’s primaryEndpoint. |
|
Pnp Device’s certificate. |
|
Pnp Device’s fqdn. |
|
Pnp Device’s ipv4Address. |
|
Pnp Device’s ipv6Address. |
|
Pnp Device’s port. |
|
Pnp Device’s protocol. |
|
Pnp Device’s profileName. |
|
Pnp Device’s secondaryEndpoint. |
|
Pnp Device’s certificate. |
|
Pnp Device’s fqdn. |
|
Pnp Device’s ipv4Address. |
|
Pnp Device’s ipv6Address. |
|
Pnp Device’s port. |
|
Pnp Device’s protocol. |
|
PopulateInventory flag. Choices:
|
|
Pnp Device’s preWorkflowCliOuputs. |
|
Pnp Device’s cli. |
|
Pnp Device’s cliOutput. |
|
Pnp Device’s projectId. |
|
Pnp Device’s projectName. |
|
ReloadRequested flag. Choices:
|
|
Pnp Device’s serialNumber. |
|
Pnp Device’s smartAccountId. |
|
Pnp Device’s source. |
|
Stack flag. Choices:
|
|
Pnp Device’s stackInfo. |
|
IsFullRing flag. Choices:
|
|
Pnp Device’s stackMemberList. |
|
Pnp Device’s hardwareVersion. |
|
Pnp Device’s licenseLevel. |
|
Pnp Device’s licenseType. |
|
Pnp Device’s macAddress. |
|
Pnp Device’s pid. |
|
Pnp Device’s priority. |
|
Pnp Device’s role. |
|
Pnp Device’s serialNumber. |
|
Pnp Device’s softwareVersion. |
|
Pnp Device’s stackNumber. |
|
Pnp Device’s state. |
|
Pnp Device’s sudiSerialNumber. |
|
Pnp Device’s stackRingProtocol. |
|
SupportsStackWorkflows flag. Choices:
|
|
Pnp Device’s totalMemberCount. |
|
Pnp Device’s validLicenseLevels. |
|
Pnp Device’s state. |
|
SudiRequired flag. Choices:
|
|
Pnp Device’s tags. |
|
Pnp Device’s userSudiSerialNos. |
|
Pnp Device’s virtualAccountId. |
|
Pnp Device’s workflowId. |
|
Pnp Device’s workflowName. |
|
Is the image to be condifgured tagged as golden image Choices:
|
|
Name of image to be configured on the device |
|
Name of the site for which device will be claimed. |
|
Name of template to be configured on the device. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
Flag for logging playbook execution details. If set to true the log file will be created at the location of the execution with the name dnac.log Choices:
|
|
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: |
|
The state of DNAC after module completion. Choices:
|
|
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.claim_a_device_to_a_site, device_onboarding_pnp.DeviceOnboardingPnp.delete_device_by_id_from_pnp,
Paths used are post /dna/intent/api/v1/onboarding/pnp-device post /dna/intent/api/v1/onboarding/pnp-device/site-claim post /dna/intent/api/v1/onboarding/pnp-device/{id}
Does not support
check_mode
The 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
Examples
- name: Add a new device and claim the device
cisco.dnac.pnp_intent:
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}}"
dnac_log: True
state: merged
config:
template_name: string
image_name: string
site_name: string
deviceInfo:
aaaCredentials:
password: string
username: string
addedOn: 0
addnMacAddrs:
- string
agentType: string
authStatus: string
authenticatedSudiSerialNo: string
capabilitiesSupported:
- string
cmState: string
description: string
deviceSudiSerialNos:
- string
deviceType: string
featuresSupported:
- string
fileSystemList:
- freespace: 0
name: string
readable: true
size: 0
type: string
writeable: true
firstContact: 0
hostname: string
httpHeaders:
- key: string
value: string
imageFile: string
imageVersion: string
ipInterfaces:
- ipv4Address: {}
ipv6AddressList:
- {}
macAddress: string
name: string
status: string
lastContact: 0
lastSyncTime: 0
lastUpdateOn: 0
location:
address: string
altitude: string
latitude: string
longitude: string
siteId: string
macAddress: string
mode: string
name: string
neighborLinks:
- localInterfaceName: string
localMacAddress: string
localShortInterfaceName: string
remoteDeviceName: string
remoteInterfaceName: string
remoteMacAddress: string
remotePlatform: string
remoteShortInterfaceName: string
remoteVersion: string
onbState: string
pid: string
pnpProfileList:
- createdBy: string
discoveryCreated: true
primaryEndpoint:
certificate: string
fqdn: string
ipv4Address: {}
ipv6Address: {}
port: 0
protocol: string
profileName: string
secondaryEndpoint:
certificate: string
fqdn: string
ipv4Address: {}
ipv6Address: {}
port: 0
protocol: string
populateInventory: true
preWorkflowCliOuputs:
- cli: string
cliOutput: string
projectId: string
projectName: string
reloadRequested: true
serialNumber: string
smartAccountId: string
source: 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
state: string
sudiRequired: true
tags: {}
userSudiSerialNos:
- string
virtualAccountId: string
workflowId: string
workflowName: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |
|
A list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |
|
A string with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |
Authors
Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary)