.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.dnac.pnp_device_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.pnp_device -- Resource module for Pnp Device +++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 4.1.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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.pnp_device`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Pnp Device. .. 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 >= 2.4.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
_id
string
Pnp Device's _id.
deviceInfo
dictionary
Pnp Device's deviceInfo.
aaaCredentials
dictionary
Pnp Device's aaaCredentials.
password
string
Pnp Device's password.
username
string
Pnp Device's username.
addedOn
integer
Pnp Device's addedOn.
addnMacAddrs
list / elements=string
Pnp Device's addnMacAddrs.
agentType
string
Pnp Device's agentType.
authenticatedSudiSerialNo
string
Pnp Device's authenticatedSudiSerialNo.
authStatus
string
Pnp Device's authStatus.
capabilitiesSupported
list / elements=string
Pnp Device's capabilitiesSupported.
cmState
string
Pnp Device's cmState.
description
string
Pnp Device's description.
deviceSudiSerialNos
list / elements=string
Pnp Device's deviceSudiSerialNos.
deviceType
string
Pnp Device's deviceType.
featuresSupported
list / elements=string
Pnp Device's featuresSupported.
fileSystemList
list / elements=string
Pnp Device's fileSystemList.
freespace
integer
Pnp Device's freespace.
name
string
Pnp Device's name.
readable
boolean
    Choices:
  • no
  • yes
Readable flag.
size
integer
Pnp Device's size.
type
string
Pnp Device's type.
writeable
boolean
    Choices:
  • no
  • yes
Writeable flag.
firstContact
integer
Pnp Device's firstContact.
hostname
string
Pnp Device's hostname.
httpHeaders
list / elements=string
Pnp Device's httpHeaders.
key
string
Pnp Device's key.
value
string
Pnp Device's value.
imageFile
string
Pnp Device's imageFile.
imageVersion
string
Pnp Device's imageVersion.
ipInterfaces
list / elements=string
Pnp Device's ipInterfaces.
ipv4Address
dictionary
Pnp Device's ipv4Address.
ipv6AddressList
list / elements=dictionary
Pnp Device's ipv6AddressList.
macAddress
string
Pnp Device's macAddress.
name
string
Pnp Device's name.
status
string
Pnp Device's status.
lastContact
integer
Pnp Device's lastContact.
lastSyncTime
integer
Pnp Device's lastSyncTime.
lastUpdateOn
integer
Pnp Device's lastUpdateOn.
location
dictionary
Pnp Device's location.
address
string
Pnp Device's address.
altitude
string
Pnp Device's altitude.
latitude
string
Pnp Device's latitude.
longitude
string
Pnp Device's longitude.
siteId
string
Pnp Device's siteId.
macAddress
string
Pnp Device's macAddress.
mode
string
Pnp Device's mode.
name
string
Pnp Device's name.
neighborLinks
list / elements=string
Pnp Device's neighborLinks.
localInterfaceName
string
Pnp Device's localInterfaceName.
localMacAddress
string
Pnp Device's localMacAddress.
localShortInterfaceName
string
Pnp Device's localShortInterfaceName.
remoteDeviceName
string
Pnp Device's remoteDeviceName.
remoteInterfaceName
string
Pnp Device's remoteInterfaceName.
remoteMacAddress
string
Pnp Device's remoteMacAddress.
remotePlatform
string
Pnp Device's remotePlatform.
remoteShortInterfaceName
string
Pnp Device's remoteShortInterfaceName.
remoteVersion
string
Pnp Device's remoteVersion.
onbState
string
Pnp Device's onbState.
pid
string
Pnp Device's pid.
pnpProfileList
list / elements=string
Pnp Device's pnpProfileList.
createdBy
string
Pnp Device's createdBy.
discoveryCreated
boolean
    Choices:
  • no
  • yes
DiscoveryCreated flag.
primaryEndpoint
dictionary
Pnp Device's primaryEndpoint.
certificate
string
Pnp Device's certificate.
fqdn
string
Pnp Device's fqdn.
ipv4Address
dictionary
Pnp Device's ipv4Address.
ipv6Address
dictionary
Pnp Device's ipv6Address.
port
integer
Pnp Device's port.
protocol
string
Pnp Device's protocol.
profileName
string
Pnp Device's profileName.
secondaryEndpoint
dictionary
Pnp Device's secondaryEndpoint.
certificate
string
Pnp Device's certificate.
fqdn
string
Pnp Device's fqdn.
ipv4Address
dictionary
Pnp Device's ipv4Address.
ipv6Address
dictionary
Pnp Device's ipv6Address.
port
integer
Pnp Device's port.
protocol
string
Pnp Device's protocol.
populateInventory
boolean
    Choices:
  • no
  • yes
PopulateInventory flag.
preWorkflowCliOuputs
list / elements=string
Pnp Device's preWorkflowCliOuputs.
cli
string
Pnp Device's cli.
cliOutput
string
Pnp Device's cliOutput.
projectId
string
Pnp Device's projectId.
projectName
string
Pnp Device's projectName.
reloadRequested
boolean
    Choices:
  • no
  • yes
ReloadRequested flag.
serialNumber
string
Pnp Device's serialNumber.
smartAccountId
string
Pnp Device's smartAccountId.
source
string
Pnp Device's source.
stack
boolean
    Choices:
  • no
  • yes
Stack flag.
stackInfo
dictionary
Pnp Device's stackInfo.
isFullRing
boolean
    Choices:
  • no
  • yes
IsFullRing flag.
stackMemberList
list / elements=string
Pnp Device's stackMemberList.
hardwareVersion
string
Pnp Device's hardwareVersion.
licenseLevel
string
Pnp Device's licenseLevel.
licenseType
string
Pnp Device's licenseType.
macAddress
string
Pnp Device's macAddress.
pid
string
Pnp Device's pid.
priority
integer
Pnp Device's priority.
role
string
Pnp Device's role.
serialNumber
string
Pnp Device's serialNumber.
softwareVersion
string
Pnp Device's softwareVersion.
stackNumber
integer
Pnp Device's stackNumber.
state
string
Pnp Device's state.
sudiSerialNumber
string
Pnp Device's sudiSerialNumber.
stackRingProtocol
string
Pnp Device's stackRingProtocol.
supportsStackWorkflows
boolean
    Choices:
  • no
  • yes
SupportsStackWorkflows flag.
totalMemberCount
integer
Pnp Device's totalMemberCount.
validLicenseLevels
list / elements=string
Pnp Device's validLicenseLevels.
state
string
Pnp Device's state.
sudiRequired
boolean
    Choices:
  • no
  • yes
SudiRequired flag.
tags
dictionary
Pnp Device's tags.
userSudiSerialNos
list / elements=string
Pnp Device's userSudiSerialNos.
virtualAccountId
string
Pnp Device's virtualAccountId.
workflowId
string
Pnp Device's workflowId.
workflowName
string
Pnp Device's workflowName.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.3.3"
Informs the SDK which version of Cisco DNA Center to use.
id
string
Id path parameter.
runSummaryList
list / elements=string
Pnp Device's runSummaryList.
details
string
Pnp Device's details.
errorFlag
boolean
    Choices:
  • no
  • yes
ErrorFlag flag.
historyTaskInfo
dictionary
Pnp Device's historyTaskInfo.
addnDetails
list / elements=string
Pnp Device's addnDetails.
key
string
Pnp Device's key.
value
string
Pnp Device's value.
name
string
Pnp Device's name.
timeTaken
integer
Pnp Device's timeTaken.
type
string
Pnp Device's type.
workItemList
list / elements=string
Pnp Device's workItemList.
command
string
Pnp Device's command.
endTime
integer
Pnp Device's endTime.
outputStr
string
Pnp Device's outputStr.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
timeTaken
integer
Pnp Device's timeTaken.
timestamp
integer
Pnp Device's timestamp.
systemResetWorkflow
dictionary
Pnp Device's systemResetWorkflow.
_id
string
Pnp Device's _id.
addedOn
integer
Pnp Device's addedOn.
addToInventory
boolean
    Choices:
  • no
  • yes
AddToInventory flag.
configId
string
Pnp Device's configId.
currTaskIdx
integer
Pnp Device's currTaskIdx.
description
string
Pnp Device's description.
endTime
integer
Pnp Device's endTime.
execTime
integer
Pnp Device's execTime.
imageId
string
Pnp Device's imageId.
instanceType
string
Pnp Device's instanceType.
lastupdateOn
integer
Pnp Device's lastupdateOn.
name
string
Pnp Device's name.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
tasks
list / elements=string
Pnp Device's tasks.
currWorkItemIdx
integer
Pnp Device's currWorkItemIdx.
endTime
integer
Pnp Device's endTime.
name
string
Pnp Device's name.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
taskSeqNo
integer
Pnp Device's taskSeqNo.
timeTaken
integer
Pnp Device's timeTaken.
type
string
Pnp Device's type.
workItemList
list / elements=string
Pnp Device's workItemList.
command
string
Pnp Device's command.
endTime
integer
Pnp Device's endTime.
outputStr
string
Pnp Device's outputStr.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
timeTaken
integer
Pnp Device's timeTaken.
tenantId
string
Pnp Device's tenantId.
type
string
Pnp Device's type.
useState
string
Pnp Device's useState.
version
integer
Pnp Device's version.
systemWorkflow
dictionary
Pnp Device's systemWorkflow.
_id
string
Pnp Device's _id.
addedOn
integer
Pnp Device's addedOn.
addToInventory
boolean
    Choices:
  • no
  • yes
AddToInventory flag.
configId
string
Pnp Device's configId.
currTaskIdx
integer
Pnp Device's currTaskIdx.
description
string
Pnp Device's description.
endTime
integer
Pnp Device's endTime.
execTime
integer
Pnp Device's execTime.
imageId
string
Pnp Device's imageId.
instanceType
string
Pnp Device's instanceType.
lastupdateOn
integer
Pnp Device's lastupdateOn.
name
string
Pnp Device's name.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
tasks
list / elements=string
Pnp Device's tasks.
currWorkItemIdx
integer
Pnp Device's currWorkItemIdx.
endTime
integer
Pnp Device's endTime.
name
string
Pnp Device's name.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
taskSeqNo
integer
Pnp Device's taskSeqNo.
timeTaken
integer
Pnp Device's timeTaken.
type
string
Pnp Device's type.
workItemList
list / elements=string
Pnp Device's workItemList.
command
string
Pnp Device's command.
endTime
integer
Pnp Device's endTime.
outputStr
string
Pnp Device's outputStr.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
timeTaken
integer
Pnp Device's timeTaken.
tenantId
string
Pnp Device's tenantId.
type
string
Pnp Device's type.
useState
string
Pnp Device's useState.
version
integer
Pnp Device's version.
tenantId
string
Pnp Device's tenantId.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
version
integer
Pnp Device's version.
workflow
dictionary
Pnp Device's workflow.
_id
string
Pnp Device's _id.
addedOn
integer
Pnp Device's addedOn.
addToInventory
boolean
    Choices:
  • no
  • yes
AddToInventory flag.
configId
string
Pnp Device's configId.
currTaskIdx
integer
Pnp Device's currTaskIdx.
description
string
Pnp Device's description.
endTime
integer
Pnp Device's endTime.
execTime
integer
Pnp Device's execTime.
imageId
string
Pnp Device's imageId.
instanceType
string
Pnp Device's instanceType.
lastupdateOn
integer
Pnp Device's lastupdateOn.
name
string
Pnp Device's name.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
tasks
list / elements=string
Pnp Device's tasks.
currWorkItemIdx
integer
Pnp Device's currWorkItemIdx.
endTime
integer
Pnp Device's endTime.
name
string
Pnp Device's name.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
taskSeqNo
integer
Pnp Device's taskSeqNo.
timeTaken
integer
Pnp Device's timeTaken.
type
string
Pnp Device's type.
workItemList
list / elements=string
Pnp Device's workItemList.
command
string
Pnp Device's command.
endTime
integer
Pnp Device's endTime.
outputStr
string
Pnp Device's outputStr.
startTime
integer
Pnp Device's startTime.
state
string
Pnp Device's state.
timeTaken
integer
Pnp Device's timeTaken.
tenantId
string
Pnp Device's tenantId.
type
string
Pnp Device's type.
useState
string
Pnp Device's useState.
version
integer
Pnp Device's version.
workflowParameters
dictionary
Pnp Device's workflowParameters.
configList
list / elements=string
Pnp Device's configList.
configId
string
Pnp Device's configId.
configParameters
list / elements=string
Pnp Device's configParameters.
key
string
Pnp Device's key.
value
string
Pnp Device's value.
licenseLevel
string
Pnp Device's licenseLevel.
licenseType
string
Pnp Device's licenseType.
topOfStackSerialNumber
string
Pnp Device's topOfStackSerialNumber.

.. Attributes .. Notes Notes ----- .. note:: - 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 .. Seealso See Also -------- .. seealso:: `Pnp Device reference `_ Complete reference of the Pnp Device object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.dnac.pnp_device: 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 _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 - name: Update by id cisco.dnac.pnp_device: 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 _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 id: 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 - name: Delete by id cisco.dnac.pnp_device: 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 .. 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 or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "_id": "string", "deviceInfo": { "source": "string", "serialNumber": "string", "stack": true, "mode": "string", "state": "string", "location": { "siteId": "string", "address": "string", "latitude": "string", "longitude": "string", "altitude": "string" }, "description": "string", "onbState": "string", "authenticatedMicNumber": "string", "authenticatedSudiSerialNo": "string", "capabilitiesSupported": [ "string" ], "featuresSupported": [ "string" ], "cmState": "string", "firstContact": 0, "lastContact": 0, "macAddress": "string", "pid": "string", "deviceSudiSerialNos": [ "string" ], "lastUpdateOn": 0, "workflowId": "string", "workflowName": "string", "projectId": "string", "projectName": "string", "deviceType": "string", "agentType": "string", "imageVersion": "string", "fileSystemList": [ { "type": "string", "writeable": true, "freespace": 0, "name": "string", "readable": true, "size": 0 } ], "pnpProfileList": [ { "profileName": "string", "discoveryCreated": true, "createdBy": "string", "primaryEndpoint": { "port": 0, "protocol": "string", "ipv4Address": {}, "ipv6Address": {}, "fqdn": "string", "certificate": "string" }, "secondaryEndpoint": { "port": 0, "protocol": "string", "ipv4Address": {}, "ipv6Address": {}, "fqdn": "string", "certificate": "string" } } ], "imageFile": "string", "httpHeaders": [ { "key": "string", "value": "string" } ], "neighborLinks": [ { "localInterfaceName": "string", "localShortInterfaceName": "string", "localMacAddress": "string", "remoteInterfaceName": "string", "remoteShortInterfaceName": "string", "remoteMacAddress": "string", "remoteDeviceName": "string", "remotePlatform": "string", "remoteVersion": "string" } ], "lastSyncTime": 0, "ipInterfaces": [ { "status": "string", "macAddress": "string", "ipv4Address": {}, "ipv6AddressList": [ {} ], "name": "string" } ], "hostname": "string", "authStatus": "string", "stackInfo": { "supportsStackWorkflows": true, "isFullRing": true, "stackMemberList": [ { "serialNumber": "string", "state": "string", "role": "string", "macAddress": "string", "pid": "string", "licenseLevel": "string", "licenseType": "string", "sudiSerialNumber": "string", "hardwareVersion": "string", "stackNumber": 0, "softwareVersion": "string", "priority": 0 } ], "stackRingProtocol": "string", "validLicenseLevels": [ "string" ], "totalMemberCount": 0 }, "reloadRequested": true, "addedOn": 0, "siteId": "string", "aaaCredentials": { "password": "string", "username": "string" }, "userMicNumbers": [ "string" ], "userSudiSerialNos": [ "string" ], "addnMacAddrs": [ "string" ], "preWorkflowCliOuputs": [ { "cli": "string", "cliOutput": "string" } ], "tags": {}, "sudiRequired": true, "smartAccountId": "string", "virtualAccountId": "string", "populateInventory": true, "siteName": "string", "name": "string" }, "systemResetWorkflow": { "_id": "string", "state": "string", "type": "string", "description": "string", "lastupdateOn": 0, "imageId": "string", "currTaskIdx": 0, "addedOn": 0, "tasks": [ { "state": "string", "type": "string", "currWorkItemIdx": 0, "taskSeqNo": 0, "endTime": 0, "startTime": 0, "workItemList": [ { "state": "string", "command": "string", "outputStr": "string", "endTime": 0, "startTime": 0, "timeTaken": 0 } ], "timeTaken": 0, "name": "string" } ], "addToInventory": true, "instanceType": "string", "endTime": 0, "execTime": 0, "startTime": 0, "useState": "string", "configId": "string", "name": "string", "version": 0, "tenantId": "string" }, "systemWorkflow": { "_id": "string", "state": "string", "type": "string", "description": "string", "lastupdateOn": 0, "imageId": "string", "currTaskIdx": 0, "addedOn": 0, "tasks": [ { "state": "string", "type": "string", "currWorkItemIdx": 0, "taskSeqNo": 0, "endTime": 0, "startTime": 0, "workItemList": [ { "state": "string", "command": "string", "outputStr": "string", "endTime": 0, "startTime": 0, "timeTaken": 0 } ], "timeTaken": 0, "name": "string" } ], "addToInventory": true, "instanceType": "string", "endTime": 0, "execTime": 0, "startTime": 0, "useState": "string", "configId": "string", "name": "string", "version": 0, "tenantId": "string" }, "workflow": { "_id": "string", "state": "string", "type": "string", "description": "string", "lastupdateOn": 0, "imageId": "string", "currTaskIdx": 0, "addedOn": 0, "tasks": [ { "state": "string", "type": "string", "currWorkItemIdx": 0, "taskSeqNo": 0, "endTime": 0, "startTime": 0, "workItemList": [ { "state": "string", "command": "string", "outputStr": "string", "endTime": 0, "startTime": 0, "timeTaken": 0 } ], "timeTaken": 0, "name": "string" } ], "addToInventory": true, "instanceType": "string", "endTime": 0, "execTime": 0, "startTime": 0, "useState": "string", "configId": "string", "name": "string", "version": 0, "tenantId": "string" }, "runSummaryList": [ { "details": "string", "historyTaskInfo": { "type": "string", "workItemList": [ { "state": "string", "command": "string", "outputStr": "string", "endTime": 0, "startTime": 0, "timeTaken": 0 } ], "timeTaken": 0, "addnDetails": [ { "key": "string", "value": "string" } ], "name": "string" }, "errorFlag": true, "timestamp": 0 } ], "workflowParameters": { "topOfStackSerialNumber": "string", "licenseLevel": "string", "licenseType": "string", "configList": [ { "configParameters": [ { "key": "string", "value": "string" } ], "configId": "string" } ] }, "dayZeroConfig": { "config": "string" }, "dayZeroConfigPreview": {}, "version": 0, "tenantId": "string" }


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