cisco.dnac.device_replacement_info – Information module for Device Replacement

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Device Replacement.

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
family
list / elements=string
Family query parameter. List of familiesRouters, Switches and Hubs, AP.
faultyDeviceName
string
FaultyDeviceName query parameter. Faulty Device Name.
faultyDevicePlatform
string
FaultyDevicePlatform query parameter. Faulty Device Platform.
faultyDeviceSerialNumber
string
FaultyDeviceSerialNumber query parameter. Faulty Device Serial Number.
headers
dictionary
Additional headers.
limit
integer
Limit query parameter.
offset
integer
Offset query parameter.
replacementDevicePlatform
string
ReplacementDevicePlatform query parameter. Replacement Device Platform.
replacementDeviceSerialNumber
string
ReplacementDeviceSerialNumber query parameter. Replacement Device Serial Number.
replacementStatus
list / elements=string
ReplacementStatus query parameter. Device Replacement status READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED.
sortBy
string
SortBy query parameter. SortBy this field. SortBy is mandatory when order is used.
sortOrder
string
SortOrder query parameter. Order on displayNameASC,DESC.

See Also

See also

Device Replacement reference

Complete reference of the Device Replacement object model.

Examples

- name: Get all Device Replacement
  cisco.dnac.device_replacement_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers:
      custom: value
    faultyDeviceName: string
    faultyDevicePlatform: string
    replacementDevicePlatform: string
    faultyDeviceSerialNumber: string
    replacementDeviceSerialNumber: string
    replacementStatus: []
    family: []
    sortBy: string
    sortOrder: string
    offset: 0
    limit: 0
  register: result

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 or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "response": [ { "creationTime": 0, "family": "string", "faultyDeviceId": "string", "faultyDeviceName": "string", "faultyDevicePlatform": "string", "faultyDeviceSerialNumber": "string", "id": "string", "neighbourDeviceId": "string", "networkReadinessTaskId": "string", "replacementDevicePlatform": "string", "replacementDeviceSerialNumber": "string", "replacementStatus": "string", "replacementTime": 0, "workflowId": "string" } ], "version": "string" }


Authors

  • Rafael Campos (@racampos)