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

Note

This module is part of the cisco.dnac collection (version 6.20.0).

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 

Manage operation create of the resource Pnp Device Import.
Add devices to PnP in bulk.

Note

This module has a corresponding action plugin.

Requirements 

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

dnacentersdk >= 2.7.2
python >= 3.5

Parameters 

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"`
payload list / elements=dictionary	Pnp Device Import's payload.
_id string	Id.
deviceInfo dictionary	Pnp Device Import's deviceInfo.
description string	Description.
deviceSudiSerialNos list / elements=string	Device Sudi Serial Nos.
hostname string	Hostname.
isSudiRequired boolean	Is Sudi Required. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
macAddress string	Mac Address.
pid string	Pid.
serialNumber string	Serial Number.
siteId string	Site Id.
stack boolean	Stack. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
stackInfo dictionary	Pnp Device Import's stackInfo.
isFullRing boolean	Is Full Ring. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
stackMemberList list / elements=dictionary	Pnp Device Import's stackMemberList.
hardwareVersion string	Hardware Version.
licenseLevel string	License Level.
licenseType string	License Type.
macAddress string	Mac Address.
pid string	Pid.
priority float	Priority.
role string	Role.
serialNumber string	Serial Number.
softwareVersion string	Software Version.
stackNumber float	Stack Number.
state string	State.
sudiSerialNumber string	Sudi Serial Number.
stackRingProtocol string	Stack Ring Protocol.
supportsStackWorkflows boolean	Supports Stack Workflows. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
totalMemberCount float	Total Member Count.
validLicenseLevels list / elements=string	Valid License Levels.
userMicNumbers list / elements=string	User Mic Numbers.
userSudiSerialNos list / elements=string	User Sudi Serial Nos.
workflowId string	Workflow Id.
workflowName string	Workflow Name.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes 

Note

SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.import_devices_in_bulk,
Paths used are post /dna/intent/api/v1/onboarding/pnp-device/import,
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:
    - _id: string
      deviceInfo:
        description: string
        deviceSudiSerialNos:
        - string
        hostname: string
        isSudiRequired: true
        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
        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

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

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

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 