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

Note

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

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 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.

catalystcentersdk >= 3.1.3.0.0
python >= 3.5

Parameters 

Parameter	Comments
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst 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.
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.
sudiRequired boolean	Is Sudi Required. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
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 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

Examples 

---
- name: Create
  cisco.catalystcenter.pnp_device_import:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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

dnac_response

dictionary

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

Returned: always

Authors

Rafael Campos (@racampos)

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 