cisco.catalystcenter.pnp_device_claim module -- Resource module for Pnp Device Claim

Note

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

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operation create of the resource Pnp Device Claim.

  • Claims one of more devices with specified workflow.

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

authorizationNeeded

boolean

Flag to enable/disable PnP device authorization. (true means enable).

Choices:

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

configFileUrl

string

Pnp Device Claim's configFileUrl.

configId

string

Pnp Device Claim's configId.

deviceClaimList

list / elements=dictionary

Pnp Device Claim's deviceClaimList.

configList

list / elements=dictionary

Pnp Device Claim's configList.

configId

string

Pnp Device Claim's configId.

configParameters

list / elements=dictionary

Pnp Device Claim's configParameters.

key

string

Pnp Device Claim's key.

value

string

Pnp Device Claim's value.

deviceId

string

Pnp Device Claim's deviceId.

licenseLevel

string

Pnp Device Claim's licenseLevel.

licenseType

string

Pnp Device Claim's licenseType.

topOfStackSerialNumber

string

Pnp Device Claim's topOfStackSerialNumber.

fileServiceId

string

Pnp Device Claim's fileServiceId.

imageId

string

Pnp Device Claim's imageId.

imageUrl

string

Pnp Device Claim's imageUrl.

populateInventory

boolean

PopulateInventory flag.

Choices:

projectId

string

Pnp Device Claim's projectId.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

workflowId

string

Pnp Device Claim's workflowId.

Notes

Note

  • SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.claim_device,

  • Paths used are post /dna/intent/api/v1/onboarding/pnp-device/claim,

  • 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

See Also

See also

Cisco DNA Center documentation for Device Onboarding (PnP) ClaimDevice

Complete reference of the ClaimDevice API.

Examples

---
- name: Create
  cisco.catalystcenter.pnp_device_claim:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    authorizationNeeded: true
    configFileUrl: string
    configId: string
    deviceClaimList:
      - configList:
          - configId: string
            configParameters:
              - key: string
                value: string
        deviceId: string
        licenseLevel: string
        licenseType: string
        topOfStackSerialNumber: string
    fileServiceId: string
    imageId: string
    imageUrl: string
    populateInventory: true
    projectId: string
    workflowId: 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

Sample: :ansible-rv-sample-value:`{"jsonArrayResponse": [{}], "jsonResponse": {}, "message": "string", "statusCode": 0}`

Authors

  • Rafael Campos (@racampos)