cisco.dnac.pnp_device_unclaim – Manage PnpDeviceUnclaim 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_unclaim.

New in version 1.0.0: of cisco.dnac

Synopsis

• Un-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
deviceIdList list / elements=string		UnclaimRequest's deviceIdList (list of strings).

See Also

See also

cisco.dnac.plugins.module_utils.definitions.pnp_device_unclaim

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

PnpDeviceUnclaim reference

Complete reference of the PnpDeviceUnclaim object model.

PnpDeviceUnclaim reference

SDK reference.

Examples

- name: un_claim_device
  cisco.dnac.pnp_device_unclaim:
    state: create  # required
    deviceIdList:
    - 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.un_claim_device

Authors

• Rafael Campos (@racampos)