cisco.dnac.pnp_device – Resource module for Pnp Device
Note
This plugin is part of the cisco.dnac collection (version 3.2.3).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
To use it in a playbook, specify: cisco.dnac.pnp_device.
New in version 3.1.0: of cisco.dnac
Synopsis
Manage operations create, update and delete of the resource Pnp Device.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.3.3
python >= 3.5
Parameters
Notes
Note
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Pnp Device reference
Complete reference of the Pnp Device object model.
Examples
- name: Create
cisco.dnac.pnp_device:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
_id: string
deviceInfo:
aaaCredentials:
password: string
username: string
addedOn: 0
addnMacAddrs:
- string
agentType: string
authStatus: string
authenticatedSudiSerialNo: string
capabilitiesSupported:
- string
cmState: string
description: string
deviceSudiSerialNos:
- string
deviceType: string
featuresSupported:
- string
fileSystemList:
- freespace: 0
name: string
readable: true
size: 0
type: string
writeable: true
firstContact: 0
hostname: string
httpHeaders:
- key: string
value: string
imageFile: string
imageVersion: string
ipInterfaces:
- ipv4Address: {}
ipv6AddressList:
- {}
macAddress: string
name: string
status: string
lastContact: 0
lastSyncTime: 0
lastUpdateOn: 0
location:
address: string
altitude: string
latitude: string
longitude: string
siteId: string
macAddress: string
mode: string
name: string
neighborLinks:
- localInterfaceName: string
localMacAddress: string
localShortInterfaceName: string
remoteDeviceName: string
remoteInterfaceName: string
remoteMacAddress: string
remotePlatform: string
remoteShortInterfaceName: string
remoteVersion: string
onbState: string
pid: string
pnpProfileList:
- createdBy: string
discoveryCreated: true
primaryEndpoint:
certificate: string
fqdn: string
ipv4Address: {}
ipv6Address: {}
port: 0
protocol: string
profileName: string
secondaryEndpoint:
certificate: string
fqdn: string
ipv4Address: {}
ipv6Address: {}
port: 0
protocol: string
populateInventory: true
preWorkflowCliOuputs:
- cli: string
cliOutput: string
projectId: string
projectName: string
reloadRequested: true
serialNumber: string
smartAccountId: string
source: string
stack: true
stackInfo:
isFullRing: true
stackMemberList:
- hardwareVersion: string
licenseLevel: string
licenseType: string
macAddress: string
pid: string
priority: 0
role: string
serialNumber: string
softwareVersion: string
stackNumber: 0
state: string
sudiSerialNumber: string
stackRingProtocol: string
supportsStackWorkflows: true
totalMemberCount: 0
validLicenseLevels:
- string
state: string
sudiRequired: true
tags: {}
userSudiSerialNos:
- string
virtualAccountId: string
workflowId: string
workflowName: string
runSummaryList:
- details: string
errorFlag: true
historyTaskInfo:
addnDetails:
- key: string
value: string
name: string
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
timestamp: 0
systemResetWorkflow:
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
systemWorkflow:
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
tenantId: string
version: 0
workflow:
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
workflowParameters:
configList:
- configId: string
configParameters:
- key: string
value: string
licenseLevel: string
licenseType: string
topOfStackSerialNumber: string
- name: Update by id
cisco.dnac.pnp_device:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
_id: string
deviceInfo:
aaaCredentials:
password: string
username: string
addedOn: 0
addnMacAddrs:
- string
agentType: string
authStatus: string
authenticatedSudiSerialNo: string
capabilitiesSupported:
- string
cmState: string
description: string
deviceSudiSerialNos:
- string
deviceType: string
featuresSupported:
- string
fileSystemList:
- freespace: 0
name: string
readable: true
size: 0
type: string
writeable: true
firstContact: 0
hostname: string
httpHeaders:
- key: string
value: string
imageFile: string
imageVersion: string
ipInterfaces:
- ipv4Address: {}
ipv6AddressList:
- {}
macAddress: string
name: string
status: string
lastContact: 0
lastSyncTime: 0
lastUpdateOn: 0
location:
address: string
altitude: string
latitude: string
longitude: string
siteId: string
macAddress: string
mode: string
name: string
neighborLinks:
- localInterfaceName: string
localMacAddress: string
localShortInterfaceName: string
remoteDeviceName: string
remoteInterfaceName: string
remoteMacAddress: string
remotePlatform: string
remoteShortInterfaceName: string
remoteVersion: string
onbState: string
pid: string
pnpProfileList:
- createdBy: string
discoveryCreated: true
primaryEndpoint:
certificate: string
fqdn: string
ipv4Address: {}
ipv6Address: {}
port: 0
protocol: string
profileName: string
secondaryEndpoint:
certificate: string
fqdn: string
ipv4Address: {}
ipv6Address: {}
port: 0
protocol: string
populateInventory: true
preWorkflowCliOuputs:
- cli: string
cliOutput: string
projectId: string
projectName: string
reloadRequested: true
serialNumber: string
smartAccountId: string
source: string
stack: true
stackInfo:
isFullRing: true
stackMemberList:
- hardwareVersion: string
licenseLevel: string
licenseType: string
macAddress: string
pid: string
priority: 0
role: string
serialNumber: string
softwareVersion: string
stackNumber: 0
state: string
sudiSerialNumber: string
stackRingProtocol: string
supportsStackWorkflows: true
totalMemberCount: 0
validLicenseLevels:
- string
state: string
sudiRequired: true
tags: {}
userSudiSerialNos:
- string
virtualAccountId: string
workflowId: string
workflowName: string
id: string
runSummaryList:
- details: string
errorFlag: true
historyTaskInfo:
addnDetails:
- key: string
value: string
name: string
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
timestamp: 0
systemResetWorkflow:
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
systemWorkflow:
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
tenantId: string
version: 0
workflow:
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
workflowParameters:
configList:
- configId: string
configParameters:
- key: string
value: string
licenseLevel: string
licenseType: string
topOfStackSerialNumber: string
- name: Delete by id
cisco.dnac.pnp_device:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: absent
id: string
Return Values
Common return values are documented here, the following are the fields unique to this module: