Try SpotterManage PnpDevice objects of DeviceOnboardingPnp
| "added in version" 1.0 of racampos.dnac"
Authors: first last (@GitHubID)
preview | supported by community
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install racampos.dnac:==0.0.1
collections:
- name: racampos.dnac
version: 0.0.1Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.
Adds a device to the PnP database.
Returns device details specified by device id.
Deletes specified device from PnP database.
Updates device details specified by device id in PnP database.
Returns the device count based on filter criteria. This is useful for pagination.
Returns history for a specific device. Serial number is a required parameter.
- name: get_device_list
cisco.dnac.pnp_device:
state: query # required
cm_state: SomeValue # string
last_contact: True # boolean
limit: 1 # integer
name: SomeValue # string
offset: 1 # integer
onb_state: SomeValue # string
pid: SomeValue # string
project_id: SomeValue # string
project_name: SomeValue # string
serial_number: SomeValue # string
smart_account_id: SomeValue # string
sort: SomeValue # string
sort_order: SomeValue # string
source: SomeValue # string
state: SomeValue # string
virtual_account_id: SomeValue # string
workflow_id: SomeValue # string
workflow_name: SomeValue # string
register: query_result
- name: add_device
cisco.dnac.pnp_device:
state: create # 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
- name: get_device_by_id
cisco.dnac.pnp_device:
state: query # required
id: SomeValue # string, required
register: query_result
- name: delete_device_by_id_from_pnp
cisco.dnac.pnp_device:
state: delete # required
id: SomeValue # string, required
- name: update_device
cisco.dnac.pnp_device:
state: update # required
id: SomeValue # string, 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
- name: get_device_count
cisco.dnac.pnp_device:
state: query # required
count: True # boolean, required
cm_state: SomeValue # string
last_contact: True # boolean
name: SomeValue # string
onb_state: SomeValue # string
pid: SomeValue # string
project_id: SomeValue # string
project_name: SomeValue # string
serial_number: SomeValue # string
smart_account_id: SomeValue # string
source: SomeValue # string
state: SomeValue # string
virtual_account_id: SomeValue # string
workflow_id: SomeValue # string
workflow_name: SomeValue # string
register: query_result
- name: get_device_history
cisco.dnac.pnp_device:
state: query # required
serial_number: SomeValue # string, required
sort: SomeValue # string
sort_order: SomeValue # string
register: query_result
id:
description:
- Id path parameter.
required: true
type: str
_id:
description:
- Device's _id.
type: str
pid:
description:
- Device ProductId.
type: str
name:
description:
- Device Name.
type: str
sort:
description:
- Comma seperated list of fields to sort on.
type: str
count:
description:
- If true gets the number of objects.
- Required for state query.
type: bool
limit:
description:
- Limits number of results.
type: int
state:
description:
- Device State.
type: str
offset:
description:
- Index of first result.
type: int
source:
description:
- Device Source.
type: str
version:
description:
- Device's version.
type: int
cm_state:
description:
- Device Connection Manager State.
type: str
tenantId:
description:
- Device's tenantId.
type: str
workflow:
description:
- Device's workflow.
suboptions:
_id:
description:
- It is the pnp device's _id.
type: str
addToInventory:
description:
- It is the pnp device's addToInventory.
type: bool
addedOn:
description:
- It is the pnp device's addedOn.
type: int
configId:
description:
- It is the pnp device's configId.
type: str
currTaskIdx:
description:
- It is the pnp device's currTaskIdx.
type: int
description:
description:
- It is the pnp device's description.
type: str
endTime:
description:
- It is the pnp device's endTime.
type: int
execTime:
description:
- It is the pnp device's execTime.
type: int
imageId:
description:
- It is the pnp device's imageId.
type: str
instanceType:
description:
- It is the pnp device's instanceType.
type: str
lastupdateOn:
description:
- It is the pnp device's lastupdateOn.
type: int
name:
description:
- It is the pnp device's name.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
tasks:
description:
- It is the pnp device's tasks.
elements: dict
suboptions:
currWorkItemIdx:
description:
- It is the pnp device's currWorkItemIdx.
type: int
endTime:
description:
- It is the pnp device's endTime.
type: int
name:
description:
- It is the pnp device's name.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
taskSeqNo:
description:
- It is the pnp device's taskSeqNo.
type: int
timeTaken:
description:
- It is the pnp device's timeTaken.
type: int
type:
description:
- It is the pnp device's type.
type: str
workItemList:
description:
- It is the pnp device's workItemList.
elements: dict
suboptions:
command:
description:
- It is the pnp device's command.
type: str
endTime:
description:
- It is the pnp device's endTime.
type: int
outputStr:
description:
- It is the pnp device's outputStr.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
timeTaken:
description:
- It is the pnp device's timeTaken.
type: int
type: list
type: list
tenantId:
description:
- It is the pnp device's tenantId.
type: str
type:
description:
- It is the pnp device's type.
type: str
useState:
description:
- It is the pnp device's useState.
type: str
version:
description:
- It is the pnp device's version.
type: int
type: dict
onb_state:
description:
- Device Onboarding State.
type: str
deviceInfo:
description:
- Device's deviceInfo.
required: true
suboptions:
aaaCredentials:
description:
- It is the pnp device's aaaCredentials.
suboptions:
password:
description:
- It is the pnp device's password.
type: str
username:
description:
- It is the pnp device's username.
type: str
type: dict
addedOn:
description:
- It is the pnp device's addedOn.
type: int
addnMacAddrs:
description:
- It is the pnp device's addnMacAddrs.
type: list
agentType:
description:
- It is the pnp device's agentType.
type: str
authStatus:
description:
- It is the pnp device's authStatus.
type: str
authenticatedSudiSerialNo:
description:
- It is the pnp device's authenticatedSudiSerialNo.
type: str
capabilitiesSupported:
description:
- It is the pnp device's capabilitiesSupported.
type: list
cmState:
description:
- It is the pnp device's cmState.
type: str
description:
description:
- It is the pnp device's description.
type: str
deviceSudiSerialNos:
description:
- It is the pnp device's deviceSudiSerialNos.
type: list
deviceType:
description:
- It is the pnp device's deviceType.
type: str
featuresSupported:
description:
- It is the pnp device's featuresSupported.
type: list
fileSystemList:
description:
- It is the pnp device's fileSystemList.
elements: dict
suboptions:
freespace:
description:
- It is the pnp device's freespace.
type: int
name:
description:
- It is the pnp device's name.
type: str
readable:
description:
- It is the pnp device's readable.
type: bool
size:
description:
- It is the pnp device's size.
type: int
type:
description:
- It is the pnp device's type.
type: str
writeable:
description:
- It is the pnp device's writeable.
type: bool
type: list
firstContact:
description:
- It is the pnp device's firstContact.
type: int
hostname:
description:
- It is the pnp device's hostname.
type: str
httpHeaders:
description:
- It is the pnp device's httpHeaders.
elements: dict
suboptions:
key:
description:
- It is the pnp device's key.
type: str
value:
description:
- It is the pnp device's value.
type: str
type: list
imageFile:
description:
- It is the pnp device's imageFile.
type: str
imageVersion:
description:
- It is the pnp device's imageVersion.
type: str
ipInterfaces:
description:
- It is the pnp device's ipInterfaces.
elements: dict
suboptions:
ipv4Address:
description:
- It is the pnp device's ipv4Address.
type: dict
ipv6AddressList:
description:
- It is the pnp device's ipv6AddressList.
type: list
macAddress:
description:
- It is the pnp device's macAddress.
type: str
name:
description:
- It is the pnp device's name.
type: str
status:
description:
- It is the pnp device's status.
type: str
type: list
lastContact:
description:
- It is the pnp device's lastContact.
type: int
lastSyncTime:
description:
- It is the pnp device's lastSyncTime.
type: int
lastUpdateOn:
description:
- It is the pnp device's lastUpdateOn.
type: int
location:
description:
- It is the pnp device's location.
suboptions:
address:
description:
- It is the pnp device's address.
type: str
altitude:
description:
- It is the pnp device's altitude.
type: str
latitude:
description:
- It is the pnp device's latitude.
type: str
longitude:
description:
- It is the pnp device's longitude.
type: str
siteId:
description:
- It is the pnp device's siteId.
type: str
type: dict
macAddress:
description:
- It is the pnp device's macAddress.
type: str
mode:
description:
- It is the pnp device's mode.
type: str
name:
description:
- It is the pnp device's name.
type: str
neighborLinks:
description:
- It is the pnp device's neighborLinks.
elements: dict
suboptions:
localInterfaceName:
description:
- It is the pnp device's localInterfaceName.
type: str
localMacAddress:
description:
- It is the pnp device's localMacAddress.
type: str
localShortInterfaceName:
description:
- It is the pnp device's localShortInterfaceName.
type: str
remoteDeviceName:
description:
- It is the pnp device's remoteDeviceName.
type: str
remoteInterfaceName:
description:
- It is the pnp device's remoteInterfaceName.
type: str
remoteMacAddress:
description:
- It is the pnp device's remoteMacAddress.
type: str
remotePlatform:
description:
- It is the pnp device's remotePlatform.
type: str
remoteShortInterfaceName:
description:
- It is the pnp device's remoteShortInterfaceName.
type: str
remoteVersion:
description:
- It is the pnp device's remoteVersion.
type: str
type: list
onbState:
description:
- It is the pnp device's onbState.
type: str
pid:
description:
- It is the pnp device's pid.
type: str
pnpProfileList:
description:
- It is the pnp device's pnpProfileList.
elements: dict
suboptions:
createdBy:
description:
- It is the pnp device's createdBy.
type: str
discoveryCreated:
description:
- It is the pnp device's discoveryCreated.
type: bool
primaryEndpoint:
description:
- It is the pnp device's primaryEndpoint.
suboptions:
certificate:
description:
- It is the pnp device's certificate.
type: str
fqdn:
description:
- It is the pnp device's fqdn.
type: str
ipv4Address:
description:
- It is the pnp device's ipv4Address.
type: dict
ipv6Address:
description:
- It is the pnp device's ipv6Address.
type: dict
port:
description:
- It is the pnp device's port.
type: int
protocol:
description:
- It is the pnp device's protocol.
type: str
type: dict
profileName:
description:
- It is the pnp device's profileName.
type: str
secondaryEndpoint:
description:
- It is the pnp device's secondaryEndpoint.
suboptions:
certificate:
description:
- It is the pnp device's certificate.
type: str
fqdn:
description:
- It is the pnp device's fqdn.
type: str
ipv4Address:
description:
- It is the pnp device's ipv4Address.
type: dict
ipv6Address:
description:
- It is the pnp device's ipv6Address.
type: dict
port:
description:
- It is the pnp device's port.
type: int
protocol:
description:
- It is the pnp device's protocol.
type: str
type: dict
type: list
populateInventory:
description:
- It is the pnp device's populateInventory.
type: bool
preWorkflowCliOuputs:
description:
- It is the pnp device's preWorkflowCliOuputs.
elements: dict
suboptions:
cli:
description:
- It is the pnp device's cli.
type: str
cliOutput:
description:
- It is the pnp device's cliOutput.
type: str
type: list
projectId:
description:
- It is the pnp device's projectId.
type: str
projectName:
description:
- It is the pnp device's projectName.
type: str
reloadRequested:
description:
- It is the pnp device's reloadRequested.
type: bool
serialNumber:
description:
- It is the pnp device's serialNumber.
type: str
smartAccountId:
description:
- It is the pnp device's smartAccountId.
type: str
source:
description:
- It is the pnp device's source.
type: str
stack:
description:
- It is the pnp device's stack.
type: bool
stackInfo:
description:
- It is the pnp device's stackInfo.
suboptions:
isFullRing:
description:
- It is the pnp device's isFullRing.
type: bool
stackMemberList:
description:
- It is the pnp device's stackMemberList.
elements: dict
suboptions:
hardwareVersion:
description:
- It is the pnp device's hardwareVersion.
type: str
licenseLevel:
description:
- It is the pnp device's licenseLevel.
type: str
licenseType:
description:
- It is the pnp device's licenseType.
type: str
macAddress:
description:
- It is the pnp device's macAddress.
type: str
pid:
description:
- It is the pnp device's pid.
type: str
priority:
description:
- It is the pnp device's priority.
type: int
role:
description:
- It is the pnp device's role.
type: str
serialNumber:
description:
- It is the pnp device's serialNumber.
type: str
softwareVersion:
description:
- It is the pnp device's softwareVersion.
type: str
stackNumber:
description:
- It is the pnp device's stackNumber.
type: int
state:
description:
- It is the pnp device's state.
type: str
sudiSerialNumber:
description:
- It is the pnp device's sudiSerialNumber.
type: str
type: list
stackRingProtocol:
description:
- It is the pnp device's stackRingProtocol.
type: str
supportsStackWorkflows:
description:
- It is the pnp device's supportsStackWorkflows.
type: bool
totalMemberCount:
description:
- It is the pnp device's totalMemberCount.
type: int
validLicenseLevels:
description:
- It is the pnp device's validLicenseLevels.
type: list
type: dict
state:
description:
- It is the pnp device's state.
type: str
sudiRequired:
description:
- It is the pnp device's sudiRequired.
type: bool
tags:
description:
- It is the pnp device's tags.
type: dict
userSudiSerialNos:
description:
- It is the pnp device's userSudiSerialNos.
type: list
virtualAccountId:
description:
- It is the pnp device's virtualAccountId.
type: str
workflowId:
description:
- It is the pnp device's workflowId.
type: str
workflowName:
description:
- It is the pnp device's workflowName.
type: str
type: dict
project_id:
description:
- Device Project Id.
type: str
sort_order:
description:
- Sort Order Ascending (asc) or Descending (des).
type: str
workflow_id:
description:
- Device Workflow Id.
type: str
last_contact:
description:
- Device Has Contacted lastContact > 0.
type: bool
project_name:
description:
- Device Project Name.
type: str
serial_number:
description:
- Device Serial Number.
- Required for state query.
type: str
workflow_name:
description:
- Device Workflow Name.
type: str
runSummaryList:
description:
- Device's runSummaryList (list of objects).
elements: dict
suboptions:
details:
description:
- It is the pnp device's details.
type: str
errorFlag:
description:
- It is the pnp device's errorFlag.
type: bool
historyTaskInfo:
description:
- It is the pnp device's historyTaskInfo.
suboptions:
addnDetails:
description:
- It is the pnp device's addnDetails.
elements: dict
suboptions:
key:
description:
- It is the pnp device's key.
type: str
value:
description:
- It is the pnp device's value.
type: str
type: list
name:
description:
- It is the pnp device's name.
type: str
timeTaken:
description:
- It is the pnp device's timeTaken.
type: int
type:
description:
- It is the pnp device's type.
type: str
workItemList:
description:
- It is the pnp device's workItemList.
elements: dict
suboptions:
command:
description:
- It is the pnp device's command.
type: str
endTime:
description:
- It is the pnp device's endTime.
type: int
outputStr:
description:
- It is the pnp device's outputStr.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
timeTaken:
description:
- It is the pnp device's timeTaken.
type: int
type: list
type: dict
timestamp:
description:
- It is the pnp device's timestamp.
type: int
type: list
systemWorkflow:
description:
- Device's systemWorkflow.
suboptions:
_id:
description:
- It is the pnp device's _id.
type: str
addToInventory:
description:
- It is the pnp device's addToInventory.
type: bool
addedOn:
description:
- It is the pnp device's addedOn.
type: int
configId:
description:
- It is the pnp device's configId.
type: str
currTaskIdx:
description:
- It is the pnp device's currTaskIdx.
type: int
description:
description:
- It is the pnp device's description.
type: str
endTime:
description:
- It is the pnp device's endTime.
type: int
execTime:
description:
- It is the pnp device's execTime.
type: int
imageId:
description:
- It is the pnp device's imageId.
type: str
instanceType:
description:
- It is the pnp device's instanceType.
type: str
lastupdateOn:
description:
- It is the pnp device's lastupdateOn.
type: int
name:
description:
- It is the pnp device's name.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
tasks:
description:
- It is the pnp device's tasks.
elements: dict
suboptions:
currWorkItemIdx:
description:
- It is the pnp device's currWorkItemIdx.
type: int
endTime:
description:
- It is the pnp device's endTime.
type: int
name:
description:
- It is the pnp device's name.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
taskSeqNo:
description:
- It is the pnp device's taskSeqNo.
type: int
timeTaken:
description:
- It is the pnp device's timeTaken.
type: int
type:
description:
- It is the pnp device's type.
type: str
workItemList:
description:
- It is the pnp device's workItemList.
elements: dict
suboptions:
command:
description:
- It is the pnp device's command.
type: str
endTime:
description:
- It is the pnp device's endTime.
type: int
outputStr:
description:
- It is the pnp device's outputStr.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
timeTaken:
description:
- It is the pnp device's timeTaken.
type: int
type: list
type: list
tenantId:
description:
- It is the pnp device's tenantId.
type: str
type:
description:
- It is the pnp device's type.
type: str
useState:
description:
- It is the pnp device's useState.
type: str
version:
description:
- It is the pnp device's version.
type: int
type: dict
smart_account_id:
description:
- Device Smart Account.
type: str
virtual_account_id:
description:
- Device Virtual Account.
type: str
workflowParameters:
description:
- Device's workflowParameters.
suboptions:
configList:
description:
- It is the pnp device's configList.
elements: dict
suboptions:
configId:
description:
- It is the pnp device's configId.
type: str
configParameters:
description:
- It is the pnp device's configParameters.
elements: dict
suboptions:
key:
description:
- It is the pnp device's key.
type: str
value:
description:
- It is the pnp device's value.
type: str
type: list
type: list
licenseLevel:
description:
- It is the pnp device's licenseLevel.
type: str
licenseType:
description:
- It is the pnp device's licenseType.
type: str
topOfStackSerialNumber:
description:
- It is the pnp device's topOfStackSerialNumber.
type: str
type: dict
systemResetWorkflow:
description:
- Device's systemResetWorkflow.
suboptions:
_id:
description:
- It is the pnp device's _id.
type: str
addToInventory:
description:
- It is the pnp device's addToInventory.
type: bool
addedOn:
description:
- It is the pnp device's addedOn.
type: int
configId:
description:
- It is the pnp device's configId.
type: str
currTaskIdx:
description:
- It is the pnp device's currTaskIdx.
type: int
description:
description:
- It is the pnp device's description.
type: str
endTime:
description:
- It is the pnp device's endTime.
type: int
execTime:
description:
- It is the pnp device's execTime.
type: int
imageId:
description:
- It is the pnp device's imageId.
type: str
instanceType:
description:
- It is the pnp device's instanceType.
type: str
lastupdateOn:
description:
- It is the pnp device's lastupdateOn.
type: int
name:
description:
- It is the pnp device's name.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
tasks:
description:
- It is the pnp device's tasks.
elements: dict
suboptions:
currWorkItemIdx:
description:
- It is the pnp device's currWorkItemIdx.
type: int
endTime:
description:
- It is the pnp device's endTime.
type: int
name:
description:
- It is the pnp device's name.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
taskSeqNo:
description:
- It is the pnp device's taskSeqNo.
type: int
timeTaken:
description:
- It is the pnp device's timeTaken.
type: int
type:
description:
- It is the pnp device's type.
type: str
workItemList:
description:
- It is the pnp device's workItemList.
elements: dict
suboptions:
command:
description:
- It is the pnp device's command.
type: str
endTime:
description:
- It is the pnp device's endTime.
type: int
outputStr:
description:
- It is the pnp device's outputStr.
type: str
startTime:
description:
- It is the pnp device's startTime.
type: int
state:
description:
- It is the pnp device's state.
type: str
timeTaken:
description:
- It is the pnp device's timeTaken.
type: int
type: list
type: list
tenantId:
description:
- It is the pnp device's tenantId.
type: str
type:
description:
- It is the pnp device's type.
type: str
useState:
description:
- It is the pnp device's useState.
type: str
version:
description:
- It is the pnp device's version.
type: int
type: dict
add_device:
_id:
description: Device's Id.
returned: success
sample: <_id>
type: str
contains: null
dayZeroConfig:
contains:
config:
description: It is the pnp device's config.
returned: success
sample: <config>
type: str
description: Device's Day Zero Config.
returned: success
type: dict
dayZeroConfigPreview:
description: Device's Day Zero Config Preview.
returned: success
type: dict
description: Adds a device to the PnP database.
deviceInfo:
contains:
aaaCredentials:
contains:
password:
description: It is the pnp device's password.
returned: success
sample: '*******'
type: str
username:
description: It is the pnp device's username.
returned: success
sample: devnetuser
type: str
description: It is the pnp device's aaaCredentials.
returned: success
type: dict
addedOn:
description: It is the pnp device's addedOn.
returned: success
sample: 0
type: int
addnMacAddrs:
description: It is the pnp device's addnMacAddrs.
returned: success
type: list
agentType:
description: It is the pnp device's agentType.
returned: success
sample: <agenttype>
type: str
authStatus:
description: It is the pnp device's authStatus.
returned: success
sample: <authstatus>
type: str
authenticatedMicNumber:
description: It is the pnp device's authenticatedMicNumber.
returned: success
sample: <authenticatedmicnumber>
type: str
authenticatedSudiSerialNo:
description: It is the pnp device's authenticatedSudiSerialNo.
returned: success
sample: <authenticatedsudiserialno>
type: str
capabilitiesSupported:
description: It is the pnp device's capabilitiesSupported.
returned: success
type: list
cmState:
description: It is the pnp device's cmState.
returned: success
sample: <cmstate>
type: str
description:
description: It is the pnp device's description.
returned: success
sample: <description>
type: str
deviceSudiSerialNos:
description: It is the pnp device's deviceSudiSerialNos.
returned: success
type: list
deviceType:
description: It is the pnp device's deviceType.
returned: success
sample: <devicetype>
type: str
featuresSupported:
description: It is the pnp device's featuresSupported.
returned: success
type: list
fileSystemList:
contains:
freespace:
description: It is the pnp device's freespace.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
readable:
description: It is the pnp device's readable.
returned: success
sample: false
type: bool
size:
description: It is the pnp device's size.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
writeable:
description: It is the pnp device's writeable.
returned: success
sample: false
type: bool
description: It is the pnp device's fileSystemList.
returned: success
type: list
firstContact:
description: It is the pnp device's firstContact.
returned: success
sample: 0
type: int
hostname:
description: It is the pnp device's hostname.
returned: success
sample: <hostname>
type: str
httpHeaders:
contains:
key:
description: It is the pnp device's key.
returned: success
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: success
sample: <value>
type: str
description: It is the pnp device's httpHeaders.
returned: success
type: list
imageFile:
description: It is the pnp device's imageFile.
returned: success
sample: <imagefile>
type: str
imageVersion:
description: It is the pnp device's imageVersion.
returned: success
sample: <imageversion>
type: str
ipInterfaces:
contains:
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: success
type: dict
ipv6AddressList:
description: It is the pnp device's ipv6AddressList.
returned: success
type: list
macAddress:
description: It is the pnp device's macAddress.
returned: success
sample: <macaddress>
type: str
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
status:
description: It is the pnp device's status.
returned: success
sample: <status>
type: str
description: It is the pnp device's ipInterfaces.
returned: success
type: list
lastContact:
description: It is the pnp device's lastContact.
returned: success
sample: 0
type: int
lastSyncTime:
description: It is the pnp device's lastSyncTime.
returned: success
sample: 0
type: int
lastUpdateOn:
description: It is the pnp device's lastUpdateOn.
returned: success
sample: 0
type: int
location:
contains:
address:
description: It is the pnp device's address.
returned: success
sample: <address>
type: str
altitude:
description: It is the pnp device's altitude.
returned: success
sample: <altitude>
type: str
latitude:
description: It is the pnp device's latitude.
returned: success
sample: <latitude>
type: str
longitude:
description: It is the pnp device's longitude.
returned: success
sample: <longitude>
type: str
siteId:
description: It is the pnp device's siteId.
returned: success
sample: <siteid>
type: str
description: It is the pnp device's location.
returned: success
type: dict
macAddress:
description: It is the pnp device's macAddress.
returned: success
sample: <macaddress>
type: str
mode:
description: It is the pnp device's mode.
returned: success
sample: <mode>
type: str
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
neighborLinks:
contains:
localInterfaceName:
description: It is the pnp device's localInterfaceName.
returned: success
sample: <localinterfacename>
type: str
localMacAddress:
description: It is the pnp device's localMacAddress.
returned: success
sample: <localmacaddress>
type: str
localShortInterfaceName:
description: It is the pnp device's localShortInterfaceName.
returned: success
sample: <localshortinterfacename>
type: str
remoteDeviceName:
description: It is the pnp device's remoteDeviceName.
returned: success
sample: <remotedevicename>
type: str
remoteInterfaceName:
description: It is the pnp device's remoteInterfaceName.
returned: success
sample: <remoteinterfacename>
type: str
remoteMacAddress:
description: It is the pnp device's remoteMacAddress.
returned: success
sample: <remotemacaddress>
type: str
remotePlatform:
description: It is the pnp device's remotePlatform.
returned: success
sample: <remoteplatform>
type: str
remoteShortInterfaceName:
description: It is the pnp device's remoteShortInterfaceName.
returned: success
sample: <remoteshortinterfacename>
type: str
remoteVersion:
description: It is the pnp device's remoteVersion.
returned: success
sample: <remoteversion>
type: str
description: It is the pnp device's neighborLinks.
returned: success
type: list
onbState:
description: It is the pnp device's onbState.
returned: success
sample: <onbstate>
type: str
pid:
description: It is the pnp device's pid.
returned: success
sample: <pid>
type: str
pnpProfileList:
contains:
createdBy:
description: It is the pnp device's createdBy.
returned: success
sample: <createdby>
type: str
discoveryCreated:
description: It is the pnp device's discoveryCreated.
returned: success
sample: false
type: bool
primaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: success
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: success
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: success
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: success
type: dict
port:
description: It is the pnp device's port.
returned: success
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: success
sample: <protocol>
type: str
description: It is the pnp device's primaryEndpoint.
returned: success
type: dict
profileName:
description: It is the pnp device's profileName.
returned: success
sample: <profilename>
type: str
secondaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: success
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: success
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: success
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: success
type: dict
port:
description: It is the pnp device's port.
returned: success
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: success
sample: <protocol>
type: str
description: It is the pnp device's secondaryEndpoint.
returned: success
type: dict
description: It is the pnp device's pnpProfileList.
returned: success
type: list
populateInventory:
description: It is the pnp device's populateInventory.
returned: success
sample: false
type: bool
preWorkflowCliOuputs:
contains:
cli:
description: It is the pnp device's cli.
returned: success
sample: <cli>
type: str
cliOutput:
description: It is the pnp device's cliOutput.
returned: success
sample: <clioutput>
type: str
description: It is the pnp device's preWorkflowCliOuputs.
returned: success
type: list
projectId:
description: It is the pnp device's projectId.
returned: success
sample: <projectid>
type: str
projectName:
description: It is the pnp device's projectName.
returned: success
sample: <projectname>
type: str
reloadRequested:
description: It is the pnp device's reloadRequested.
returned: success
sample: false
type: bool
serialNumber:
description: It is the pnp device's serialNumber.
returned: success
sample: <serialnumber>
type: str
siteId:
description: It is the pnp device's siteId.
returned: success
sample: <siteid>
type: str
siteName:
description: It is the pnp device's siteName.
returned: success
sample: <sitename>
type: str
smartAccountId:
description: It is the pnp device's smartAccountId.
returned: success
sample: <smartaccountid>
type: str
source:
description: It is the pnp device's source.
returned: success
sample: <source>
type: str
stack:
description: It is the pnp device's stack.
returned: success
sample: false
type: bool
stackInfo:
contains:
isFullRing:
description: It is the pnp device's isFullRing.
returned: success
sample: false
type: bool
stackMemberList:
contains:
hardwareVersion:
description: It is the pnp device's hardwareVersion.
returned: success
sample: <hardwareversion>
type: str
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: success
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: success
sample: <licensetype>
type: str
macAddress:
description: It is the pnp device's macAddress.
returned: success
sample: <macaddress>
type: str
pid:
description: It is the pnp device's pid.
returned: success
sample: <pid>
type: str
priority:
description: It is the pnp device's priority.
returned: success
sample: 0
type: int
role:
description: It is the pnp device's role.
returned: success
sample: <role>
type: str
serialNumber:
description: It is the pnp device's serialNumber.
returned: success
sample: <serialnumber>
type: str
softwareVersion:
description: It is the pnp device's softwareVersion.
returned: success
sample: <softwareversion>
type: str
stackNumber:
description: It is the pnp device's stackNumber.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
sudiSerialNumber:
description: It is the pnp device's sudiSerialNumber.
returned: success
sample: <sudiserialnumber>
type: str
description: It is the pnp device's stackMemberList.
returned: success
type: list
stackRingProtocol:
description: It is the pnp device's stackRingProtocol.
returned: success
sample: <stackringprotocol>
type: str
supportsStackWorkflows:
description: It is the pnp device's supportsStackWorkflows.
returned: success
sample: false
type: bool
totalMemberCount:
description: It is the pnp device's totalMemberCount.
returned: success
sample: 0
type: int
validLicenseLevels:
description: It is the pnp device's validLicenseLevels.
returned: success
type: list
description: It is the pnp device's stackInfo.
returned: success
type: dict
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
sudiRequired:
description: It is the pnp device's sudiRequired.
returned: success
sample: false
type: bool
tags:
description: It is the pnp device's tags.
returned: success
type: dict
userMicNumbers:
description: It is the pnp device's userMicNumbers.
returned: success
type: list
userSudiSerialNos:
description: It is the pnp device's userSudiSerialNos.
returned: success
type: list
virtualAccountId:
description: It is the pnp device's virtualAccountId.
returned: success
sample: <virtualaccountid>
type: str
workflowId:
description: It is the pnp device's workflowId.
returned: success
sample: <workflowid>
type: str
workflowName:
description: It is the pnp device's workflowName.
returned: success
sample: <workflowname>
type: str
description: Device's Device Info.
returned: success
type: dict
returned: success
runSummaryList:
contains:
details:
description: It is the pnp device's details.
returned: success
sample: <details>
type: str
errorFlag:
description: It is the pnp device's errorFlag.
returned: success
sample: false
type: bool
historyTaskInfo:
contains:
addnDetails:
contains:
key:
description: It is the pnp device's key.
returned: success
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: success
sample: <value>
type: str
description: It is the pnp device's addnDetails.
returned: success
type: list
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: success
type: list
description: It is the pnp device's historyTaskInfo.
returned: success
type: dict
timestamp:
description: It is the pnp device's timestamp.
returned: success
sample: 0
type: int
description: Device's Run Summary List (list of objects).
returned: success
type: list
systemResetWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: success
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: success
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: success
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: success
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: success
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: success
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: success
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: success
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: success
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: success
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: success
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: success
type: list
description: It is the pnp device's tasks.
returned: success
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: success
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: success
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: success
sample: 0
type: int
description: Device's System Reset Workflow.
returned: success
type: dict
systemWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: success
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: success
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: success
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: success
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: success
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: success
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: success
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: success
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: success
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: success
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: success
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: success
type: list
description: It is the pnp device's tasks.
returned: success
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: success
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: success
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: success
sample: 0
type: int
description: Device's System Workflow.
returned: success
type: dict
tenantId:
description: Device's Tenant Id.
returned: success
sample: <tenantid>
type: str
type: dict
version:
description: Device's version.
returned: success
sample: 0
type: int
workflow:
contains:
_id:
description: It is the pnp device's _id.
returned: success
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: success
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: success
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: success
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: success
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: success
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: success
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: success
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: success
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: success
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: success
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: success
type: list
description: It is the pnp device's tasks.
returned: success
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: success
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: success
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: success
sample: 0
type: int
description: Device's Workflow.
returned: success
type: dict
workflowParameters:
contains:
configList:
contains:
configId:
description: It is the pnp device's configId.
returned: success
sample: <configid>
type: str
configParameters:
contains:
key:
description: It is the pnp device's key.
returned: success
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: success
sample: <value>
type: str
description: It is the pnp device's configParameters.
returned: success
type: list
description: It is the pnp device's configList.
returned: success
type: list
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: success
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: success
sample: <licensetype>
type: str
topOfStackSerialNumber:
description: It is the pnp device's topOfStackSerialNumber.
returned: success
sample: <topofstackserialnumber>
type: str
description: Device's Workflow Parameters.
returned: success
type: dict
delete_device_by_id_from_pnp:
_id:
description: Id, property of the response body.
returned: success
sample: <_id>
type: str
contains: null
dayZeroConfig:
contains:
config:
description: It is the pnp device's config.
returned: success
sample: <config>
type: str
description: Day Zero Config, property of the response body.
returned: success
type: dict
dayZeroConfigPreview:
description: Day Zero Config Preview, property of the response body.
returned: success
type: dict
description: Deletes specified device from PnP database.
deviceInfo:
contains:
aaaCredentials:
contains:
password:
description: It is the pnp device's password.
returned: success
sample: '*******'
type: str
username:
description: It is the pnp device's username.
returned: success
sample: devnetuser
type: str
description: It is the pnp device's aaaCredentials.
returned: success
type: dict
addedOn:
description: It is the pnp device's addedOn.
returned: success
sample: 0
type: int
addnMacAddrs:
description: It is the pnp device's addnMacAddrs.
returned: success
type: list
agentType:
description: It is the pnp device's agentType.
returned: success
sample: <agenttype>
type: str
authStatus:
description: It is the pnp device's authStatus.
returned: success
sample: <authstatus>
type: str
authenticatedMicNumber:
description: It is the pnp device's authenticatedMicNumber.
returned: success
sample: <authenticatedmicnumber>
type: str
authenticatedSudiSerialNo:
description: It is the pnp device's authenticatedSudiSerialNo.
returned: success
sample: <authenticatedsudiserialno>
type: str
capabilitiesSupported:
description: It is the pnp device's capabilitiesSupported.
returned: success
type: list
cmState:
description: It is the pnp device's cmState.
returned: success
sample: <cmstate>
type: str
description:
description: It is the pnp device's description.
returned: success
sample: <description>
type: str
deviceSudiSerialNos:
description: It is the pnp device's deviceSudiSerialNos.
returned: success
type: list
deviceType:
description: It is the pnp device's deviceType.
returned: success
sample: <devicetype>
type: str
featuresSupported:
description: It is the pnp device's featuresSupported.
returned: success
type: list
fileSystemList:
contains:
freespace:
description: It is the pnp device's freespace.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
readable:
description: It is the pnp device's readable.
returned: success
sample: false
type: bool
size:
description: It is the pnp device's size.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
writeable:
description: It is the pnp device's writeable.
returned: success
sample: false
type: bool
description: It is the pnp device's fileSystemList.
returned: success
type: list
firstContact:
description: It is the pnp device's firstContact.
returned: success
sample: 0
type: int
hostname:
description: It is the pnp device's hostname.
returned: success
sample: <hostname>
type: str
httpHeaders:
contains:
key:
description: It is the pnp device's key.
returned: success
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: success
sample: <value>
type: str
description: It is the pnp device's httpHeaders.
returned: success
type: list
imageFile:
description: It is the pnp device's imageFile.
returned: success
sample: <imagefile>
type: str
imageVersion:
description: It is the pnp device's imageVersion.
returned: success
sample: <imageversion>
type: str
ipInterfaces:
contains:
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: success
type: dict
ipv6AddressList:
description: It is the pnp device's ipv6AddressList.
returned: success
type: list
macAddress:
description: It is the pnp device's macAddress.
returned: success
sample: <macaddress>
type: str
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
status:
description: It is the pnp device's status.
returned: success
sample: <status>
type: str
description: It is the pnp device's ipInterfaces.
returned: success
type: list
lastContact:
description: It is the pnp device's lastContact.
returned: success
sample: 0
type: int
lastSyncTime:
description: It is the pnp device's lastSyncTime.
returned: success
sample: 0
type: int
lastUpdateOn:
description: It is the pnp device's lastUpdateOn.
returned: success
sample: 0
type: int
location:
contains:
address:
description: It is the pnp device's address.
returned: success
sample: <address>
type: str
altitude:
description: It is the pnp device's altitude.
returned: success
sample: <altitude>
type: str
latitude:
description: It is the pnp device's latitude.
returned: success
sample: <latitude>
type: str
longitude:
description: It is the pnp device's longitude.
returned: success
sample: <longitude>
type: str
siteId:
description: It is the pnp device's siteId.
returned: success
sample: <siteid>
type: str
description: It is the pnp device's location.
returned: success
type: dict
macAddress:
description: It is the pnp device's macAddress.
returned: success
sample: <macaddress>
type: str
mode:
description: It is the pnp device's mode.
returned: success
sample: <mode>
type: str
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
neighborLinks:
contains:
localInterfaceName:
description: It is the pnp device's localInterfaceName.
returned: success
sample: <localinterfacename>
type: str
localMacAddress:
description: It is the pnp device's localMacAddress.
returned: success
sample: <localmacaddress>
type: str
localShortInterfaceName:
description: It is the pnp device's localShortInterfaceName.
returned: success
sample: <localshortinterfacename>
type: str
remoteDeviceName:
description: It is the pnp device's remoteDeviceName.
returned: success
sample: <remotedevicename>
type: str
remoteInterfaceName:
description: It is the pnp device's remoteInterfaceName.
returned: success
sample: <remoteinterfacename>
type: str
remoteMacAddress:
description: It is the pnp device's remoteMacAddress.
returned: success
sample: <remotemacaddress>
type: str
remotePlatform:
description: It is the pnp device's remotePlatform.
returned: success
sample: <remoteplatform>
type: str
remoteShortInterfaceName:
description: It is the pnp device's remoteShortInterfaceName.
returned: success
sample: <remoteshortinterfacename>
type: str
remoteVersion:
description: It is the pnp device's remoteVersion.
returned: success
sample: <remoteversion>
type: str
description: It is the pnp device's neighborLinks.
returned: success
type: list
onbState:
description: It is the pnp device's onbState.
returned: success
sample: <onbstate>
type: str
pid:
description: It is the pnp device's pid.
returned: success
sample: <pid>
type: str
pnpProfileList:
contains:
createdBy:
description: It is the pnp device's createdBy.
returned: success
sample: <createdby>
type: str
discoveryCreated:
description: It is the pnp device's discoveryCreated.
returned: success
sample: false
type: bool
primaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: success
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: success
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: success
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: success
type: dict
port:
description: It is the pnp device's port.
returned: success
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: success
sample: <protocol>
type: str
description: It is the pnp device's primaryEndpoint.
returned: success
type: dict
profileName:
description: It is the pnp device's profileName.
returned: success
sample: <profilename>
type: str
secondaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: success
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: success
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: success
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: success
type: dict
port:
description: It is the pnp device's port.
returned: success
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: success
sample: <protocol>
type: str
description: It is the pnp device's secondaryEndpoint.
returned: success
type: dict
description: It is the pnp device's pnpProfileList.
returned: success
type: list
populateInventory:
description: It is the pnp device's populateInventory.
returned: success
sample: false
type: bool
preWorkflowCliOuputs:
contains:
cli:
description: It is the pnp device's cli.
returned: success
sample: <cli>
type: str
cliOutput:
description: It is the pnp device's cliOutput.
returned: success
sample: <clioutput>
type: str
description: It is the pnp device's preWorkflowCliOuputs.
returned: success
type: list
projectId:
description: It is the pnp device's projectId.
returned: success
sample: <projectid>
type: str
projectName:
description: It is the pnp device's projectName.
returned: success
sample: <projectname>
type: str
reloadRequested:
description: It is the pnp device's reloadRequested.
returned: success
sample: false
type: bool
serialNumber:
description: It is the pnp device's serialNumber.
returned: success
sample: <serialnumber>
type: str
siteId:
description: It is the pnp device's siteId.
returned: success
sample: <siteid>
type: str
siteName:
description: It is the pnp device's siteName.
returned: success
sample: <sitename>
type: str
smartAccountId:
description: It is the pnp device's smartAccountId.
returned: success
sample: <smartaccountid>
type: str
source:
description: It is the pnp device's source.
returned: success
sample: <source>
type: str
stack:
description: It is the pnp device's stack.
returned: success
sample: false
type: bool
stackInfo:
contains:
isFullRing:
description: It is the pnp device's isFullRing.
returned: success
sample: false
type: bool
stackMemberList:
contains:
hardwareVersion:
description: It is the pnp device's hardwareVersion.
returned: success
sample: <hardwareversion>
type: str
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: success
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: success
sample: <licensetype>
type: str
macAddress:
description: It is the pnp device's macAddress.
returned: success
sample: <macaddress>
type: str
pid:
description: It is the pnp device's pid.
returned: success
sample: <pid>
type: str
priority:
description: It is the pnp device's priority.
returned: success
sample: 0
type: int
role:
description: It is the pnp device's role.
returned: success
sample: <role>
type: str
serialNumber:
description: It is the pnp device's serialNumber.
returned: success
sample: <serialnumber>
type: str
softwareVersion:
description: It is the pnp device's softwareVersion.
returned: success
sample: <softwareversion>
type: str
stackNumber:
description: It is the pnp device's stackNumber.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
sudiSerialNumber:
description: It is the pnp device's sudiSerialNumber.
returned: success
sample: <sudiserialnumber>
type: str
description: It is the pnp device's stackMemberList.
returned: success
type: list
stackRingProtocol:
description: It is the pnp device's stackRingProtocol.
returned: success
sample: <stackringprotocol>
type: str
supportsStackWorkflows:
description: It is the pnp device's supportsStackWorkflows.
returned: success
sample: false
type: bool
totalMemberCount:
description: It is the pnp device's totalMemberCount.
returned: success
sample: 0
type: int
validLicenseLevels:
description: It is the pnp device's validLicenseLevels.
returned: success
type: list
description: It is the pnp device's stackInfo.
returned: success
type: dict
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
sudiRequired:
description: It is the pnp device's sudiRequired.
returned: success
sample: false
type: bool
tags:
description: It is the pnp device's tags.
returned: success
type: dict
userMicNumbers:
description: It is the pnp device's userMicNumbers.
returned: success
type: list
userSudiSerialNos:
description: It is the pnp device's userSudiSerialNos.
returned: success
type: list
virtualAccountId:
description: It is the pnp device's virtualAccountId.
returned: success
sample: <virtualaccountid>
type: str
workflowId:
description: It is the pnp device's workflowId.
returned: success
sample: <workflowid>
type: str
workflowName:
description: It is the pnp device's workflowName.
returned: success
sample: <workflowname>
type: str
description: Device Info, property of the response body.
returned: success
type: dict
returned: success
runSummaryList:
contains:
details:
description: It is the pnp device's details.
returned: success
sample: <details>
type: str
errorFlag:
description: It is the pnp device's errorFlag.
returned: success
sample: false
type: bool
historyTaskInfo:
contains:
addnDetails:
contains:
key:
description: It is the pnp device's key.
returned: success
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: success
sample: <value>
type: str
description: It is the pnp device's addnDetails.
returned: success
type: list
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: success
type: list
description: It is the pnp device's historyTaskInfo.
returned: success
type: dict
timestamp:
description: It is the pnp device's timestamp.
returned: success
sample: 0
type: int
description: Run Summary List, property of the response body (list of objects).
returned: success
type: list
systemResetWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: success
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: success
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: success
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: success
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: success
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: success
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: success
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: success
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: success
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: success
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: success
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: success
type: list
description: It is the pnp device's tasks.
returned: success
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: success
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: success
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: success
sample: 0
type: int
description: System Reset Workflow, property of the response body.
returned: success
type: dict
systemWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: success
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: success
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: success
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: success
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: success
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: success
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: success
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: success
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: success
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: success
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: success
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: success
type: list
description: It is the pnp device's tasks.
returned: success
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: success
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: success
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: success
sample: 0
type: int
description: System Workflow, property of the response body.
returned: success
type: dict
tenantId:
description: Tenant Id, property of the response body.
returned: success
sample: <tenantid>
type: str
type: dict
version:
description: Version, property of the response body.
returned: success
sample: 0
type: int
workflow:
contains:
_id:
description: It is the pnp device's _id.
returned: success
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: success
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: success
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: success
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: success
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: success
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: success
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: success
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: success
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: success
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: success
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: success
type: list
description: It is the pnp device's tasks.
returned: success
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: success
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: success
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: success
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: success
sample: 0
type: int
description: Workflow, property of the response body.
returned: success
type: dict
workflowParameters:
contains:
configList:
contains:
configId:
description: It is the pnp device's configId.
returned: success
sample: <configid>
type: str
configParameters:
contains:
key:
description: It is the pnp device's key.
returned: success
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: success
sample: <value>
type: str
description: It is the pnp device's configParameters.
returned: success
type: list
description: It is the pnp device's configList.
returned: success
type: list
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: success
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: success
sample: <licensetype>
type: str
topOfStackSerialNumber:
description: It is the pnp device's topOfStackSerialNumber.
returned: success
sample: <topofstackserialnumber>
type: str
description: Workflow Parameters, property of the response body.
returned: success
type: dict
get_device_by_id:
_id:
description: Id, property of the response body.
returned: always
sample: <_id>
type: str
contains: null
dayZeroConfig:
contains:
config:
description: It is the pnp device's config.
returned: always
sample: <config>
type: str
description: Day Zero Config, property of the response body.
returned: always
type: dict
dayZeroConfigPreview:
description: Day Zero Config Preview, property of the response body.
returned: always
type: dict
description: Returns device details specified by device id.
deviceInfo:
contains:
aaaCredentials:
contains:
password:
description: It is the pnp device's password.
returned: always
sample: '*******'
type: str
username:
description: It is the pnp device's username.
returned: always
sample: devnetuser
type: str
description: It is the pnp device's aaaCredentials.
returned: always
type: dict
addedOn:
description: It is the pnp device's addedOn.
returned: always
sample: 0
type: int
addnMacAddrs:
description: It is the pnp device's addnMacAddrs.
returned: always
type: list
agentType:
description: It is the pnp device's agentType.
returned: always
sample: <agenttype>
type: str
authStatus:
description: It is the pnp device's authStatus.
returned: always
sample: <authstatus>
type: str
authenticatedMicNumber:
description: It is the pnp device's authenticatedMicNumber.
returned: always
sample: <authenticatedmicnumber>
type: str
authenticatedSudiSerialNo:
description: It is the pnp device's authenticatedSudiSerialNo.
returned: always
sample: <authenticatedsudiserialno>
type: str
capabilitiesSupported:
description: It is the pnp device's capabilitiesSupported.
returned: always
type: list
cmState:
description: It is the pnp device's cmState.
returned: always
sample: <cmstate>
type: str
description:
description: It is the pnp device's description.
returned: always
sample: <description>
type: str
deviceSudiSerialNos:
description: It is the pnp device's deviceSudiSerialNos.
returned: always
type: list
deviceType:
description: It is the pnp device's deviceType.
returned: always
sample: <devicetype>
type: str
featuresSupported:
description: It is the pnp device's featuresSupported.
returned: always
type: list
fileSystemList:
contains:
freespace:
description: It is the pnp device's freespace.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
readable:
description: It is the pnp device's readable.
returned: always
sample: false
type: bool
size:
description: It is the pnp device's size.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
writeable:
description: It is the pnp device's writeable.
returned: always
sample: false
type: bool
description: It is the pnp device's fileSystemList.
returned: always
type: list
firstContact:
description: It is the pnp device's firstContact.
returned: always
sample: 0
type: int
hostname:
description: It is the pnp device's hostname.
returned: always
sample: <hostname>
type: str
httpHeaders:
contains:
key:
description: It is the pnp device's key.
returned: always
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: always
sample: <value>
type: str
description: It is the pnp device's httpHeaders.
returned: always
type: list
imageFile:
description: It is the pnp device's imageFile.
returned: always
sample: <imagefile>
type: str
imageVersion:
description: It is the pnp device's imageVersion.
returned: always
sample: <imageversion>
type: str
ipInterfaces:
contains:
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: always
type: dict
ipv6AddressList:
description: It is the pnp device's ipv6AddressList.
returned: always
type: list
macAddress:
description: It is the pnp device's macAddress.
returned: always
sample: <macaddress>
type: str
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
status:
description: It is the pnp device's status.
returned: always
sample: <status>
type: str
description: It is the pnp device's ipInterfaces.
returned: always
type: list
lastContact:
description: It is the pnp device's lastContact.
returned: always
sample: 0
type: int
lastSyncTime:
description: It is the pnp device's lastSyncTime.
returned: always
sample: 0
type: int
lastUpdateOn:
description: It is the pnp device's lastUpdateOn.
returned: always
sample: 0
type: int
location:
contains:
address:
description: It is the pnp device's address.
returned: always
sample: <address>
type: str
altitude:
description: It is the pnp device's altitude.
returned: always
sample: <altitude>
type: str
latitude:
description: It is the pnp device's latitude.
returned: always
sample: <latitude>
type: str
longitude:
description: It is the pnp device's longitude.
returned: always
sample: <longitude>
type: str
siteId:
description: It is the pnp device's siteId.
returned: always
sample: <siteid>
type: str
description: It is the pnp device's location.
returned: always
type: dict
macAddress:
description: It is the pnp device's macAddress.
returned: always
sample: <macaddress>
type: str
mode:
description: It is the pnp device's mode.
returned: always
sample: <mode>
type: str
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
neighborLinks:
contains:
localInterfaceName:
description: It is the pnp device's localInterfaceName.
returned: always
sample: <localinterfacename>
type: str
localMacAddress:
description: It is the pnp device's localMacAddress.
returned: always
sample: <localmacaddress>
type: str
localShortInterfaceName:
description: It is the pnp device's localShortInterfaceName.
returned: always
sample: <localshortinterfacename>
type: str
remoteDeviceName:
description: It is the pnp device's remoteDeviceName.
returned: always
sample: <remotedevicename>
type: str
remoteInterfaceName:
description: It is the pnp device's remoteInterfaceName.
returned: always
sample: <remoteinterfacename>
type: str
remoteMacAddress:
description: It is the pnp device's remoteMacAddress.
returned: always
sample: <remotemacaddress>
type: str
remotePlatform:
description: It is the pnp device's remotePlatform.
returned: always
sample: <remoteplatform>
type: str
remoteShortInterfaceName:
description: It is the pnp device's remoteShortInterfaceName.
returned: always
sample: <remoteshortinterfacename>
type: str
remoteVersion:
description: It is the pnp device's remoteVersion.
returned: always
sample: <remoteversion>
type: str
description: It is the pnp device's neighborLinks.
returned: always
type: list
onbState:
description: It is the pnp device's onbState.
returned: always
sample: <onbstate>
type: str
pid:
description: It is the pnp device's pid.
returned: always
sample: <pid>
type: str
pnpProfileList:
contains:
createdBy:
description: It is the pnp device's createdBy.
returned: always
sample: <createdby>
type: str
discoveryCreated:
description: It is the pnp device's discoveryCreated.
returned: always
sample: false
type: bool
primaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: always
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: always
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: always
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: always
type: dict
port:
description: It is the pnp device's port.
returned: always
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: always
sample: <protocol>
type: str
description: It is the pnp device's primaryEndpoint.
returned: always
type: dict
profileName:
description: It is the pnp device's profileName.
returned: always
sample: <profilename>
type: str
secondaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: always
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: always
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: always
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: always
type: dict
port:
description: It is the pnp device's port.
returned: always
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: always
sample: <protocol>
type: str
description: It is the pnp device's secondaryEndpoint.
returned: always
type: dict
description: It is the pnp device's pnpProfileList.
returned: always
type: list
populateInventory:
description: It is the pnp device's populateInventory.
returned: always
sample: false
type: bool
preWorkflowCliOuputs:
contains:
cli:
description: It is the pnp device's cli.
returned: always
sample: <cli>
type: str
cliOutput:
description: It is the pnp device's cliOutput.
returned: always
sample: <clioutput>
type: str
description: It is the pnp device's preWorkflowCliOuputs.
returned: always
type: list
projectId:
description: It is the pnp device's projectId.
returned: always
sample: <projectid>
type: str
projectName:
description: It is the pnp device's projectName.
returned: always
sample: <projectname>
type: str
reloadRequested:
description: It is the pnp device's reloadRequested.
returned: always
sample: false
type: bool
serialNumber:
description: It is the pnp device's serialNumber.
returned: always
sample: <serialnumber>
type: str
siteId:
description: It is the pnp device's siteId.
returned: always
sample: <siteid>
type: str
siteName:
description: It is the pnp device's siteName.
returned: always
sample: <sitename>
type: str
smartAccountId:
description: It is the pnp device's smartAccountId.
returned: always
sample: <smartaccountid>
type: str
source:
description: It is the pnp device's source.
returned: always
sample: <source>
type: str
stack:
description: It is the pnp device's stack.
returned: always
sample: false
type: bool
stackInfo:
contains:
isFullRing:
description: It is the pnp device's isFullRing.
returned: always
sample: false
type: bool
stackMemberList:
contains:
hardwareVersion:
description: It is the pnp device's hardwareVersion.
returned: always
sample: <hardwareversion>
type: str
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: always
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: always
sample: <licensetype>
type: str
macAddress:
description: It is the pnp device's macAddress.
returned: always
sample: <macaddress>
type: str
pid:
description: It is the pnp device's pid.
returned: always
sample: <pid>
type: str
priority:
description: It is the pnp device's priority.
returned: always
sample: 0
type: int
role:
description: It is the pnp device's role.
returned: always
sample: <role>
type: str
serialNumber:
description: It is the pnp device's serialNumber.
returned: always
sample: <serialnumber>
type: str
softwareVersion:
description: It is the pnp device's softwareVersion.
returned: always
sample: <softwareversion>
type: str
stackNumber:
description: It is the pnp device's stackNumber.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
sudiSerialNumber:
description: It is the pnp device's sudiSerialNumber.
returned: always
sample: <sudiserialnumber>
type: str
description: It is the pnp device's stackMemberList.
returned: always
type: list
stackRingProtocol:
description: It is the pnp device's stackRingProtocol.
returned: always
sample: <stackringprotocol>
type: str
supportsStackWorkflows:
description: It is the pnp device's supportsStackWorkflows.
returned: always
sample: false
type: bool
totalMemberCount:
description: It is the pnp device's totalMemberCount.
returned: always
sample: 0
type: int
validLicenseLevels:
description: It is the pnp device's validLicenseLevels.
returned: always
type: list
description: It is the pnp device's stackInfo.
returned: always
type: dict
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
sudiRequired:
description: It is the pnp device's sudiRequired.
returned: always
sample: false
type: bool
tags:
description: It is the pnp device's tags.
returned: always
type: dict
userMicNumbers:
description: It is the pnp device's userMicNumbers.
returned: always
type: list
userSudiSerialNos:
description: It is the pnp device's userSudiSerialNos.
returned: always
type: list
virtualAccountId:
description: It is the pnp device's virtualAccountId.
returned: always
sample: <virtualaccountid>
type: str
workflowId:
description: It is the pnp device's workflowId.
returned: always
sample: <workflowid>
type: str
workflowName:
description: It is the pnp device's workflowName.
returned: always
sample: <workflowname>
type: str
description: Device Info, property of the response body.
returned: always
type: dict
returned: always
runSummaryList:
contains:
details:
description: It is the pnp device's details.
returned: always
sample: <details>
type: str
errorFlag:
description: It is the pnp device's errorFlag.
returned: always
sample: false
type: bool
historyTaskInfo:
contains:
addnDetails:
contains:
key:
description: It is the pnp device's key.
returned: always
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: always
sample: <value>
type: str
description: It is the pnp device's addnDetails.
returned: always
type: list
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: always
type: list
description: It is the pnp device's historyTaskInfo.
returned: always
type: dict
timestamp:
description: It is the pnp device's timestamp.
returned: always
sample: 0
type: int
description: Run Summary List, property of the response body (list of objects).
returned: always
type: list
systemResetWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: always
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: always
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: always
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: always
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: always
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: always
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: always
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: always
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: always
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: always
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: always
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: always
type: list
description: It is the pnp device's tasks.
returned: always
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: always
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: always
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: always
sample: 0
type: int
description: System Reset Workflow, property of the response body.
returned: always
type: dict
systemWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: always
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: always
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: always
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: always
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: always
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: always
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: always
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: always
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: always
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: always
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: always
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: always
type: list
description: It is the pnp device's tasks.
returned: always
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: always
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: always
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: always
sample: 0
type: int
description: System Workflow, property of the response body.
returned: always
type: dict
tenantId:
description: Tenant Id, property of the response body.
returned: always
sample: <tenantid>
type: str
type: dict
version:
description: Version, property of the response body.
returned: always
sample: 0
type: int
workflow:
contains:
_id:
description: It is the pnp device's _id.
returned: always
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: always
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: always
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: always
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: always
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: always
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: always
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: always
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: always
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: always
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: always
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: always
type: list
description: It is the pnp device's tasks.
returned: always
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: always
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: always
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: always
sample: 0
type: int
description: Workflow, property of the response body.
returned: always
type: dict
workflowParameters:
contains:
configList:
contains:
configId:
description: It is the pnp device's configId.
returned: always
sample: <configid>
type: str
configParameters:
contains:
key:
description: It is the pnp device's key.
returned: always
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: always
sample: <value>
type: str
description: It is the pnp device's configParameters.
returned: always
type: list
description: It is the pnp device's configList.
returned: always
type: list
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: always
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: always
sample: <licensetype>
type: str
topOfStackSerialNumber:
description: It is the pnp device's topOfStackSerialNumber.
returned: always
sample: <topofstackserialnumber>
type: str
description: Workflow Parameters, property of the response body.
returned: always
type: dict
get_device_count:
contains: null
description: Returns the device count based on filter criteria. This is useful for
pagination.
response:
description: Response, property of the response body.
returned: always
sample: 0
type: int
returned: always
type: dict
get_device_history:
contains: null
description: Returns history for a specific device. Serial number is a required
parameter.
response:
contains:
details:
description: It is the pnp device's details.
returned: always
sample: <details>
type: str
errorFlag:
description: It is the pnp device's errorFlag.
returned: always
sample: false
type: bool
historyTaskInfo:
contains:
addnDetails:
contains:
key:
description: It is the pnp device's key.
returned: always
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: always
sample: <value>
type: str
description: It is the pnp device's addnDetails.
returned: always
type: list
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: always
type: list
description: It is the pnp device's historyTaskInfo.
returned: always
type: dict
timestamp:
description: It is the pnp device's timestamp.
returned: always
sample: 0
type: int
description: Response, property of the response body (list of objects).
returned: always
type: list
returned: always
statusCode:
description: StatusCode, property of the response body.
returned: always
sample: 0
type: int
type: dict
get_device_list:
contains: null
dayZeroConfig:
contains:
config:
description: It is the pnp device's config.
returned: always
sample: <config>
type: str
description: Day Zero Config, property of the response body.
returned: always
type: dict
dayZeroConfigPreview:
description: Day Zero Config Preview, property of the response body.
returned: always
type: dict
description: Returns list of devices based on filter crieteria. If a limit is not
specified, it will default to return 50 devices. Pagination and sorting are also
supported by this endpoint.
deviceInfo:
contains:
aaaCredentials:
contains:
password:
description: It is the pnp device's password.
returned: always
sample: '*******'
type: str
username:
description: It is the pnp device's username.
returned: always
sample: devnetuser
type: str
description: It is the pnp device's aaaCredentials.
returned: always
type: dict
addedOn:
description: It is the pnp device's addedOn.
returned: always
sample: 0
type: int
addnMacAddrs:
description: It is the pnp device's addnMacAddrs.
returned: always
type: list
agentType:
description: It is the pnp device's agentType.
returned: always
sample: <agenttype>
type: str
authStatus:
description: It is the pnp device's authStatus.
returned: always
sample: <authstatus>
type: str
authenticatedMicNumber:
description: It is the pnp device's authenticatedMicNumber.
returned: always
sample: <authenticatedmicnumber>
type: str
authenticatedSudiSerialNo:
description: It is the pnp device's authenticatedSudiSerialNo.
returned: always
sample: <authenticatedsudiserialno>
type: str
capabilitiesSupported:
description: It is the pnp device's capabilitiesSupported.
returned: always
type: list
cmState:
description: It is the pnp device's cmState.
returned: always
sample: <cmstate>
type: str
description:
description: It is the pnp device's description.
returned: always
sample: <description>
type: str
deviceSudiSerialNos:
description: It is the pnp device's deviceSudiSerialNos.
returned: always
type: list
deviceType:
description: It is the pnp device's deviceType.
returned: always
sample: <devicetype>
type: str
featuresSupported:
description: It is the pnp device's featuresSupported.
returned: always
type: list
fileSystemList:
contains:
freespace:
description: It is the pnp device's freespace.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
readable:
description: It is the pnp device's readable.
returned: always
sample: false
type: bool
size:
description: It is the pnp device's size.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
writeable:
description: It is the pnp device's writeable.
returned: always
sample: false
type: bool
description: It is the pnp device's fileSystemList.
returned: always
type: list
firstContact:
description: It is the pnp device's firstContact.
returned: always
sample: 0
type: int
hostname:
description: It is the pnp device's hostname.
returned: always
sample: <hostname>
type: str
httpHeaders:
contains:
key:
description: It is the pnp device's key.
returned: always
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: always
sample: <value>
type: str
description: It is the pnp device's httpHeaders.
returned: always
type: list
imageFile:
description: It is the pnp device's imageFile.
returned: always
sample: <imagefile>
type: str
imageVersion:
description: It is the pnp device's imageVersion.
returned: always
sample: <imageversion>
type: str
ipInterfaces:
contains:
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: always
type: dict
ipv6AddressList:
description: It is the pnp device's ipv6AddressList.
returned: always
type: list
macAddress:
description: It is the pnp device's macAddress.
returned: always
sample: <macaddress>
type: str
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
status:
description: It is the pnp device's status.
returned: always
sample: <status>
type: str
description: It is the pnp device's ipInterfaces.
returned: always
type: list
lastContact:
description: It is the pnp device's lastContact.
returned: always
sample: 0
type: int
lastSyncTime:
description: It is the pnp device's lastSyncTime.
returned: always
sample: 0
type: int
lastUpdateOn:
description: It is the pnp device's lastUpdateOn.
returned: always
sample: 0
type: int
location:
contains:
address:
description: It is the pnp device's address.
returned: always
sample: <address>
type: str
altitude:
description: It is the pnp device's altitude.
returned: always
sample: <altitude>
type: str
latitude:
description: It is the pnp device's latitude.
returned: always
sample: <latitude>
type: str
longitude:
description: It is the pnp device's longitude.
returned: always
sample: <longitude>
type: str
siteId:
description: It is the pnp device's siteId.
returned: always
sample: <siteid>
type: str
description: It is the pnp device's location.
returned: always
type: dict
macAddress:
description: It is the pnp device's macAddress.
returned: always
sample: <macaddress>
type: str
mode:
description: It is the pnp device's mode.
returned: always
sample: <mode>
type: str
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
neighborLinks:
contains:
localInterfaceName:
description: It is the pnp device's localInterfaceName.
returned: always
sample: <localinterfacename>
type: str
localMacAddress:
description: It is the pnp device's localMacAddress.
returned: always
sample: <localmacaddress>
type: str
localShortInterfaceName:
description: It is the pnp device's localShortInterfaceName.
returned: always
sample: <localshortinterfacename>
type: str
remoteDeviceName:
description: It is the pnp device's remoteDeviceName.
returned: always
sample: <remotedevicename>
type: str
remoteInterfaceName:
description: It is the pnp device's remoteInterfaceName.
returned: always
sample: <remoteinterfacename>
type: str
remoteMacAddress:
description: It is the pnp device's remoteMacAddress.
returned: always
sample: <remotemacaddress>
type: str
remotePlatform:
description: It is the pnp device's remotePlatform.
returned: always
sample: <remoteplatform>
type: str
remoteShortInterfaceName:
description: It is the pnp device's remoteShortInterfaceName.
returned: always
sample: <remoteshortinterfacename>
type: str
remoteVersion:
description: It is the pnp device's remoteVersion.
returned: always
sample: <remoteversion>
type: str
description: It is the pnp device's neighborLinks.
returned: always
type: list
onbState:
description: It is the pnp device's onbState.
returned: always
sample: <onbstate>
type: str
pid:
description: It is the pnp device's pid.
returned: always
sample: <pid>
type: str
pnpProfileList:
contains:
createdBy:
description: It is the pnp device's createdBy.
returned: always
sample: <createdby>
type: str
discoveryCreated:
description: It is the pnp device's discoveryCreated.
returned: always
sample: false
type: bool
primaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: always
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: always
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: always
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: always
type: dict
port:
description: It is the pnp device's port.
returned: always
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: always
sample: <protocol>
type: str
description: It is the pnp device's primaryEndpoint.
returned: always
type: dict
profileName:
description: It is the pnp device's profileName.
returned: always
sample: <profilename>
type: str
secondaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: always
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: always
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: always
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: always
type: dict
port:
description: It is the pnp device's port.
returned: always
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: always
sample: <protocol>
type: str
description: It is the pnp device's secondaryEndpoint.
returned: always
type: dict
description: It is the pnp device's pnpProfileList.
returned: always
type: list
populateInventory:
description: It is the pnp device's populateInventory.
returned: always
sample: false
type: bool
preWorkflowCliOuputs:
contains:
cli:
description: It is the pnp device's cli.
returned: always
sample: <cli>
type: str
cliOutput:
description: It is the pnp device's cliOutput.
returned: always
sample: <clioutput>
type: str
description: It is the pnp device's preWorkflowCliOuputs.
returned: always
type: list
projectId:
description: It is the pnp device's projectId.
returned: always
sample: <projectid>
type: str
projectName:
description: It is the pnp device's projectName.
returned: always
sample: <projectname>
type: str
reloadRequested:
description: It is the pnp device's reloadRequested.
returned: always
sample: false
type: bool
serialNumber:
description: It is the pnp device's serialNumber.
returned: always
sample: <serialnumber>
type: str
siteId:
description: It is the pnp device's siteId.
returned: always
sample: <siteid>
type: str
siteName:
description: It is the pnp device's siteName.
returned: always
sample: <sitename>
type: str
smartAccountId:
description: It is the pnp device's smartAccountId.
returned: always
sample: <smartaccountid>
type: str
source:
description: It is the pnp device's source.
returned: always
sample: <source>
type: str
stack:
description: It is the pnp device's stack.
returned: always
sample: false
type: bool
stackInfo:
contains:
isFullRing:
description: It is the pnp device's isFullRing.
returned: always
sample: false
type: bool
stackMemberList:
contains:
hardwareVersion:
description: It is the pnp device's hardwareVersion.
returned: always
sample: <hardwareversion>
type: str
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: always
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: always
sample: <licensetype>
type: str
macAddress:
description: It is the pnp device's macAddress.
returned: always
sample: <macaddress>
type: str
pid:
description: It is the pnp device's pid.
returned: always
sample: <pid>
type: str
priority:
description: It is the pnp device's priority.
returned: always
sample: 0
type: int
role:
description: It is the pnp device's role.
returned: always
sample: <role>
type: str
serialNumber:
description: It is the pnp device's serialNumber.
returned: always
sample: <serialnumber>
type: str
softwareVersion:
description: It is the pnp device's softwareVersion.
returned: always
sample: <softwareversion>
type: str
stackNumber:
description: It is the pnp device's stackNumber.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
sudiSerialNumber:
description: It is the pnp device's sudiSerialNumber.
returned: always
sample: <sudiserialnumber>
type: str
description: It is the pnp device's stackMemberList.
returned: always
type: list
stackRingProtocol:
description: It is the pnp device's stackRingProtocol.
returned: always
sample: <stackringprotocol>
type: str
supportsStackWorkflows:
description: It is the pnp device's supportsStackWorkflows.
returned: always
sample: false
type: bool
totalMemberCount:
description: It is the pnp device's totalMemberCount.
returned: always
sample: 0
type: int
validLicenseLevels:
description: It is the pnp device's validLicenseLevels.
returned: always
type: list
description: It is the pnp device's stackInfo.
returned: always
type: dict
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
sudiRequired:
description: It is the pnp device's sudiRequired.
returned: always
sample: false
type: bool
tags:
description: It is the pnp device's tags.
returned: always
type: dict
userMicNumbers:
description: It is the pnp device's userMicNumbers.
returned: always
type: list
userSudiSerialNos:
description: It is the pnp device's userSudiSerialNos.
returned: always
type: list
virtualAccountId:
description: It is the pnp device's virtualAccountId.
returned: always
sample: <virtualaccountid>
type: str
workflowId:
description: It is the pnp device's workflowId.
returned: always
sample: <workflowid>
type: str
workflowName:
description: It is the pnp device's workflowName.
returned: always
sample: <workflowname>
type: str
description: Device Info, property of the response body.
returned: always
type: dict
returned: always
runSummaryList:
contains:
details:
description: It is the pnp device's details.
returned: always
sample: <details>
type: str
errorFlag:
description: It is the pnp device's errorFlag.
returned: always
sample: false
type: bool
historyTaskInfo:
contains:
addnDetails:
contains:
key:
description: It is the pnp device's key.
returned: always
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: always
sample: <value>
type: str
description: It is the pnp device's addnDetails.
returned: always
type: list
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: always
type: list
description: It is the pnp device's historyTaskInfo.
returned: always
type: dict
timestamp:
description: It is the pnp device's timestamp.
returned: always
sample: 0
type: int
description: Run Summary List, property of the response body (list of objects).
returned: always
type: list
systemResetWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: always
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: always
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: always
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: always
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: always
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: always
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: always
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: always
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: always
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: always
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: always
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: always
type: list
description: It is the pnp device's tasks.
returned: always
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: always
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: always
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: always
sample: 0
type: int
description: System Reset Workflow, property of the response body.
returned: always
type: dict
systemWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: always
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: always
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: always
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: always
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: always
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: always
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: always
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: always
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: always
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: always
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: always
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: always
type: list
description: It is the pnp device's tasks.
returned: always
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: always
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: always
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: always
sample: 0
type: int
description: System Workflow, property of the response body.
returned: always
type: dict
tenantId:
description: Tenant Id, property of the response body.
returned: always
sample: <tenantid>
type: str
type: dict
version:
description: Version, property of the response body.
returned: always
sample: 0
type: int
workflow:
contains:
_id:
description: It is the pnp device's _id.
returned: always
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: always
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: always
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: always
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: always
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: always
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: always
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: always
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: always
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: always
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: always
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: always
type: list
description: It is the pnp device's tasks.
returned: always
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: always
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: always
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: always
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: always
sample: 0
type: int
description: Workflow, property of the response body.
returned: always
type: dict
workflowParameters:
contains:
configList:
contains:
configId:
description: It is the pnp device's configId.
returned: always
sample: <configid>
type: str
configParameters:
contains:
key:
description: It is the pnp device's key.
returned: always
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: always
sample: <value>
type: str
description: It is the pnp device's configParameters.
returned: always
type: list
description: It is the pnp device's configList.
returned: always
type: list
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: always
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: always
sample: <licensetype>
type: str
topOfStackSerialNumber:
description: It is the pnp device's topOfStackSerialNumber.
returned: always
sample: <topofstackserialnumber>
type: str
description: Workflow Parameters, property of the response body.
returned: always
type: dict
update_device:
_id:
description: Device's Id.
returned: changed
sample: <_id>
type: str
contains: null
dayZeroConfig:
contains:
config:
description: It is the pnp device's config.
returned: changed
sample: <config>
type: str
description: Device's Day Zero Config.
returned: changed
type: dict
dayZeroConfigPreview:
description: Device's Day Zero Config Preview.
returned: changed
type: dict
description: Updates device details specified by device id in PnP database.
deviceInfo:
contains:
aaaCredentials:
contains:
password:
description: It is the pnp device's password.
returned: changed
sample: '*******'
type: str
username:
description: It is the pnp device's username.
returned: changed
sample: devnetuser
type: str
description: It is the pnp device's aaaCredentials.
returned: changed
type: dict
addedOn:
description: It is the pnp device's addedOn.
returned: changed
sample: 0
type: int
addnMacAddrs:
description: It is the pnp device's addnMacAddrs.
returned: changed
type: list
agentType:
description: It is the pnp device's agentType.
returned: changed
sample: <agenttype>
type: str
authStatus:
description: It is the pnp device's authStatus.
returned: changed
sample: <authstatus>
type: str
authenticatedMicNumber:
description: It is the pnp device's authenticatedMicNumber.
returned: changed
sample: <authenticatedmicnumber>
type: str
authenticatedSudiSerialNo:
description: It is the pnp device's authenticatedSudiSerialNo.
returned: changed
sample: <authenticatedsudiserialno>
type: str
capabilitiesSupported:
description: It is the pnp device's capabilitiesSupported.
returned: changed
type: list
cmState:
description: It is the pnp device's cmState.
returned: changed
sample: <cmstate>
type: str
description:
description: It is the pnp device's description.
returned: changed
sample: <description>
type: str
deviceSudiSerialNos:
description: It is the pnp device's deviceSudiSerialNos.
returned: changed
type: list
deviceType:
description: It is the pnp device's deviceType.
returned: changed
sample: <devicetype>
type: str
featuresSupported:
description: It is the pnp device's featuresSupported.
returned: changed
type: list
fileSystemList:
contains:
freespace:
description: It is the pnp device's freespace.
returned: changed
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
readable:
description: It is the pnp device's readable.
returned: changed
sample: false
type: bool
size:
description: It is the pnp device's size.
returned: changed
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: changed
sample: <type>
type: str
writeable:
description: It is the pnp device's writeable.
returned: changed
sample: false
type: bool
description: It is the pnp device's fileSystemList.
returned: changed
type: list
firstContact:
description: It is the pnp device's firstContact.
returned: changed
sample: 0
type: int
hostname:
description: It is the pnp device's hostname.
returned: changed
sample: <hostname>
type: str
httpHeaders:
contains:
key:
description: It is the pnp device's key.
returned: changed
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: changed
sample: <value>
type: str
description: It is the pnp device's httpHeaders.
returned: changed
type: list
imageFile:
description: It is the pnp device's imageFile.
returned: changed
sample: <imagefile>
type: str
imageVersion:
description: It is the pnp device's imageVersion.
returned: changed
sample: <imageversion>
type: str
ipInterfaces:
contains:
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: changed
type: dict
ipv6AddressList:
description: It is the pnp device's ipv6AddressList.
returned: changed
type: list
macAddress:
description: It is the pnp device's macAddress.
returned: changed
sample: <macaddress>
type: str
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
status:
description: It is the pnp device's status.
returned: changed
sample: <status>
type: str
description: It is the pnp device's ipInterfaces.
returned: changed
type: list
lastContact:
description: It is the pnp device's lastContact.
returned: changed
sample: 0
type: int
lastSyncTime:
description: It is the pnp device's lastSyncTime.
returned: changed
sample: 0
type: int
lastUpdateOn:
description: It is the pnp device's lastUpdateOn.
returned: changed
sample: 0
type: int
location:
contains:
address:
description: It is the pnp device's address.
returned: changed
sample: <address>
type: str
altitude:
description: It is the pnp device's altitude.
returned: changed
sample: <altitude>
type: str
latitude:
description: It is the pnp device's latitude.
returned: changed
sample: <latitude>
type: str
longitude:
description: It is the pnp device's longitude.
returned: changed
sample: <longitude>
type: str
siteId:
description: It is the pnp device's siteId.
returned: changed
sample: <siteid>
type: str
description: It is the pnp device's location.
returned: changed
type: dict
macAddress:
description: It is the pnp device's macAddress.
returned: changed
sample: <macaddress>
type: str
mode:
description: It is the pnp device's mode.
returned: changed
sample: <mode>
type: str
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
neighborLinks:
contains:
localInterfaceName:
description: It is the pnp device's localInterfaceName.
returned: changed
sample: <localinterfacename>
type: str
localMacAddress:
description: It is the pnp device's localMacAddress.
returned: changed
sample: <localmacaddress>
type: str
localShortInterfaceName:
description: It is the pnp device's localShortInterfaceName.
returned: changed
sample: <localshortinterfacename>
type: str
remoteDeviceName:
description: It is the pnp device's remoteDeviceName.
returned: changed
sample: <remotedevicename>
type: str
remoteInterfaceName:
description: It is the pnp device's remoteInterfaceName.
returned: changed
sample: <remoteinterfacename>
type: str
remoteMacAddress:
description: It is the pnp device's remoteMacAddress.
returned: changed
sample: <remotemacaddress>
type: str
remotePlatform:
description: It is the pnp device's remotePlatform.
returned: changed
sample: <remoteplatform>
type: str
remoteShortInterfaceName:
description: It is the pnp device's remoteShortInterfaceName.
returned: changed
sample: <remoteshortinterfacename>
type: str
remoteVersion:
description: It is the pnp device's remoteVersion.
returned: changed
sample: <remoteversion>
type: str
description: It is the pnp device's neighborLinks.
returned: changed
type: list
onbState:
description: It is the pnp device's onbState.
returned: changed
sample: <onbstate>
type: str
pid:
description: It is the pnp device's pid.
returned: changed
sample: <pid>
type: str
pnpProfileList:
contains:
createdBy:
description: It is the pnp device's createdBy.
returned: changed
sample: <createdby>
type: str
discoveryCreated:
description: It is the pnp device's discoveryCreated.
returned: changed
sample: false
type: bool
primaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: changed
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: changed
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: changed
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: changed
type: dict
port:
description: It is the pnp device's port.
returned: changed
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: changed
sample: <protocol>
type: str
description: It is the pnp device's primaryEndpoint.
returned: changed
type: dict
profileName:
description: It is the pnp device's profileName.
returned: changed
sample: <profilename>
type: str
secondaryEndpoint:
contains:
certificate:
description: It is the pnp device's certificate.
returned: changed
sample: <certificate>
type: str
fqdn:
description: It is the pnp device's fqdn.
returned: changed
sample: <fqdn>
type: str
ipv4Address:
description: It is the pnp device's ipv4Address.
returned: changed
type: dict
ipv6Address:
description: It is the pnp device's ipv6Address.
returned: changed
type: dict
port:
description: It is the pnp device's port.
returned: changed
sample: 0
type: int
protocol:
description: It is the pnp device's protocol.
returned: changed
sample: <protocol>
type: str
description: It is the pnp device's secondaryEndpoint.
returned: changed
type: dict
description: It is the pnp device's pnpProfileList.
returned: changed
type: list
populateInventory:
description: It is the pnp device's populateInventory.
returned: changed
sample: false
type: bool
preWorkflowCliOuputs:
contains:
cli:
description: It is the pnp device's cli.
returned: changed
sample: <cli>
type: str
cliOutput:
description: It is the pnp device's cliOutput.
returned: changed
sample: <clioutput>
type: str
description: It is the pnp device's preWorkflowCliOuputs.
returned: changed
type: list
projectId:
description: It is the pnp device's projectId.
returned: changed
sample: <projectid>
type: str
projectName:
description: It is the pnp device's projectName.
returned: changed
sample: <projectname>
type: str
reloadRequested:
description: It is the pnp device's reloadRequested.
returned: changed
sample: false
type: bool
serialNumber:
description: It is the pnp device's serialNumber.
returned: changed
sample: <serialnumber>
type: str
siteId:
description: It is the pnp device's siteId.
returned: changed
sample: <siteid>
type: str
siteName:
description: It is the pnp device's siteName.
returned: changed
sample: <sitename>
type: str
smartAccountId:
description: It is the pnp device's smartAccountId.
returned: changed
sample: <smartaccountid>
type: str
source:
description: It is the pnp device's source.
returned: changed
sample: <source>
type: str
stack:
description: It is the pnp device's stack.
returned: changed
sample: false
type: bool
stackInfo:
contains:
isFullRing:
description: It is the pnp device's isFullRing.
returned: changed
sample: false
type: bool
stackMemberList:
contains:
hardwareVersion:
description: It is the pnp device's hardwareVersion.
returned: changed
sample: <hardwareversion>
type: str
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: changed
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: changed
sample: <licensetype>
type: str
macAddress:
description: It is the pnp device's macAddress.
returned: changed
sample: <macaddress>
type: str
pid:
description: It is the pnp device's pid.
returned: changed
sample: <pid>
type: str
priority:
description: It is the pnp device's priority.
returned: changed
sample: 0
type: int
role:
description: It is the pnp device's role.
returned: changed
sample: <role>
type: str
serialNumber:
description: It is the pnp device's serialNumber.
returned: changed
sample: <serialnumber>
type: str
softwareVersion:
description: It is the pnp device's softwareVersion.
returned: changed
sample: <softwareversion>
type: str
stackNumber:
description: It is the pnp device's stackNumber.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
sudiSerialNumber:
description: It is the pnp device's sudiSerialNumber.
returned: changed
sample: <sudiserialnumber>
type: str
description: It is the pnp device's stackMemberList.
returned: changed
type: list
stackRingProtocol:
description: It is the pnp device's stackRingProtocol.
returned: changed
sample: <stackringprotocol>
type: str
supportsStackWorkflows:
description: It is the pnp device's supportsStackWorkflows.
returned: changed
sample: false
type: bool
totalMemberCount:
description: It is the pnp device's totalMemberCount.
returned: changed
sample: 0
type: int
validLicenseLevels:
description: It is the pnp device's validLicenseLevels.
returned: changed
type: list
description: It is the pnp device's stackInfo.
returned: changed
type: dict
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
sudiRequired:
description: It is the pnp device's sudiRequired.
returned: changed
sample: false
type: bool
tags:
description: It is the pnp device's tags.
returned: changed
type: dict
userMicNumbers:
description: It is the pnp device's userMicNumbers.
returned: changed
type: list
userSudiSerialNos:
description: It is the pnp device's userSudiSerialNos.
returned: changed
type: list
virtualAccountId:
description: It is the pnp device's virtualAccountId.
returned: changed
sample: <virtualaccountid>
type: str
workflowId:
description: It is the pnp device's workflowId.
returned: changed
sample: <workflowid>
type: str
workflowName:
description: It is the pnp device's workflowName.
returned: changed
sample: <workflowname>
type: str
description: Device's Device Info.
returned: changed
type: dict
returned: changed
runSummaryList:
contains:
details:
description: It is the pnp device's details.
returned: changed
sample: <details>
type: str
errorFlag:
description: It is the pnp device's errorFlag.
returned: changed
sample: false
type: bool
historyTaskInfo:
contains:
addnDetails:
contains:
key:
description: It is the pnp device's key.
returned: changed
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: changed
sample: <value>
type: str
description: It is the pnp device's addnDetails.
returned: changed
type: list
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: changed
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: changed
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: changed
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: changed
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: changed
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: changed
type: list
description: It is the pnp device's historyTaskInfo.
returned: changed
type: dict
timestamp:
description: It is the pnp device's timestamp.
returned: changed
sample: 0
type: int
description: Device's Run Summary List (list of objects).
returned: changed
type: list
systemResetWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: changed
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: changed
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: changed
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: changed
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: changed
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: changed
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: changed
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: changed
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: changed
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: changed
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: changed
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: changed
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: changed
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: changed
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: changed
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: changed
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: changed
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: changed
type: list
description: It is the pnp device's tasks.
returned: changed
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: changed
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: changed
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: changed
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: changed
sample: 0
type: int
description: Device's System Reset Workflow.
returned: changed
type: dict
systemWorkflow:
contains:
_id:
description: It is the pnp device's _id.
returned: changed
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: changed
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: changed
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: changed
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: changed
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: changed
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: changed
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: changed
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: changed
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: changed
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: changed
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: changed
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: changed
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: changed
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: changed
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: changed
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: changed
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: changed
type: list
description: It is the pnp device's tasks.
returned: changed
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: changed
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: changed
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: changed
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: changed
sample: 0
type: int
description: Device's System Workflow.
returned: changed
type: dict
tenantId:
description: Device's Tenant Id.
returned: changed
sample: <tenantid>
type: str
type: dict
version:
description: Device's version.
returned: changed
sample: 0
type: int
workflow:
contains:
_id:
description: It is the pnp device's _id.
returned: changed
sample: <_id>
type: str
addToInventory:
description: It is the pnp device's addToInventory.
returned: changed
sample: false
type: bool
addedOn:
description: It is the pnp device's addedOn.
returned: changed
sample: 0
type: int
configId:
description: It is the pnp device's configId.
returned: changed
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp device's currTaskIdx.
returned: changed
sample: 0
type: int
description:
description: It is the pnp device's description.
returned: changed
sample: <description>
type: str
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
execTime:
description: It is the pnp device's execTime.
returned: changed
sample: 0
type: int
imageId:
description: It is the pnp device's imageId.
returned: changed
sample: <imageid>
type: str
instanceType:
description: It is the pnp device's instanceType.
returned: changed
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp device's lastupdateOn.
returned: changed
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp device's currWorkItemIdx.
returned: changed
sample: 0
type: int
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
name:
description: It is the pnp device's name.
returned: changed
sample: <name>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
taskSeqNo:
description: It is the pnp device's taskSeqNo.
returned: changed
sample: 0
type: int
timeTaken:
description: It is the pnp device's timeTaken.
returned: changed
sample: 0
type: int
type:
description: It is the pnp device's type.
returned: changed
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp device's command.
returned: changed
sample: <command>
type: str
endTime:
description: It is the pnp device's endTime.
returned: changed
sample: 0
type: int
outputStr:
description: It is the pnp device's outputStr.
returned: changed
sample: <outputstr>
type: str
startTime:
description: It is the pnp device's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp device's state.
returned: changed
sample: <state>
type: str
timeTaken:
description: It is the pnp device's timeTaken.
returned: changed
sample: 0
type: int
description: It is the pnp device's workItemList.
returned: changed
type: list
description: It is the pnp device's tasks.
returned: changed
type: list
tenantId:
description: It is the pnp device's tenantId.
returned: changed
sample: <tenantid>
type: str
type:
description: It is the pnp device's type.
returned: changed
sample: <type>
type: str
useState:
description: It is the pnp device's useState.
returned: changed
sample: <usestate>
type: str
version:
description: It is the pnp device's version.
returned: changed
sample: 0
type: int
description: Device's Workflow.
returned: changed
type: dict
workflowParameters:
contains:
configList:
contains:
configId:
description: It is the pnp device's configId.
returned: changed
sample: <configid>
type: str
configParameters:
contains:
key:
description: It is the pnp device's key.
returned: changed
sample: <key>
type: str
value:
description: It is the pnp device's value.
returned: changed
sample: <value>
type: str
description: It is the pnp device's configParameters.
returned: changed
type: list
description: It is the pnp device's configList.
returned: changed
type: list
licenseLevel:
description: It is the pnp device's licenseLevel.
returned: changed
sample: <licenselevel>
type: str
licenseType:
description: It is the pnp device's licenseType.
returned: changed
sample: <licensetype>
type: str
topOfStackSerialNumber:
description: It is the pnp device's topOfStackSerialNumber.
returned: changed
sample: <topofstackserialnumber>
type: str
description: Device's Workflow Parameters.
returned: changed
type: dict