cisco.dnac.pnp_device_claim – Manage PnpDeviceClaim objects of DeviceOnboardingPnp

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.pnp_device_claim.

New in version 1.0.0: of cisco.dnac

Synopsis

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

• dnacentersdk

Parameters

Parameter				Choices/Defaults	Comments
configFileUrl string					ClaimDeviceRequest's configFileUrl.
configId string					ClaimDeviceRequest's configId.
deviceClaimList list / elements=dictionary					ClaimDeviceRequest's deviceClaimList (list of objects).
	configList list / elements=dictionary				It is the pnp device claim's configList.
		configId string			It is the pnp device claim's configId.
		configParameters list / elements=dictionary			It is the pnp device claim's configParameters.
			key string		It is the pnp device claim's key.
			value string		It is the pnp device claim's value.
	deviceId string				It is the pnp device claim's deviceId.
	licenseLevel string				It is the pnp device claim's licenseLevel.
	licenseType string				It is the pnp device claim's licenseType.
	topOfStackSerialNumber string				It is the pnp device claim's topOfStackSerialNumber.
fileServiceId string					ClaimDeviceRequest's fileServiceId.
imageId string					ClaimDeviceRequest's imageId.
imageUrl string					ClaimDeviceRequest's imageUrl.
populateInventory boolean				Choices: no yes	ClaimDeviceRequest's populateInventory.
projectId string					ClaimDeviceRequest's projectId.
workflowId string					ClaimDeviceRequest's workflowId.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.pnp_device_claim

The official documentation on the cisco.dnac.plugins.module_utils.definitions.pnp_device_claim module.

PnpDeviceClaim reference

Complete reference of the PnpDeviceClaim object model.

PnpDeviceClaim reference

SDK reference.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: device_onboarding_pnp.claim_device

Authors

• Rafael Campos (@racampos)