cisco.dnac.pnp_device_import module -- Resource module for Pnp Device Import
Note
This module is part of the cisco.dnac collection (version 6.13.0).
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_import.
New in cisco.dnac 3.1.0
Synopsis
Manage operation create of the resource Pnp Device Import.
Add devices to PnP in bulk.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.5.5
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
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: :ansible-option-default:`443` |
|
The Cisco DNA 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 DNA Center to use. Default: :ansible-option-default:`"2.3.5.3"` |
|
Pnp Device Import's payload. |
|
Pnp Device Import's _id. |
|
Pnp Device Import's deviceInfo. |
|
Pnp Device Import's aaaCredentials. |
|
Pnp Device Import's password. |
|
Pnp Device Import's username. |
|
Pnp Device Import's addedOn. |
|
Pnp Device Import's addnMacAddrs. |
|
Pnp Device Import's agentType. |
|
Pnp Device Import's authenticatedSudiSerialNo. |
|
Pnp Device Import's authStatus. |
|
Pnp Device Import's capabilitiesSupported. |
|
Pnp Device Import's cmState. |
|
Pnp Device Import's description. |
|
Pnp Device Import's deviceSudiSerialNos. |
|
Pnp Device Import's deviceType. |
|
Pnp Device Import's featuresSupported. |
|
Pnp Device Import's fileSystemList. |
|
Pnp Device Import's freespace. |
|
Pnp Device Import's name. |
|
Pnp Device Import's size. |
|
Pnp Device Import's type. |
|
Pnp Device Import's firstContact. |
|
Pnp Device Import's hostname. |
|
Pnp Device Import's httpHeaders. |
|
Pnp Device Import's key. |
|
Pnp Device Import's value. |
|
Pnp Device Import's imageFile. |
|
Pnp Device Import's imageVersion. |
|
Pnp Device Import's ipInterfaces. |
|
Pnp Device Import's ipv4Address. |
|
Pnp Device Import's ipv6AddressList. |
|
Pnp Device Import's macAddress. |
|
Pnp Device Import's name. |
|
Pnp Device Import's status. |
|
Pnp Device Import's lastContact. |
|
Pnp Device Import's lastSyncTime. |
|
Pnp Device Import's lastUpdateOn. |
|
Pnp Device Import's location. |
|
Pnp Device Import's address. |
|
Pnp Device Import's altitude. |
|
Pnp Device Import's latitude. |
|
Pnp Device Import's longitude. |
|
Pnp Device Import's siteId. |
|
Pnp Device Import's macAddress. |
|
Pnp Device Import's mode. |
|
Pnp Device Import's name. |
|
Pnp Device Import's neighborLinks. |
|
Pnp Device Import's localInterfaceName. |
|
Pnp Device Import's localMacAddress. |
|
Pnp Device Import's localShortInterfaceName. |
|
Pnp Device Import's remoteDeviceName. |
|
Pnp Device Import's remoteInterfaceName. |
|
Pnp Device Import's remoteMacAddress. |
|
Pnp Device Import's remotePlatform. |
|
Pnp Device Import's remoteShortInterfaceName. |
|
Pnp Device Import's remoteVersion. |
|
Pnp Device Import's onbState. |
|
Pnp Device Import's pid. |
|
Pnp Device Import's pnpProfileList. |
|
Pnp Device Import's createdBy. |
|
DiscoveryCreated flag. Choices: |
|
Pnp Device Import's primaryEndpoint. |
|
Pnp Device Import's certificate. |
|
Pnp Device Import's fqdn. |
|
Pnp Device Import's ipv4Address. |
|
Pnp Device Import's ipv6Address. |
|
Pnp Device Import's port. |
|
Pnp Device Import's protocol. |
|
Pnp Device Import's profileName. |
|
Pnp Device Import's secondaryEndpoint. |
|
Pnp Device Import's certificate. |
|
Pnp Device Import's fqdn. |
|
Pnp Device Import's ipv4Address. |
|
Pnp Device Import's ipv6Address. |
|
Pnp Device Import's port. |
|
Pnp Device Import's protocol. |
|
PopulateInventory flag. Choices: |
|
Pnp Device Import's preWorkflowCliOuputs. |
|
Pnp Device Import's cli. |
|
Pnp Device Import's cliOutput. |
|
Pnp Device Import's projectId. |
|
Pnp Device Import's projectName. |
|
ReloadRequested flag. Choices: |
|
Pnp Device Import's serialNumber. |
|
Pnp Device Import's smartAccountId. |
|
Pnp Device Import's source. |
|
Pnp Device Import's stackInfo. |
|
IsFullRing flag. Choices: |
|
Pnp Device Import's stackMemberList. |
|
Pnp Device Import's hardwareVersion. |
|
Pnp Device Import's licenseLevel. |
|
Pnp Device Import's licenseType. |
|
Pnp Device Import's macAddress. |
|
Pnp Device Import's pid. |
|
Pnp Device Import's priority. |
|
Pnp Device Import's role. |
|
Pnp Device Import's serialNumber. |
|
Pnp Device Import's softwareVersion. |
|
Pnp Device Import's stackNumber. |
|
Pnp Device Import's state. |
|
Pnp Device Import's sudiSerialNumber. |
|
Pnp Device Import's stackRingProtocol. |
|
SupportsStackWorkflows flag. Choices: |
|
Pnp Device Import's totalMemberCount. |
|
Pnp Device Import's validLicenseLevels. |
|
Pnp Device Import's state. |
|
SudiRequired flag. Choices: |
|
Pnp Device Import's tags. |
|
Pnp Device Import's userSudiSerialNos. |
|
Pnp Device Import's virtualAccountId. |
|
Pnp Device Import's workflowId. |
|
Pnp Device Import's workflowName. |
|
Pnp Device Import's runSummaryList. |
|
Pnp Device Import's details. |
|
Pnp Device Import's historyTaskInfo. |
|
Pnp Device Import's addnDetails. |
|
Pnp Device Import's key. |
|
Pnp Device Import's value. |
|
Pnp Device Import's name. |
|
Pnp Device Import's timeTaken. |
|
Pnp Device Import's type. |
|
Pnp Device Import's workItemList. |
|
Pnp Device Import's command. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's outputStr. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's timeTaken. |
|
Pnp Device Import's timestamp. |
|
Pnp Device Import's systemResetWorkflow. |
|
Pnp Device Import's _id. |
|
Pnp Device Import's addedOn. |
|
AddToInventory flag. Choices: |
|
Pnp Device Import's configId. |
|
Pnp Device Import's currTaskIdx. |
|
Pnp Device Import's description. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's execTime. |
|
Pnp Device Import's imageId. |
|
Pnp Device Import's instanceType. |
|
Pnp Device Import's lastupdateOn. |
|
Pnp Device Import's name. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's tasks. |
|
Pnp Device Import's currWorkItemIdx. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's name. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's taskSeqNo. |
|
Pnp Device Import's timeTaken. |
|
Pnp Device Import's type. |
|
Pnp Device Import's workItemList. |
|
Pnp Device Import's command. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's outputStr. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's timeTaken. |
|
Pnp Device Import's tenantId. |
|
Pnp Device Import's type. |
|
Pnp Device Import's useState. |
|
Pnp Device Import's version. |
|
Pnp Device Import's systemWorkflow. |
|
Pnp Device Import's _id. |
|
Pnp Device Import's addedOn. |
|
AddToInventory flag. Choices: |
|
Pnp Device Import's configId. |
|
Pnp Device Import's currTaskIdx. |
|
Pnp Device Import's description. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's execTime. |
|
Pnp Device Import's imageId. |
|
Pnp Device Import's instanceType. |
|
Pnp Device Import's lastupdateOn. |
|
Pnp Device Import's name. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's tasks. |
|
Pnp Device Import's currWorkItemIdx. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's name. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's taskSeqNo. |
|
Pnp Device Import's timeTaken. |
|
Pnp Device Import's type. |
|
Pnp Device Import's workItemList. |
|
Pnp Device Import's command. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's outputStr. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's timeTaken. |
|
Pnp Device Import's tenantId. |
|
Pnp Device Import's type. |
|
Pnp Device Import's useState. |
|
Pnp Device Import's version. |
|
Pnp Device Import's tenantId. |
|
Pnp Device Import's version. |
|
Pnp Device Import's workflow. |
|
Pnp Device Import's _id. |
|
Pnp Device Import's addedOn. |
|
AddToInventory flag. Choices: |
|
Pnp Device Import's configId. |
|
Pnp Device Import's currTaskIdx. |
|
Pnp Device Import's description. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's execTime. |
|
Pnp Device Import's imageId. |
|
Pnp Device Import's instanceType. |
|
Pnp Device Import's lastupdateOn. |
|
Pnp Device Import's name. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's tasks. |
|
Pnp Device Import's currWorkItemIdx. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's name. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's taskSeqNo. |
|
Pnp Device Import's timeTaken. |
|
Pnp Device Import's type. |
|
Pnp Device Import's workItemList. |
|
Pnp Device Import's command. |
|
Pnp Device Import's endTime. |
|
Pnp Device Import's outputStr. |
|
Pnp Device Import's startTime. |
|
Pnp Device Import's state. |
|
Pnp Device Import's timeTaken. |
|
Pnp Device Import's tenantId. |
|
Pnp Device Import's type. |
|
Pnp Device Import's useState. |
|
Pnp Device Import's version. |
|
Pnp Device Import's workflowParameters. |
|
Pnp Device Import's configList. |
|
Pnp Device Import's configId. |
|
Pnp Device Import's configParameters. |
|
Pnp Device Import's key. |
|
Pnp Device Import's value. |
|
Pnp Device Import's licenseLevel. |
|
Pnp Device Import's licenseType. |
|
Pnp Device Import's topOfStackSerialNumber. |
|
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.import_devices_in_bulk,
Paths used are post /dna/intent/api/v1/onboarding/pnp-device/import,
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) ImportDevicesInBulk
Complete reference of the ImportDevicesInBulk API.
Examples
- name: Create
cisco.dnac.pnp_device_import:
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}}"
payload:
- _id: 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
runSummaryList:
- details: string
errorFlag: true
historyTaskInfo:
addnDetails:
- key: string
value: string
name: string
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
timestamp: 0
systemResetWorkflow:
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
systemWorkflow:
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
tenantId: string
version: 0
workflow:
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
workflowParameters:
configList:
- configId: string
configParameters:
- key: string
value: string
licenseLevel: string
licenseType: string
topOfStackSerialNumber: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|