cisco.dnac.pnp_device_site_claim – Manage PnpDeviceSiteClaim 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_site_claim.

New in version 1.0.0: of cisco.dnac

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms.

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
deviceId string		SiteProvisionRequest's deviceId.
siteId string		SiteProvisionRequest's siteId.
type string		SiteProvisionRequest's type. Available values are 'Default', 'AccessPoint', 'StackSwitch', 'Sensor' and 'MobilityExpress'.

Examples ¶

- name: claim_a_device_to_a_site
  cisco.dnac.pnp_device_site_claim:
    state: create  # required
    deviceId: SomeValue  # string
    siteId: SomeValue  # string
    type: # valid values are 'Default',
      # 'AccessPoint',
      # 'StackSwitch',
      # 'Sensor',
      # 'MobilityExpress'.
      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_a_device_to_a_site

Authors¶

Rafael Campos (@racampos)

cisco.dnac.pnp_device_site_claim – Manage PnpDeviceSiteClaim objects of DeviceOnboardingPnp¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶