cisco.dnac.pnp_device_reset – Manage PnpDeviceReset 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_reset.

New in version 1.0.0: of cisco.dnac

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

Recovers a device from a Workflow Execution Error state.

Note

This module has a corresponding action plugin.

Requirements ¶

The below requirements are needed on the host that executes this module.

dnacentersdk

Parameters ¶

Parameter				Comments
deviceResetList list / elements=dictionary				ResetRequest's deviceResetList (list of objects).
	configList list / elements=dictionary			It is the pnp device reset's configList.
		configId string		It is the pnp device reset's configId.
		configParameters list / elements=dictionary		It is the pnp device reset's configParameters.
			key string	It is the pnp device reset's key.
			value string	It is the pnp device reset's value.
	deviceId string			It is the pnp device reset's deviceId.
	licenseLevel string			It is the pnp device reset's licenseLevel.
	licenseType string			It is the pnp device reset's licenseType.
	topOfStackSerialNumber string			It is the pnp device reset's topOfStackSerialNumber.
projectId string				ResetRequest's projectId.
workflowId string				ResetRequest's workflowId.

Examples ¶

- name: reset_device
  cisco.dnac.pnp_device_reset:
    state: create  # required
    deviceResetList:
    - configList:
      - configId: SomeValue  # string
        configParameters:
        - key: SomeValue  # string
          value: SomeValue  # string
      deviceId: SomeValue  # string
      licenseLevel: SomeValue  # string
      licenseType: SomeValue  # string
      topOfStackSerialNumber: SomeValue  # string
    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.reset_device

Authors¶

Rafael Campos (@racampos)

cisco.dnac.pnp_device_reset – Manage PnpDeviceReset objects of DeviceOnboardingPnp¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶