cisco.dnac.pnp_device_import module – Resource module for Pnp Device Import
Note
This module is part of the cisco.dnac collection (version 6.25.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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.pnp_device_import.
New in cisco.dnac 3.1.0
Synopsis
This module represents an alias of the module pnp_device_import_v1
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Pnp Device Import’s payload. |
|
Id. |
|
Pnp Device Import’s deviceInfo. |
|
Description. |
|
Device Sudi Serial Nos. |
|
Hostname. |
|
Mac Address. |
|
Pid. |
|
Serial Number. |
|
Site Id. |
|
Stack. Choices:
|
|
Pnp Device Import’s stackInfo. |
|
Is Full Ring. Choices:
|
|
Pnp Device Import’s stackMemberList. |
|
Hardware Version. |
|
License Level. |
|
License Type. |
|
Mac Address. |
|
Pid. |
|
Priority. |
|
Role. |
|
Serial Number. |
|
Software Version. |
|
Stack Number. |
|
State. |
|
Sudi Serial Number. |
|
Stack Ring Protocol. |
|
Supports Stack Workflows. Choices:
|
|
Total Member Count. |
|
Valid License Levels. |
|
Is Sudi Required. Choices:
|
|
User Mic Numbers. |
|
User Sudi Serial Nos. |
|
Workflow Id. |
|
Workflow Name. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.import_devices_in_bulk_v1,
Paths used are post /dna/intent/api/v1/onboarding/pnp-device/import,
It should be noted that this module is an alias of pnp_device_import_v1
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
- Cisco DNA Center documentation for Device Onboarding (PnP) ImportDevicesInBulkV1
Complete reference of the ImportDevicesInBulkV1 API.
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:
- _id: string
deviceInfo:
description: string
deviceSudiSerialNos:
- string
hostname: string
macAddress: string
pid: string
serialNumber: string
siteId: 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
sudiRequired: true
userMicNumbers:
- string
userSudiSerialNos:
- string
workflowId: string
workflowName: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |