/ home / cisco / cisco.dnac / 2.0.7 / module / pnp_device_claim

cisco.dnac.pnp_device_claim (2.0.7) — module

Manage PnpDeviceClaim objects of DeviceOnboardingPnp

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Claims one of more devices with specified workflow.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: claim_device
  cisco.dnac.pnp_device_claim:
    state: create  # required
    configFileUrl: SomeValue  # string
    configId: SomeValue  # string
    deviceClaimList:
    - configList:
      - configId: SomeValue  # string
        configParameters:
        - key: SomeValue  # string
          value: SomeValue  # string
      deviceId: SomeValue  # string
      licenseLevel: SomeValue  # string
      licenseType: SomeValue  # string
      topOfStackSerialNumber: SomeValue  # string
    fileServiceId: SomeValue  # string
    imageId: SomeValue  # string
    imageUrl: SomeValue  # string
    populateInventory: True  # boolean
    projectId: SomeValue  # string
    workflowId: SomeValue  # string

Inputs

    
imageId:
    description:
    - ClaimDeviceRequest's imageId.
    type: str

configId:
    description:
    - ClaimDeviceRequest's configId.
    type: str

imageUrl:
    description:
    - ClaimDeviceRequest's imageUrl.
    type: str

projectId:
    description:
    - ClaimDeviceRequest's projectId.
    type: str

workflowId:
    description:
    - ClaimDeviceRequest's workflowId.
    type: str

configFileUrl:
    description:
    - ClaimDeviceRequest's configFileUrl.
    type: str

fileServiceId:
    description:
    - ClaimDeviceRequest's fileServiceId.
    type: str

deviceClaimList:
    description:
    - ClaimDeviceRequest's deviceClaimList (list of objects).
    elements: dict
    suboptions:
      configList:
        description:
        - It is the pnp device claim's configList.
        elements: dict
        suboptions:
          configId:
            description:
            - It is the pnp device claim's configId.
            type: str
          configParameters:
            description:
            - It is the pnp device claim's configParameters.
            elements: dict
            suboptions:
              key:
                description:
                - It is the pnp device claim's key.
                type: str
              value:
                description:
                - It is the pnp device claim's value.
                type: str
            type: list
        type: list
      deviceId:
        description:
        - It is the pnp device claim's deviceId.
        type: str
      licenseLevel:
        description:
        - It is the pnp device claim's licenseLevel.
        type: str
      licenseType:
        description:
        - It is the pnp device claim's licenseType.
        type: str
      topOfStackSerialNumber:
        description:
        - It is the pnp device claim's topOfStackSerialNumber.
        type: str
    type: list

populateInventory:
    description:
    - ClaimDeviceRequest's populateInventory.
    type: bool

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: device_onboarding_pnp.claim_device
  type: str