cisco.dnac.pnp_device_import – Resource module for Pnp Device Import
Note
This plugin is part of the cisco.dnac collection (version 4.1.2).
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
.
To use it in a playbook, specify: cisco.dnac.pnp_device_import
.
New in version 3.1.0: of cisco.dnac
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.4.0
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: 443 |
|
The Cisco DNA Center username to authenticate. Default: “admin” |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.3.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. |
|
Readable flag. Choices:
|
|
Pnp Device Import’s size. |
|
Pnp Device Import’s type. |
|
Writeable flag. Choices:
|
|
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. |
|
Stack flag. Choices:
|
|
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. |
|
ErrorFlag flag. Choices:
|
|
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_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: 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:
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: “{\n \”successList\”: [\n {\n \”_id\”: \”string\”,\n \”deviceInfo\”: {\n \”source\”: \”string\”,\n \”serialNumber\”: \”string\”,\n \”stack\”: true,\n \”mode\”: \”string\”,\n \”state\”: \”string\”,\n \”location\”: {\n \”siteId\”: \”string\”,\n \”address\”: \”string\”,\n \”latitude\”: \”string\”,\n \”longitude\”: \”string\”,\n \”altitude\”: \”string\”\n },\n \”description\”: \”string\”,\n \”onbState\”: \”string\”,\n \”authenticatedMicNumber\”: \”string\”,\n \”authenticatedSudiSerialNo\”: \”string\”,\n \”capabilitiesSupported\”: [\n \”string\”\n ],\n \”featuresSupported\”: [\n \”string\”\n ],\n \”cmState\”: \”string\”,\n \”firstContact\”: 0,\n \”lastContact\”: 0,\n \”macAddress\”: \”string\”,\n \”pid\”: \”string\”,\n \”deviceSudiSerialNos\”: [\n \”string\”\n ],\n \”lastUpdateOn\”: 0,\n \”workflowId\”: \”string\”,\n \”workflowName\”: \”string\”,\n \”projectId\”: \”string\”,\n \”projectName\”: \”string\”,\n \”deviceType\”: \”string\”,\n \”agentType\”: \”string\”,\n \”imageVersion\”: \”string\”,\n \”fileSystemList\”: [\n {\n \”type\”: \”string\”,\n \”writeable\”: true,\n \”freespace\”: 0,\n \”name\”: \”string\”,\n \”readable\”: true,\n \”size\”: 0\n }\n ],\n \”pnpProfileList\”: [\n {\n \”profileName\”: \”string\”,\n \”discoveryCreated\”: true,\n \”createdBy\”: \”string\”,\n \”primaryEndpoint\”: {\n \”port\”: 0,\n \”protocol\”: \”string\”,\n \”ipv4Address\”: {},\n \”ipv6Address\”: {},\n \”fqdn\”: \”string\”,\n \”certificate\”: \”string\”\n },\n \”secondaryEndpoint\”: {\n \”port\”: 0,\n \”protocol\”: \”string\”,\n \”ipv4Address\”: {},\n \”ipv6Address\”: {},\n \”fqdn\”: \”string\”,\n \”certificate\”: \”string\”\n }\n }\n ],\n \”imageFile\”: \”string\”,\n \”httpHeaders\”: [\n {\n \”key\”: \”string\”,\n \”value\”: \”string\”\n }\n ],\n \”neighborLinks\”: [\n {\n \”localInterfaceName\”: \”string\”,\n \”localShortInterfaceName\”: \”string\”,\n \”localMacAddress\”: \”string\”,\n \”remoteInterfaceName\”: \”string\”,\n \”remoteShortInterfaceName\”: \”string\”,\n \”remoteMacAddress\”: \”string\”,\n \”remoteDeviceName\”: \”string\”,\n \”remotePlatform\”: \”string\”,\n \”remoteVersion\”: \”string\”\n }\n ],\n \”lastSyncTime\”: 0,\n \”ipInterfaces\”: [\n {\n \”status\”: \”string\”,\n \”macAddress\”: \”string\”,\n \”ipv4Address\”: {},\n \”ipv6AddressList\”: [],\n \”name\”: \”string\”\n }\n ],\n \”hostname\”: \”string\”,\n \”authStatus\”: \”string\”,\n \”stackInfo\”: {\n \”supportsStackWorkflows\”: true,\n \”isFullRing\”: true,\n \”stackMemberList\”: [\n {\n \”serialNumber\”: \”string\”,\n \”state\”: \”string\”,\n \”role\”: \”string\”,\n \”macAddress\”: \”string\”,\n \”pid\”: \”string\”,\n \”licenseLevel\”: \”string\”,\n \”licenseType\”: \”string\”,\n \”sudiSerialNumber\”: \”string\”,\n \”hardwareVersion\”: \”string\”,\n \”stackNumber\”: 0,\n \”softwareVersion\”: \”string\”,\n \”priority\”: 0\n }\n ],\n \”stackRingProtocol\”: \”string\”,\n \”validLicenseLevels\”: [\n \”string\”\n ],\n \”totalMemberCount\”: 0\n },\n \”reloadRequested\”: true,\n \”addedOn\”: 0,\n \”siteId\”: \”string\”,\n \”aaaCredentials\”: {\n \”password\”: \”string\”,\n \”username\”: \”string\”\n },\n \”userMicNumbers\”: [\n \”string\”\n ],\n \”userSudiSerialNos\”: [\n \”string\”\n ],\n \”addnMacAddrs\”: [\n \”string\”\n ],\n \”preWorkflowCliOuputs\”: [\n {\n \”cli\”: \”string\”,\n \”cliOutput\”: \”string\”\n }\n ],\n \”tags\”: {},\n \”sudiRequired\”: true,\n \”smartAccountId\”: \”string\”,\n \”virtualAccountId\”: \”string\”,\n \”populateInventory\”: true,\n \”siteName\”: \”string\”,\n \”name\”: \”string\”\n },\n \”systemResetWorkflow\”: {\n \”_id\”: \”string\”,\n \”state\”: \”string\”,\n \”type\”: \”string\”,\n \”description\”: \”string\”,\n \”lastupdateOn\”: 0,\n \”imageId\”: \”string\”,\n \”currTaskIdx\”: 0,\n \”addedOn\”: 0,\n \”tasks\”: [\n {\n \”state\”: \”string\”,\n \”type\”: \”string\”,\n \”currWorkItemIdx\”: 0,\n \”taskSeqNo\”: 0,\n \”endTime\”: 0,\n \”startTime\”: 0,\n \”workItemList\”: [\n {\n \”state\”: \”string\”,\n \”command\”: \”string\”,\n \”outputStr\”: \”string\”,\n \”endTime\”: 0,\n \”startTime\”: 0,\n \”timeTaken\”: 0\n }\n ],\n \”timeTaken\”: 0,\n \”name\”: \”string\”\n }\n ],\n \”addToInventory\”: true,\n \”instanceType\”: \”string\”,\n \”endTime\”: 0,\n \”execTime\”: 0,\n \”startTime\”: 0,\n \”useState\”: \”string\”,\n \”configId\”: \”string\”,\n \”name\”: \”string\”,\n \”version\”: 0,\n \”tenantId\”: \”string\”\n },\n \”systemWorkflow\”: {\n \”_id\”: \”string\”,\n \”state\”: \”string\”,\n \”type\”: \”string\”,\n \”description\”: \”string\”,\n \”lastupdateOn\”: 0,\n \”imageId\”: \”string\”,\n \”currTaskIdx\”: 0,\n \”addedOn\”: 0,\n \”tasks\”: [\n {\n \”state\”: \”string\”,\n \”type\”: \”string\”,\n \”currWorkItemIdx\”: 0,\n \”taskSeqNo\”: 0,\n \”endTime\”: 0,\n \”startTime\”: 0,\n \”workItemList\”: [\n {\n \”state\”: \”string\”,\n \”command\”: \”string\”,\n \”outputStr\”: \”string\”,\n \”endTime\”: 0,\n \”startTime\”: 0,\n \”timeTaken\”: 0\n }\n ],\n \”timeTaken\”: 0,\n \”name\”: \”string\”\n }\n ],\n \”addToInventory\”: true,\n \”instanceType\”: \”string\”,\n \”endTime\”: 0,\n \”execTime\”: 0,\n \”startTime\”: 0,\n \”useState\”: \”string\”,\n \”configId\”: \”string\”,\n \”name\”: \”string\”,\n \”version\”: 0,\n \”tenantId\”: \”string\”\n },\n \”workflow\”: {\n \”_id\”: \”string\”,\n \”state\”: \”string\”,\n \”type\”: \”string\”,\n \”description\”: \”string\”,\n \”lastupdateOn\”: 0,\n \”imageId\”: \”string\”,\n \”currTaskIdx\”: 0,\n \”addedOn\”: 0,\n \”tasks\”: [\n {\n \”state\”: \”string\”,\n \”type\”: \”string\”,\n \”currWorkItemIdx\”: 0,\n \”taskSeqNo\”: 0,\n \”endTime\”: 0,\n \”startTime\”: 0,\n \”workItemList\”: [\n {\n \”state\”: \”string\”,\n \”command\”: \”string\”,\n \”outputStr\”: \”string\”,\n \”endTime\”: 0,\n \”startTime\”: 0,\n \”timeTaken\”: 0\n }\n ],\n \”timeTaken\”: 0,\n \”name\”: \”string\”\n }\n ],\n \”addToInventory\”: true,\n \”instanceType\”: \”string\”,\n \”endTime\”: 0,\n \”execTime\”: 0,\n \”startTime\”: 0,\n \”useState\”: \”string\”,\n \”configId\”: \”string\”,\n \”name\”: \”string\”,\n \”version\”: 0,\n \”tenantId\”: \”string\”\n },\n \”runSummaryList\”: [\n {\n \”details\”: \”string\”,\n \”historyTaskInfo\”: {\n \”type\”: \”string\”,\n \”workItemList\”: [\n {\n \”state\”: \”string\”,\n \”command\”: \”string\”,\n \”outputStr\”: \”string\”,\n \”endTime\”: 0,\n \”startTime\”: 0,\n \”timeTaken\”: 0\n }\n ],\n \”timeTaken\”: 0,\n \”addnDetails\”: [\n {\n \”key\”: \”string\”,\n \”value\”: \”string\”\n }\n ],\n \”name\”: \”string\”\n },\n \”errorFlag\”: true,\n \”timestamp\”: 0\n }\n ],\n \”workflowParameters\”: {\n \”topOfStackSerialNumber\”: \”string\”,\n \”licenseLevel\”: \”string\”,\n \”licenseType\”: \”string\”,\n \”configList\”: [\n {\n \”configParameters\”: [\n {\n \”key\”: \”string\”,\n \”value\”: \”string\”\n }\n ],\n \”configId\”: \”string\”\n }\n ]\n },\n \”dayZeroConfig\”: {\n \”config\”: \”string\”\n },\n \”dayZeroConfigPreview\”: {},\n \”version\”: 0,\n \”tenantId\”: \”string\”\n }\n ],\n \”failureList\”: [\n {\n \”index\”: 0,\n \”serialNum\”: \”string\”,\n \”id\”: \”string\”,\n \”msg\”: \”string\”\n }\n ]\n}\n” |