/ home / racampos / racampos.dnac / 0.0.1 / module / pnp_device_claim

racampos.dnac.pnp_device_claim (0.0.1) — module

Manage PnpDeviceClaim objects of DeviceOnboardingPnp

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1

Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

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

claim_device:
  contains: null
  description: Claims one of more devices with specified workflow.
  jsonArrayResponse:
    description: ClaimDeviceRequest's Json Array Response (list of any objects).
    returned: success
    type: list
  jsonResponse:
    description: ClaimDeviceRequest's Json Response.
    returned: success
    type: dict
  message:
    description: ClaimDeviceRequest's Message.
    returned: success
    sample: <message>
    type: str
  returned: success
  statusCode:
    description: ClaimDeviceRequest's statusCode.
    returned: success
    sample: 0
    type: int
  type: dict