cisco.dnac.device_replacement_workflow – Manage DeviceReplacementWorkflow objects of DeviceReplacement

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images.

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
faultyDeviceSerialNumber
string / required
DeviceReplacementWorkflowDTO's faultyDeviceSerialNumber.
replacementDeviceSerialNumber
string / required
DeviceReplacementWorkflowDTO's replacementDeviceSerialNumber.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.device_replacement_workflow

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

DeviceReplacementWorkflow reference

Complete reference of the DeviceReplacementWorkflow object model.

DeviceReplacementWorkflow reference

SDK reference.

Examples

- name: deploy_device_replacement_workflow
  cisco.dnac.device_replacement_workflow:
    state: create  # required
    faultyDeviceSerialNumber: SomeValue  # string, required
    replacementDeviceSerialNumber: SomeValue  # string, required

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_replacement.deploy_device_replacement_workflow


Authors

  • Rafael Campos (@racampos)