cisco.dnac.device_replacement_info module – Information module for Device Replacement

Note

This module is part of the cisco.dnac collection (version 3.3.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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 3.1.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 >= 2.3.3

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port string	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: “admin”
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.2.3”
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.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (default)

Notes

Note

• Supports check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

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

Description

dnac_response dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: “{\n \”response\”: [\n {\n \”creationTime\”: 0,\n \”family\”: \”string\”,\n \”faultyDeviceId\”: \”string\”,\n \”faultyDeviceName\”: \”string\”,\n \”faultyDevicePlatform\”: \”string\”,\n \”faultyDeviceSerialNumber\”: \”string\”,\n \”id\”: \”string\”,\n \”neighbourDeviceId\”: \”string\”,\n \”networkReadinessTaskId\”: \”string\”,\n \”replacementDevicePlatform\”: \”string\”,\n \”replacementDeviceSerialNumber\”: \”string\”,\n \”replacementStatus\”: \”string\”,\n \”replacementTime\”: 0,\n \”workflowId\”: \”string\”\n }\n ],\n \”version\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)