1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: device_replacement_info
short_description: Information module for Device Replacement
description:
- Get all Device Replacement.
- >
Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty
Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device
Serial Number, Device Replacement status, Product Family.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
faultyDeviceName:
description:
- FaultyDeviceName query parameter. Faulty Device Name.
type: str
faultyDevicePlatform:
description:
- FaultyDevicePlatform query parameter. Faulty Device Platform.
type: str
replacementDevicePlatform:
description:
- ReplacementDevicePlatform query parameter. Replacement Device Platform.
type: str
faultyDeviceSerialNumber:
description:
- FaultyDeviceSerialNumber query parameter. Faulty Device Serial Number.
type: str
replacementDeviceSerialNumber:
description:
- ReplacementDeviceSerialNumber query parameter. Replacement Device Serial Number.
type: str
replacementStatus:
description:
- >
ReplacementStatus query parameter. Device Replacement status READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS,
REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED.
elements: str
type: list
family:
description:
- Family query parameter. List of familiesRouters, Switches and Hubs, AP.
elements: str
type: list
sortBy:
description:
- SortBy query parameter. SortBy this field. SortBy is mandatory when order is used.
type: str
sortOrder:
description:
- SortOrder query parameter. Order on displayNameASC,DESC.
type: str
offset:
description:
- Offset query parameter.
type: int
limit:
description:
- Limit query parameter.
type: int
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Device Replacement ReturnListOfReplacementDevicesWithReplacementDetails
description: Complete reference of the ReturnListOfReplacementDevicesWithReplacementDetails API.
link: https://developer.cisco.com/docs/dna-center/#!return-list-of-replacement-devices-with-replacement-details
notes:
- SDK Method used are
device_replacement.DeviceReplacement.return_replacement_devices_with_details,
- Paths used are
get /dna/intent/api/v1/device-replacement,
"""
EXAMPLES = r"""
- 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: "{{my_headers | from_json}}"
faultyDeviceName: string
faultyDevicePlatform: string
replacementDevicePlatform: string
faultyDeviceSerialNumber: string
replacementDeviceSerialNumber: string
replacementStatus: []
family: []
sortBy: string
sortOrder: string
offset: 0
limit: 0
register: result
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
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",
"workflowFailedStep": "string",
"readinesscheckTaskId": "string"
}
],
"version": "string"
}
"""
|
