cisco.dnac.pnp_device_import – Resource module for Pnp Device Import

Note

This plugin is part of the cisco.dnac collection (version 4.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.pnp_device_import.

New in version 3.1.0: of cisco.dnac

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis 

Manage operation create of the resource Pnp Device Import.

Note

This module has a corresponding action plugin.

Requirements 

The below requirements are needed on the host that executes this module.

dnacentersdk >= 2.4.0
python >= 3.5

Parameters 

Parameter					Choices/Defaults	Comments
dnac_debug boolean					Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required						The Cisco DNA Center hostname.
dnac_password string						The Cisco DNA Center password to authenticate.
dnac_port string					Default: 443	The Cisco DNA Center port.
dnac_username string					Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean					Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string					Default: "2.2.3.3"	Informs the SDK which version of Cisco DNA Center to use.
payload list / elements=string						Pnp Device Import's payload.
	_id string					Pnp Device Import's _id.
	deviceInfo dictionary					Pnp Device Import's deviceInfo.
		aaaCredentials dictionary				Pnp Device Import's aaaCredentials.
			password string			Pnp Device Import's password.
			username string			Pnp Device Import's username.
		addedOn integer				Pnp Device Import's addedOn.
		addnMacAddrs list / elements=string				Pnp Device Import's addnMacAddrs.
		agentType string				Pnp Device Import's agentType.
		authenticatedSudiSerialNo string				Pnp Device Import's authenticatedSudiSerialNo.
		authStatus string				Pnp Device Import's authStatus.
		capabilitiesSupported list / elements=string				Pnp Device Import's capabilitiesSupported.
		cmState string				Pnp Device Import's cmState.
		description string				Pnp Device Import's description.
		deviceSudiSerialNos list / elements=string				Pnp Device Import's deviceSudiSerialNos.
		deviceType string				Pnp Device Import's deviceType.
		featuresSupported list / elements=string				Pnp Device Import's featuresSupported.
		fileSystemList list / elements=string				Pnp Device Import's fileSystemList.
			freespace integer			Pnp Device Import's freespace.
			name string			Pnp Device Import's name.
			readable boolean		Choices: no yes	Readable flag.
			size integer			Pnp Device Import's size.
			type string			Pnp Device Import's type.
			writeable boolean		Choices: no yes	Writeable flag.
		firstContact integer				Pnp Device Import's firstContact.
		hostname string				Pnp Device Import's hostname.
		httpHeaders list / elements=string				Pnp Device Import's httpHeaders.
			key string			Pnp Device Import's key.
			value string			Pnp Device Import's value.
		imageFile string				Pnp Device Import's imageFile.
		imageVersion string				Pnp Device Import's imageVersion.
		ipInterfaces list / elements=string				Pnp Device Import's ipInterfaces.
			ipv4Address dictionary			Pnp Device Import's ipv4Address.
			ipv6AddressList list / elements=dictionary			Pnp Device Import's ipv6AddressList.
			macAddress string			Pnp Device Import's macAddress.
			name string			Pnp Device Import's name.
			status string			Pnp Device Import's status.
		lastContact integer				Pnp Device Import's lastContact.
		lastSyncTime integer				Pnp Device Import's lastSyncTime.
		lastUpdateOn integer				Pnp Device Import's lastUpdateOn.
		location dictionary				Pnp Device Import's location.
			address string			Pnp Device Import's address.
			altitude string			Pnp Device Import's altitude.
			latitude string			Pnp Device Import's latitude.
			longitude string			Pnp Device Import's longitude.
			siteId string			Pnp Device Import's siteId.
		macAddress string				Pnp Device Import's macAddress.
		mode string				Pnp Device Import's mode.
		name string				Pnp Device Import's name.
		neighborLinks list / elements=string				Pnp Device Import's neighborLinks.
			localInterfaceName string			Pnp Device Import's localInterfaceName.
			localMacAddress string			Pnp Device Import's localMacAddress.
			localShortInterfaceName string			Pnp Device Import's localShortInterfaceName.
			remoteDeviceName string			Pnp Device Import's remoteDeviceName.
			remoteInterfaceName string			Pnp Device Import's remoteInterfaceName.
			remoteMacAddress string			Pnp Device Import's remoteMacAddress.
			remotePlatform string			Pnp Device Import's remotePlatform.
			remoteShortInterfaceName string			Pnp Device Import's remoteShortInterfaceName.
			remoteVersion string			Pnp Device Import's remoteVersion.
		onbState string				Pnp Device Import's onbState.
		pid string				Pnp Device Import's pid.
		pnpProfileList list / elements=string				Pnp Device Import's pnpProfileList.
			createdBy string			Pnp Device Import's createdBy.
			discoveryCreated boolean		Choices: no yes	DiscoveryCreated flag.
			primaryEndpoint dictionary			Pnp Device Import's primaryEndpoint.
				certificate string		Pnp Device Import's certificate.
				fqdn string		Pnp Device Import's fqdn.
				ipv4Address dictionary		Pnp Device Import's ipv4Address.
				ipv6Address dictionary		Pnp Device Import's ipv6Address.
				port integer		Pnp Device Import's port.
				protocol string		Pnp Device Import's protocol.
			profileName string			Pnp Device Import's profileName.
			secondaryEndpoint dictionary			Pnp Device Import's secondaryEndpoint.
				certificate string		Pnp Device Import's certificate.
				fqdn string		Pnp Device Import's fqdn.
				ipv4Address dictionary		Pnp Device Import's ipv4Address.
				ipv6Address dictionary		Pnp Device Import's ipv6Address.
				port integer		Pnp Device Import's port.
				protocol string		Pnp Device Import's protocol.
		populateInventory boolean			Choices: no yes	PopulateInventory flag.
		preWorkflowCliOuputs list / elements=string				Pnp Device Import's preWorkflowCliOuputs.
			cli string			Pnp Device Import's cli.
			cliOutput string			Pnp Device Import's cliOutput.
		projectId string				Pnp Device Import's projectId.
		projectName string				Pnp Device Import's projectName.
		reloadRequested boolean			Choices: no yes	ReloadRequested flag.
		serialNumber string				Pnp Device Import's serialNumber.
		smartAccountId string				Pnp Device Import's smartAccountId.
		source string				Pnp Device Import's source.
		stack boolean			Choices: no yes	Stack flag.
		stackInfo dictionary				Pnp Device Import's stackInfo.
			isFullRing boolean		Choices: no yes	IsFullRing flag.
			stackMemberList list / elements=string			Pnp Device Import's stackMemberList.
				hardwareVersion string		Pnp Device Import's hardwareVersion.
				licenseLevel string		Pnp Device Import's licenseLevel.
				licenseType string		Pnp Device Import's licenseType.
				macAddress string		Pnp Device Import's macAddress.
				pid string		Pnp Device Import's pid.
				priority integer		Pnp Device Import's priority.
				role string		Pnp Device Import's role.
				serialNumber string		Pnp Device Import's serialNumber.
				softwareVersion string		Pnp Device Import's softwareVersion.
				stackNumber integer		Pnp Device Import's stackNumber.
				state string		Pnp Device Import's state.
				sudiSerialNumber string		Pnp Device Import's sudiSerialNumber.
			stackRingProtocol string			Pnp Device Import's stackRingProtocol.
			supportsStackWorkflows boolean		Choices: no yes	SupportsStackWorkflows flag.
			totalMemberCount integer			Pnp Device Import's totalMemberCount.
			validLicenseLevels list / elements=string			Pnp Device Import's validLicenseLevels.
		state string				Pnp Device Import's state.
		sudiRequired boolean			Choices: no yes	SudiRequired flag.
		tags dictionary				Pnp Device Import's tags.
		userSudiSerialNos list / elements=string				Pnp Device Import's userSudiSerialNos.
		virtualAccountId string				Pnp Device Import's virtualAccountId.
		workflowId string				Pnp Device Import's workflowId.
		workflowName string				Pnp Device Import's workflowName.
	runSummaryList list / elements=string					Pnp Device Import's runSummaryList.
		details string				Pnp Device Import's details.
		errorFlag boolean			Choices: no yes	ErrorFlag flag.
		historyTaskInfo dictionary				Pnp Device Import's historyTaskInfo.
			addnDetails list / elements=string			Pnp Device Import's addnDetails.
				key string		Pnp Device Import's key.
				value string		Pnp Device Import's value.
			name string			Pnp Device Import's name.
			timeTaken integer			Pnp Device Import's timeTaken.
			type string			Pnp Device Import's type.
			workItemList list / elements=string			Pnp Device Import's workItemList.
				command string		Pnp Device Import's command.
				endTime integer		Pnp Device Import's endTime.
				outputStr string		Pnp Device Import's outputStr.
				startTime integer		Pnp Device Import's startTime.
				state string		Pnp Device Import's state.
				timeTaken integer		Pnp Device Import's timeTaken.
		timestamp integer				Pnp Device Import's timestamp.
	systemResetWorkflow dictionary					Pnp Device Import's systemResetWorkflow.
		_id string				Pnp Device Import's _id.
		addedOn integer				Pnp Device Import's addedOn.
		addToInventory boolean			Choices: no yes	AddToInventory flag.
		configId string				Pnp Device Import's configId.
		currTaskIdx integer				Pnp Device Import's currTaskIdx.
		description string				Pnp Device Import's description.
		endTime integer				Pnp Device Import's endTime.
		execTime integer				Pnp Device Import's execTime.
		imageId string				Pnp Device Import's imageId.
		instanceType string				Pnp Device Import's instanceType.
		lastupdateOn integer				Pnp Device Import's lastupdateOn.
		name string				Pnp Device Import's name.
		startTime integer				Pnp Device Import's startTime.
		state string				Pnp Device Import's state.
		tasks list / elements=string				Pnp Device Import's tasks.
			currWorkItemIdx integer			Pnp Device Import's currWorkItemIdx.
			endTime integer			Pnp Device Import's endTime.
			name string			Pnp Device Import's name.
			startTime integer			Pnp Device Import's startTime.
			state string			Pnp Device Import's state.
			taskSeqNo integer			Pnp Device Import's taskSeqNo.
			timeTaken integer			Pnp Device Import's timeTaken.
			type string			Pnp Device Import's type.
			workItemList list / elements=string			Pnp Device Import's workItemList.
				command string		Pnp Device Import's command.
				endTime integer		Pnp Device Import's endTime.
				outputStr string		Pnp Device Import's outputStr.
				startTime integer		Pnp Device Import's startTime.
				state string		Pnp Device Import's state.
				timeTaken integer		Pnp Device Import's timeTaken.
		tenantId string				Pnp Device Import's tenantId.
		type string				Pnp Device Import's type.
		useState string				Pnp Device Import's useState.
		version integer				Pnp Device Import's version.
	systemWorkflow dictionary					Pnp Device Import's systemWorkflow.
		_id string				Pnp Device Import's _id.
		addedOn integer				Pnp Device Import's addedOn.
		addToInventory boolean			Choices: no yes	AddToInventory flag.
		configId string				Pnp Device Import's configId.
		currTaskIdx integer				Pnp Device Import's currTaskIdx.
		description string				Pnp Device Import's description.
		endTime integer				Pnp Device Import's endTime.
		execTime integer				Pnp Device Import's execTime.
		imageId string				Pnp Device Import's imageId.
		instanceType string				Pnp Device Import's instanceType.
		lastupdateOn integer				Pnp Device Import's lastupdateOn.
		name string				Pnp Device Import's name.
		startTime integer				Pnp Device Import's startTime.
		state string				Pnp Device Import's state.
		tasks list / elements=string				Pnp Device Import's tasks.
			currWorkItemIdx integer			Pnp Device Import's currWorkItemIdx.
			endTime integer			Pnp Device Import's endTime.
			name string			Pnp Device Import's name.
			startTime integer			Pnp Device Import's startTime.
			state string			Pnp Device Import's state.
			taskSeqNo integer			Pnp Device Import's taskSeqNo.
			timeTaken integer			Pnp Device Import's timeTaken.
			type string			Pnp Device Import's type.
			workItemList list / elements=string			Pnp Device Import's workItemList.
				command string		Pnp Device Import's command.
				endTime integer		Pnp Device Import's endTime.
				outputStr string		Pnp Device Import's outputStr.
				startTime integer		Pnp Device Import's startTime.
				state string		Pnp Device Import's state.
				timeTaken integer		Pnp Device Import's timeTaken.
		tenantId string				Pnp Device Import's tenantId.
		type string				Pnp Device Import's type.
		useState string				Pnp Device Import's useState.
		version integer				Pnp Device Import's version.
	tenantId string					Pnp Device Import's tenantId.
	version integer					Pnp Device Import's version.
	workflow dictionary					Pnp Device Import's workflow.
		_id string				Pnp Device Import's _id.
		addedOn integer				Pnp Device Import's addedOn.
		addToInventory boolean			Choices: no yes	AddToInventory flag.
		configId string				Pnp Device Import's configId.
		currTaskIdx integer				Pnp Device Import's currTaskIdx.
		description string				Pnp Device Import's description.
		endTime integer				Pnp Device Import's endTime.
		execTime integer				Pnp Device Import's execTime.
		imageId string				Pnp Device Import's imageId.
		instanceType string				Pnp Device Import's instanceType.
		lastupdateOn integer				Pnp Device Import's lastupdateOn.
		name string				Pnp Device Import's name.
		startTime integer				Pnp Device Import's startTime.
		state string				Pnp Device Import's state.
		tasks list / elements=string				Pnp Device Import's tasks.
			currWorkItemIdx integer			Pnp Device Import's currWorkItemIdx.
			endTime integer			Pnp Device Import's endTime.
			name string			Pnp Device Import's name.
			startTime integer			Pnp Device Import's startTime.
			state string			Pnp Device Import's state.
			taskSeqNo integer			Pnp Device Import's taskSeqNo.
			timeTaken integer			Pnp Device Import's timeTaken.
			type string			Pnp Device Import's type.
			workItemList list / elements=string			Pnp Device Import's workItemList.
				command string		Pnp Device Import's command.
				endTime integer		Pnp Device Import's endTime.
				outputStr string		Pnp Device Import's outputStr.
				startTime integer		Pnp Device Import's startTime.
				state string		Pnp Device Import's state.
				timeTaken integer		Pnp Device Import's timeTaken.
		tenantId string				Pnp Device Import's tenantId.
		type string				Pnp Device Import's type.
		useState string				Pnp Device Import's useState.
		version integer				Pnp Device Import's version.
	workflowParameters dictionary					Pnp Device Import's workflowParameters.
		configList list / elements=string				Pnp Device Import's configList.
			configId string			Pnp Device Import's configId.
			configParameters list / elements=string			Pnp Device Import's configParameters.
				key string		Pnp Device Import's key.
				value string		Pnp Device Import's value.
		licenseLevel string				Pnp Device Import's licenseLevel.
		licenseType string				Pnp Device Import's licenseType.
		topOfStackSerialNumber string				Pnp Device Import's topOfStackSerialNumber.
validate_response_schema boolean					Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes 

Note

Does not support check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

Examples 

- name: Create
  cisco.dnac.pnp_device_import:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    payload:

Return Values 

Common return values are documented here, the following are the fields unique to this module:

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

Authors

Rafael Campos (@racampos)

cisco.dnac.pnp_device_import – Resource module for Pnp Device Import

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 