.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.pnp_device_import_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.pnp_device_import -- Manage PnpDeviceImport objects of DeviceOnboardingPnp +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.pnp_device_import`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Add devices to PnP in bulk. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
payload
list / elements=dictionary / required
An object to send in the Request body.
_id
string
It is the pnp device import's _id.
deviceInfo
dictionary / required
It is the pnp device import's deviceInfo.
aaaCredentials
dictionary
It is the pnp device import's aaaCredentials.
password
string
It is the pnp device import's password.
username
string
It is the pnp device import's username.
addedOn
integer
It is the pnp device import's addedOn.
addnMacAddrs
list / elements=string
It is the pnp device import's addnMacAddrs.
agentType
string
It is the pnp device import's agentType.
authenticatedSudiSerialNo
string
It is the pnp device import's authenticatedSudiSerialNo.
authStatus
string
It is the pnp device import's authStatus.
capabilitiesSupported
list / elements=string
It is the pnp device import's capabilitiesSupported.
cmState
string
It is the pnp device import's cmState.
description
string
It is the pnp device import's description.
deviceSudiSerialNos
list / elements=string
It is the pnp device import's deviceSudiSerialNos.
deviceType
string
It is the pnp device import's deviceType.
featuresSupported
list / elements=string
It is the pnp device import's featuresSupported.
fileSystemList
list / elements=dictionary
It is the pnp device import's fileSystemList.
freespace
integer
It is the pnp device import's freespace.
name
string
It is the pnp device import's name.
readable
boolean
    Choices:
  • no
  • yes
It is the pnp device import's readable.
size
integer
It is the pnp device import's size.
type
string
It is the pnp device import's type.
writeable
boolean
    Choices:
  • no
  • yes
It is the pnp device import's writeable.
firstContact
integer
It is the pnp device import's firstContact.
hostname
string
It is the pnp device import's hostname.
httpHeaders
list / elements=dictionary
It is the pnp device import's httpHeaders.
key
string
It is the pnp device import's key.
value
string
It is the pnp device import's value.
imageFile
string
It is the pnp device import's imageFile.
imageVersion
string
It is the pnp device import's imageVersion.
ipInterfaces
list / elements=dictionary
It is the pnp device import's ipInterfaces.
ipv4Address
dictionary
It is the pnp device import's ipv4Address.
ipv6AddressList
list / elements=string
It is the pnp device import's ipv6AddressList.
macAddress
string
It is the pnp device import's macAddress.
name
string
It is the pnp device import's name.
status
string
It is the pnp device import's status.
lastContact
integer
It is the pnp device import's lastContact.
lastSyncTime
integer
It is the pnp device import's lastSyncTime.
lastUpdateOn
integer
It is the pnp device import's lastUpdateOn.
location
dictionary
It is the pnp device import's location.
address
string
It is the pnp device import's address.
altitude
string
It is the pnp device import's altitude.
latitude
string
It is the pnp device import's latitude.
longitude
string
It is the pnp device import's longitude.
siteId
string
It is the pnp device import's siteId.
macAddress
string
It is the pnp device import's macAddress.
mode
string
It is the pnp device import's mode.
name
string
It is the pnp device import's name.
neighborLinks
list / elements=dictionary
It is the pnp device import's neighborLinks.
localInterfaceName
string
It is the pnp device import's localInterfaceName.
localMacAddress
string
It is the pnp device import's localMacAddress.
localShortInterfaceName
string
It is the pnp device import's localShortInterfaceName.
remoteDeviceName
string
It is the pnp device import's remoteDeviceName.
remoteInterfaceName
string
It is the pnp device import's remoteInterfaceName.
remoteMacAddress
string
It is the pnp device import's remoteMacAddress.
remotePlatform
string
It is the pnp device import's remotePlatform.
remoteShortInterfaceName
string
It is the pnp device import's remoteShortInterfaceName.
remoteVersion
string
It is the pnp device import's remoteVersion.
onbState
string
It is the pnp device import's onbState.
pid
string
It is the pnp device import's pid.
pnpProfileList
list / elements=dictionary
It is the pnp device import's pnpProfileList.
createdBy
string
It is the pnp device import's createdBy.
discoveryCreated
boolean
    Choices:
  • no
  • yes
It is the pnp device import's discoveryCreated.
primaryEndpoint
dictionary
It is the pnp device import's primaryEndpoint.
certificate
string
It is the pnp device import's certificate.
fqdn
string
It is the pnp device import's fqdn.
ipv4Address
dictionary
It is the pnp device import's ipv4Address.
ipv6Address
dictionary
It is the pnp device import's ipv6Address.
port
integer
It is the pnp device import's port.
protocol
string
It is the pnp device import's protocol.
profileName
string
It is the pnp device import's profileName.
secondaryEndpoint
dictionary
It is the pnp device import's secondaryEndpoint.
certificate
string
It is the pnp device import's certificate.
fqdn
string
It is the pnp device import's fqdn.
ipv4Address
dictionary
It is the pnp device import's ipv4Address.
ipv6Address
dictionary
It is the pnp device import's ipv6Address.
port
integer
It is the pnp device import's port.
protocol
string
It is the pnp device import's protocol.
populateInventory
boolean
    Choices:
  • no
  • yes
It is the pnp device import's populateInventory.
preWorkflowCliOuputs
list / elements=dictionary
It is the pnp device import's preWorkflowCliOuputs.
cli
string
It is the pnp device import's cli.
cliOutput
string
It is the pnp device import's cliOutput.
projectId
string
It is the pnp device import's projectId.
projectName
string
It is the pnp device import's projectName.
reloadRequested
boolean
    Choices:
  • no
  • yes
It is the pnp device import's reloadRequested.
serialNumber
string
It is the pnp device import's serialNumber.
smartAccountId
string
It is the pnp device import's smartAccountId.
source
string
It is the pnp device import's source.
stack
boolean
    Choices:
  • no
  • yes
It is the pnp device import's stack.
stackInfo
dictionary
It is the pnp device import's stackInfo.
isFullRing
boolean
    Choices:
  • no
  • yes
It is the pnp device import's isFullRing.
stackMemberList
list / elements=dictionary
It is the pnp device import's stackMemberList.
hardwareVersion
string
It is the pnp device import's hardwareVersion.
licenseLevel
string
It is the pnp device import's licenseLevel.
licenseType
string
It is the pnp device import's licenseType.
macAddress
string
It is the pnp device import's macAddress.
pid
string
It is the pnp device import's pid.
priority
integer
It is the pnp device import's priority.
role
string
It is the pnp device import's role.
serialNumber
string
It is the pnp device import's serialNumber.
softwareVersion
string
It is the pnp device import's softwareVersion.
stackNumber
integer
It is the pnp device import's stackNumber.
state
string
It is the pnp device import's state.
sudiSerialNumber
string
It is the pnp device import's sudiSerialNumber.
stackRingProtocol
string
It is the pnp device import's stackRingProtocol.
supportsStackWorkflows
boolean
    Choices:
  • no
  • yes
It is the pnp device import's supportsStackWorkflows.
totalMemberCount
integer
It is the pnp device import's totalMemberCount.
validLicenseLevels
list / elements=string
It is the pnp device import's validLicenseLevels.
state
string
It is the pnp device import's state.
sudiRequired
boolean
    Choices:
  • no
  • yes
It is the pnp device import's sudiRequired.
tags
dictionary
It is the pnp device import's tags.
userSudiSerialNos
list / elements=string
It is the pnp device import's userSudiSerialNos.
virtualAccountId
string
It is the pnp device import's virtualAccountId.
workflowId
string
It is the pnp device import's workflowId.
workflowName
string
It is the pnp device import's workflowName.
runSummaryList
list / elements=dictionary
It is the pnp device import's runSummaryList.
details
string
It is the pnp device import's details.
errorFlag
boolean
    Choices:
  • no
  • yes
It is the pnp device import's errorFlag.
historyTaskInfo
dictionary
It is the pnp device import's historyTaskInfo.
addnDetails
list / elements=dictionary
It is the pnp device import's addnDetails.
key
string
It is the pnp device import's key.
value
string
It is the pnp device import's value.
name
string
It is the pnp device import's name.
timeTaken
integer
It is the pnp device import's timeTaken.
type
string
It is the pnp device import's type.
workItemList
list / elements=dictionary
It is the pnp device import's workItemList.
command
string
It is the pnp device import's command.
endTime
integer
It is the pnp device import's endTime.
outputStr
string
It is the pnp device import's outputStr.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
timeTaken
integer
It is the pnp device import's timeTaken.
timestamp
integer
It is the pnp device import's timestamp.
systemResetWorkflow
dictionary
It is the pnp device import's systemResetWorkflow.
_id
string
It is the pnp device import's _id.
addedOn
integer
It is the pnp device import's addedOn.
addToInventory
boolean
    Choices:
  • no
  • yes
It is the pnp device import's addToInventory.
configId
string
It is the pnp device import's configId.
currTaskIdx
integer
It is the pnp device import's currTaskIdx.
description
string
It is the pnp device import's description.
endTime
integer
It is the pnp device import's endTime.
execTime
integer
It is the pnp device import's execTime.
imageId
string
It is the pnp device import's imageId.
instanceType
string
It is the pnp device import's instanceType.
lastupdateOn
integer
It is the pnp device import's lastupdateOn.
name
string
It is the pnp device import's name.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
tasks
list / elements=dictionary
It is the pnp device import's tasks.
currWorkItemIdx
integer
It is the pnp device import's currWorkItemIdx.
endTime
integer
It is the pnp device import's endTime.
name
string
It is the pnp device import's name.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
taskSeqNo
integer
It is the pnp device import's taskSeqNo.
timeTaken
integer
It is the pnp device import's timeTaken.
type
string
It is the pnp device import's type.
workItemList
list / elements=dictionary
It is the pnp device import's workItemList.
command
string
It is the pnp device import's command.
endTime
integer
It is the pnp device import's endTime.
outputStr
string
It is the pnp device import's outputStr.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
timeTaken
integer
It is the pnp device import's timeTaken.
tenantId
string
It is the pnp device import's tenantId.
type
string
It is the pnp device import's type.
useState
string
It is the pnp device import's useState.
version
integer
It is the pnp device import's version.
systemWorkflow
dictionary
It is the pnp device import's systemWorkflow.
_id
string
It is the pnp device import's _id.
addedOn
integer
It is the pnp device import's addedOn.
addToInventory
boolean
    Choices:
  • no
  • yes
It is the pnp device import's addToInventory.
configId
string
It is the pnp device import's configId.
currTaskIdx
integer
It is the pnp device import's currTaskIdx.
description
string
It is the pnp device import's description.
endTime
integer
It is the pnp device import's endTime.
execTime
integer
It is the pnp device import's execTime.
imageId
string
It is the pnp device import's imageId.
instanceType
string
It is the pnp device import's instanceType.
lastupdateOn
integer
It is the pnp device import's lastupdateOn.
name
string
It is the pnp device import's name.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
tasks
list / elements=dictionary
It is the pnp device import's tasks.
currWorkItemIdx
integer
It is the pnp device import's currWorkItemIdx.
endTime
integer
It is the pnp device import's endTime.
name
string
It is the pnp device import's name.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
taskSeqNo
integer
It is the pnp device import's taskSeqNo.
timeTaken
integer
It is the pnp device import's timeTaken.
type
string
It is the pnp device import's type.
workItemList
list / elements=dictionary
It is the pnp device import's workItemList.
command
string
It is the pnp device import's command.
endTime
integer
It is the pnp device import's endTime.
outputStr
string
It is the pnp device import's outputStr.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
timeTaken
integer
It is the pnp device import's timeTaken.
tenantId
string
It is the pnp device import's tenantId.
type
string
It is the pnp device import's type.
useState
string
It is the pnp device import's useState.
version
integer
It is the pnp device import's version.
tenantId
string
It is the pnp device import's tenantId.
version
integer
It is the pnp device import's version.
workflow
dictionary
It is the pnp device import's workflow.
_id
string
It is the pnp device import's _id.
addedOn
integer
It is the pnp device import's addedOn.
addToInventory
boolean
    Choices:
  • no
  • yes
It is the pnp device import's addToInventory.
configId
string
It is the pnp device import's configId.
currTaskIdx
integer
It is the pnp device import's currTaskIdx.
description
string
It is the pnp device import's description.
endTime
integer
It is the pnp device import's endTime.
execTime
integer
It is the pnp device import's execTime.
imageId
string
It is the pnp device import's imageId.
instanceType
string
It is the pnp device import's instanceType.
lastupdateOn
integer
It is the pnp device import's lastupdateOn.
name
string
It is the pnp device import's name.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
tasks
list / elements=dictionary
It is the pnp device import's tasks.
currWorkItemIdx
integer
It is the pnp device import's currWorkItemIdx.
endTime
integer
It is the pnp device import's endTime.
name
string
It is the pnp device import's name.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
taskSeqNo
integer
It is the pnp device import's taskSeqNo.
timeTaken
integer
It is the pnp device import's timeTaken.
type
string
It is the pnp device import's type.
workItemList
list / elements=dictionary
It is the pnp device import's workItemList.
command
string
It is the pnp device import's command.
endTime
integer
It is the pnp device import's endTime.
outputStr
string
It is the pnp device import's outputStr.
startTime
integer
It is the pnp device import's startTime.
state
string
It is the pnp device import's state.
timeTaken
integer
It is the pnp device import's timeTaken.
tenantId
string
It is the pnp device import's tenantId.
type
string
It is the pnp device import's type.
useState
string
It is the pnp device import's useState.
version
integer
It is the pnp device import's version.
workflowParameters
dictionary
It is the pnp device import's workflowParameters.
configList
list / elements=dictionary
It is the pnp device import's configList.
configId
string
It is the pnp device import's configId.
configParameters
list / elements=dictionary
It is the pnp device import's configParameters.
key
string
It is the pnp device import's key.
value
string
It is the pnp device import's value.
licenseLevel
string
It is the pnp device import's licenseLevel.
licenseType
string
It is the pnp device import's licenseType.
topOfStackSerialNumber
string
It is the pnp device import's topOfStackSerialNumber.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.dnac.plugins.module_utils.definitions.pnp_device_import ` The official documentation on the **cisco.dnac.plugins.module_utils.definitions.pnp_device_import** module. `PnpDeviceImport reference `_ Complete reference of the PnpDeviceImport object model. `PnpDeviceImport reference `_ SDK reference. .. Examples Examples -------- .. code-block:: yaml+jinja - name: import_devices_in_bulk cisco.dnac.pnp_device_import: state: create # required payload: # required - deviceInfo: # required aaaCredentials: password: SomeValue # string username: SomeValue # string addedOn: 1 # integer addnMacAddrs: - SomeValue # string agentType: SomeValue # string authStatus: SomeValue # string authenticatedSudiSerialNo: SomeValue # string capabilitiesSupported: - SomeValue # string cmState: SomeValue # string description: SomeValue # string deviceSudiSerialNos: - SomeValue # string deviceType: SomeValue # string featuresSupported: - SomeValue # string fileSystemList: - freespace: 1 # integer name: SomeValue # string readable: True # boolean size: 1 # integer type: SomeValue # string writeable: True # boolean firstContact: 1 # integer hostname: SomeValue # string httpHeaders: - key: SomeValue # string value: SomeValue # string imageFile: SomeValue # string imageVersion: SomeValue # string ipInterfaces: - ipv4Address: None ipv6AddressList: macAddress: SomeValue # string name: SomeValue # string status: SomeValue # string lastContact: 1 # integer lastSyncTime: 1 # integer lastUpdateOn: 1 # integer location: address: SomeValue # string altitude: SomeValue # string latitude: SomeValue # string longitude: SomeValue # string siteId: SomeValue # string macAddress: SomeValue # string mode: SomeValue # string name: SomeValue # string neighborLinks: - localInterfaceName: SomeValue # string localMacAddress: SomeValue # string localShortInterfaceName: SomeValue # string remoteDeviceName: SomeValue # string remoteInterfaceName: SomeValue # string remoteMacAddress: SomeValue # string remotePlatform: SomeValue # string remoteShortInterfaceName: SomeValue # string remoteVersion: SomeValue # string onbState: SomeValue # string pid: SomeValue # string pnpProfileList: - createdBy: SomeValue # string discoveryCreated: True # boolean primaryEndpoint: certificate: SomeValue # string fqdn: SomeValue # string ipv4Address: None ipv6Address: None port: 1 # integer protocol: SomeValue # string profileName: SomeValue # string secondaryEndpoint: certificate: SomeValue # string fqdn: SomeValue # string ipv4Address: None ipv6Address: None port: 1 # integer protocol: SomeValue # string populateInventory: True # boolean preWorkflowCliOuputs: - cli: SomeValue # string cliOutput: SomeValue # string projectId: SomeValue # string projectName: SomeValue # string reloadRequested: True # boolean serialNumber: SomeValue # string smartAccountId: SomeValue # string source: SomeValue # string stack: True # boolean stackInfo: isFullRing: True # boolean stackMemberList: - hardwareVersion: SomeValue # string licenseLevel: SomeValue # string licenseType: SomeValue # string macAddress: SomeValue # string pid: SomeValue # string priority: 1 # integer role: SomeValue # string serialNumber: SomeValue # string softwareVersion: SomeValue # string stackNumber: 1 # integer state: SomeValue # string sudiSerialNumber: SomeValue # string stackRingProtocol: SomeValue # string supportsStackWorkflows: True # boolean totalMemberCount: 1 # integer validLicenseLevels: - SomeValue # string state: SomeValue # string sudiRequired: True # boolean tags: None userSudiSerialNos: - SomeValue # string virtualAccountId: SomeValue # string workflowId: SomeValue # string workflowName: SomeValue # string _id: SomeValue # string runSummaryList: - details: SomeValue # string errorFlag: True # boolean historyTaskInfo: addnDetails: - key: SomeValue # string value: SomeValue # string name: SomeValue # string timeTaken: 1 # integer type: SomeValue # string workItemList: - command: SomeValue # string endTime: 1 # integer outputStr: SomeValue # string startTime: 1 # integer state: SomeValue # string timeTaken: 1 # integer timestamp: 1 # integer systemResetWorkflow: _id: SomeValue # string addToInventory: True # boolean addedOn: 1 # integer configId: SomeValue # string currTaskIdx: 1 # integer description: SomeValue # string endTime: 1 # integer execTime: 1 # integer imageId: SomeValue # string instanceType: SomeValue # string lastupdateOn: 1 # integer name: SomeValue # string startTime: 1 # integer state: SomeValue # string tasks: - currWorkItemIdx: 1 # integer endTime: 1 # integer name: SomeValue # string startTime: 1 # integer state: SomeValue # string taskSeqNo: 1 # integer timeTaken: 1 # integer type: SomeValue # string workItemList: - command: SomeValue # string endTime: 1 # integer outputStr: SomeValue # string startTime: 1 # integer state: SomeValue # string timeTaken: 1 # integer tenantId: SomeValue # string type: SomeValue # string useState: SomeValue # string version: 1 # integer systemWorkflow: _id: SomeValue # string addToInventory: True # boolean addedOn: 1 # integer configId: SomeValue # string currTaskIdx: 1 # integer description: SomeValue # string endTime: 1 # integer execTime: 1 # integer imageId: SomeValue # string instanceType: SomeValue # string lastupdateOn: 1 # integer name: SomeValue # string startTime: 1 # integer state: SomeValue # string tasks: - currWorkItemIdx: 1 # integer endTime: 1 # integer name: SomeValue # string startTime: 1 # integer state: SomeValue # string taskSeqNo: 1 # integer timeTaken: 1 # integer type: SomeValue # string workItemList: - command: SomeValue # string endTime: 1 # integer outputStr: SomeValue # string startTime: 1 # integer state: SomeValue # string timeTaken: 1 # integer tenantId: SomeValue # string type: SomeValue # string useState: SomeValue # string version: 1 # integer tenantId: SomeValue # string version: 1 # integer workflow: _id: SomeValue # string addToInventory: True # boolean addedOn: 1 # integer configId: SomeValue # string currTaskIdx: 1 # integer description: SomeValue # string endTime: 1 # integer execTime: 1 # integer imageId: SomeValue # string instanceType: SomeValue # string lastupdateOn: 1 # integer name: SomeValue # string startTime: 1 # integer state: SomeValue # string tasks: - currWorkItemIdx: 1 # integer endTime: 1 # integer name: SomeValue # string startTime: 1 # integer state: SomeValue # string taskSeqNo: 1 # integer timeTaken: 1 # integer type: SomeValue # string workItemList: - command: SomeValue # string endTime: 1 # integer outputStr: SomeValue # string startTime: 1 # integer state: SomeValue # string timeTaken: 1 # integer tenantId: SomeValue # string type: SomeValue # string useState: SomeValue # string version: 1 # integer workflowParameters: configList: - configId: SomeValue # string configParameters: - key: SomeValue # string value: SomeValue # string licenseLevel: SomeValue # string licenseType: SomeValue # string topOfStackSerialNumber: SomeValue # string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
device_onboarding_pnp.import_devices_in_bulk


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors