cisco.dnac.network_device_replacements_v1_info module – Information module for Network Device Replacements V1
Note
This module is part of the cisco.dnac collection (version 6.27.0).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.network_device_replacements_v1_info.
New in cisco.dnac 6.17.0
Synopsis
Get all Network Device Replacements V1.
Retrieve the list of device replacements with replacement details. Filters can be applied based on faulty device name, faulty device platform, faulty device serial number, replacement device platform, replacement device serial number, device replacement status, device family.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Family query parameter. Faulty device family. |
|
FaultyDeviceName query parameter. Faulty device name. |
|
FaultyDevicePlatform query parameter. Faulty device platform. |
|
FaultyDeviceSerialNumber query parameter. Faulty device serial number. |
|
Additional headers. |
|
Limit query parameter. The number of records to show for this page. Maximum value can be 500. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
ReplacementDevicePlatform query parameter. Replacement device platform. |
|
ReplacementDeviceSerialNumber query parameter. Replacement device serial number. |
|
ReplacementStatus query parameter. Device replacement status. Available values MARKED_FOR_REPLACEMENT, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED, READY_FOR_REPLACEMENT, REPLACEMENT_SCHEDULED, REPLACEMENT_IN_PROGRESS, REPLACED, ERROR. Replacement status ‘MARKED_FOR_REPLACEMENT’ - The faulty device has been marked for replacement. ‘NETWORK_READINESS_REQUESTED’ - Initiated steps to shut down neighboring device interfaces and create a DHCP server on the uplink neighbor if the faulty device is part of a fabric setup. ‘NETWORK_READINESS_FAILED’ - Preparation of the network failed. Neighboring device interfaces were not shut down, and the DHCP server on the uplink neighbor was not created. ‘READY_FOR_REPLACEMENT’ - The network is prepared for the faulty device replacement. Neighboring device interfaces are shut down, and the DHCP server on the uplink neighbor is set up. ‘REPLACEMENT_SCHEDULED’ - Device replacement has been scheduled. ‘REPLACEMENT_IN_PROGRESS’ - Device replacement is currently in progress. ‘REPLACED’ - Device replacement was successful. ‘ERROR’ - Device replacement has failed. |
|
SortBy query parameter. A property within the response to sort by. Available values id, creationTime, family, faultyDeviceId, fautyDeviceName, faultyDevicePlatform, faultyDeviceSerialNumber, replacementDevicePlatform, replacementDeviceSerialNumber, replacementTime. |
|
SortOrder query parameter. Whether ascending or descending order should be used to sort the response. Available values ASC, DESC. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are device_replacement.DeviceReplacement.retrieve_the_status_of_all_the_device_replacement_workflows_v1,
Paths used are get /dna/intent/api/v1/networkDeviceReplacements,
Supports
check_modeThe 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
- Cisco DNA Center documentation for Device Replacement RetrieveTheStatusOfAllTheDeviceReplacementWorkflowsV1
Complete reference of the RetrieveTheStatusOfAllTheDeviceReplacementWorkflowsV1 API.
Examples
- name: Get all Network Device Replacements V1
cisco.dnac.network_device_replacements_v1_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: "{{my_headers | from_json}}"
family: string
faultyDeviceName: string
faultyDevicePlatform: string
faultyDeviceSerialNumber: string
replacementDevicePlatform: string
replacementDeviceSerialNumber: string
replacementStatus: string
offset: 0
limit: 0
sortBy: string
sortOrder: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |