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

Note

This module is part of the cisco.catalystcenter collection (version 2.11.0).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.catalystcenter 1.0.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.

catalystcentersdk >= 3.2.3.0.0
python >= 3.12

Parameters 

Parameter	Comments
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
payload list / elements=dictionary	Pnp Device Import's payload.
_id string	Pnp Device Import's _id.
deviceInfo dictionary	Pnp Device Import's deviceInfo.
description string	Pnp Device Import's description.
deviceSudiSerialNos list / elements=string	Pnp Device Import's deviceSudiSerialNos.
hostname string	Pnp Device Import's hostname.
macAddress string	Pnp Device Import's macAddress.
pid string	Pnp Device Import's pid.
serialNumber string	Pnp Device Import's serialNumber.
siteId string	Pnp Device Import's siteId.
stack boolean	Stack flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
stackInfo dictionary	Pnp Device Import's stackInfo.
isFullRing boolean	IsFullRing flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
stackMemberList list / elements=dictionary	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 float	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 float	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	SupportsStackWorkflows flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
totalMemberCount float	Pnp Device Import's totalMemberCount.
validLicenseLevels list / elements=string	Pnp Device Import's validLicenseLevels.
sudiRequired boolean	SudiRequired flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
userMicNumbers list / elements=string	Pnp Device Import's userMicNumbers.
userSudiSerialNos list / elements=string	Pnp Device Import's userSudiSerialNos.
workflowId string	Pnp Device Import's workflowId.
workflowName string	Pnp Device Import's workflowName.
validate_response_schema boolean	Flag for Cisco Catalyst 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 uses the embedded connection manager from Cisco CATALYST SDK
Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

Examples 

---
- name: Create
  cisco.catalystcenter.pnp_device_import:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_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

catalystcenter_response

dictionary

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

Returned: always

Authors

Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)

cisco.catalystcenter.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 