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

Note

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

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

  • This module represents an alias of the module pnp_device_claim_v1

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

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

authorizationNeeded

boolean

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

Choices:

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_v1,

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

  • It should be noted that this module is an alias of pnp_device_claim_v1

  • 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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Device Onboarding (PnP) ClaimDeviceV1

Complete reference of the ClaimDeviceV1 API.

Examples

- name: Create
  cisco.catalystcenter.pnp_device_claim:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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

catalystcenter_response

dictionary

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

Returned: always

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

Authors

  • Rafael Campos (@racampos)