xclarity_client 0.6.3 → 0.6.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +5 -5
  2. data/docs/apib/discover_request.apib +3 -1
  3. data/docs/apib/event.apib +0 -1
  4. data/docs/apib/manage_request.apib +359 -0
  5. data/docs/apib/storages.apib +3 -3
  6. data/docs/apib/update_comp.apib +426 -0
  7. data/docs/apib/update_repo.apib +0 -57
  8. data/lib/xclarity_client.rb +0 -1
  9. data/lib/xclarity_client/client.rb +3 -0
  10. data/lib/xclarity_client/connection/connection.rb +73 -35
  11. data/lib/xclarity_client/endpoints/endpoints.rb +3 -0
  12. data/lib/xclarity_client/endpoints/manage_request.rb +11 -0
  13. data/lib/xclarity_client/endpoints/management_server.rb +5 -0
  14. data/lib/xclarity_client/endpoints/storage.rb +7 -6
  15. data/lib/xclarity_client/endpoints/update_comp.rb +18 -0
  16. data/lib/xclarity_client/mixins/job_mixin.rb +0 -4
  17. data/lib/xclarity_client/mixins/manage_request_mixin.rb +54 -0
  18. data/lib/xclarity_client/mixins/management_server_mixin.rb +40 -0
  19. data/lib/xclarity_client/mixins/mixins.rb +3 -0
  20. data/lib/xclarity_client/mixins/node_mixin.rb +42 -0
  21. data/lib/xclarity_client/mixins/update_comp_mixin.rb +37 -0
  22. data/lib/xclarity_client/mixins/update_repo_mixin.rb +107 -7
  23. data/lib/xclarity_client/services/job_management.rb +2 -4
  24. data/lib/xclarity_client/services/manage_request_management.rb +62 -0
  25. data/lib/xclarity_client/services/management_server_management.rb +86 -0
  26. data/lib/xclarity_client/services/node_management.rb +46 -0
  27. data/lib/xclarity_client/services/osimage_management.rb +3 -2
  28. data/lib/xclarity_client/services/remote_access_management.rb +6 -4
  29. data/lib/xclarity_client/services/services.rb +3 -0
  30. data/lib/xclarity_client/services/update_comp_management.rb +111 -0
  31. data/lib/xclarity_client/services/update_repo_management.rb +100 -47
  32. data/lib/xclarity_client/services/virtual_appliance_management.rb +13 -16
  33. data/lib/xclarity_client/services/xclarity_service.rb +2 -3
  34. data/lib/xclarity_client/version.rb +1 -1
  35. data/lib/xclarity_client/xclarity_credentials_validator.rb +8 -11
  36. data/xclarity_client.gemspec +2 -2
  37. metadata +26 -11
  38. data/lib/xclarity_client/xclarity_base.rb +0 -88
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 925a13b7e8f9b9f52254d8bc8e223f66575d906f
4
- data.tar.gz: 49143f5132f618303c665035b8e07e1f48bd627a
2
+ SHA256:
3
+ metadata.gz: 93f3a37b4be374e9ba34f6990c9e46d1b3ba23c88d5598ee4a3f4e8e2c986792
4
+ data.tar.gz: 89d3701a8c8a56cd908a16dcc9bb2fc87201fce748bfd7d5f7bd58909fcce575
5
5
  SHA512:
6
- metadata.gz: ea345864b94e0a2abac7a61c9074c2fc8cfc7cad540b51bf711d3523813108232e7ca014c160c710067e9f8a2cd9f18f1c40b0fb06ae830b53c8b46a0ed3b454
7
- data.tar.gz: ed2ac8bcef67945b1dcb403b8eeab2dc8712366768950c06449fe13acb5a71621ecfe26d02b7b9a402109e0e141b302fb8a55b2afed309af02a3ec49998fa0a8
6
+ metadata.gz: 376facde31d78ecf40fba84fcda0fa1bfa6e178bfe27309481c5e5d0e98ae41cc0e4a2c47fcf283d9689f1d625ac806f11e6d8ef53090f33f24b025f95af1a52
7
+ data.tar.gz: a23e892af247dc745d995c0c475be1875f9d1b658c0e821f5dd437613e94a3e9e8915ed57159b1b70dbe10f6b4595f3494ea66b2c63239a5750fecdb5d9ca763
data/docs/apib/discover_request.apib CHANGED
@@ -30,7 +30,9 @@ FORMAT: 1A
30
30
  "ipAddresses" : [""]
31
31
  }
32
32
  ]
33
- + Response 200
33
+ + Response 200 (application/json)
34
+ + Headers
35
+ Location: /discoverRequest/jobs/215
34
36
 
35
37
  + Response 400
36
38
  + Response 401
data/docs/apib/event.apib CHANGED
@@ -14,7 +14,6 @@ FORMAT: 1A
14
14
  Range: "0-1"
15
15
 
16
16
  + Response 200 (application/json)
17
- [ { "eventDate": "2016-12-21T17:13:58Z", "systemTypeText": "Management", "chassisText": "Not Available", "timeStamp": "2016-12-21T17:13:58Z", "location": "", "args": [ "EAAC33576492E511B46A70E28412CA06" ], "originatorUUID": "", "systemName": "Management Server", "bayText": "Not Available", "mtm": "", "userid": "", "fruSerialNumberText": "Not Available", "eventSourceText": "Management", "senderUUID": "", "serialnum": "", "sourceLogID": "", "action": 100, "parameters": {}, "localLogSequence": "", "localLogID": "", "sourceID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "systemTypeModelText": "Not Available", "commonEventID": "FQXHMTS0012X", "flags": "", "userIDIndex": 0, "failSNs": "", "severityText": "Warning", "severity": 300, "serviceabilityText": "User", "failFRUs": "", "msg": "Endpoint EAAC33576492E511B46A70E28412CA06 could not be accessed because credentials were refused.", "componentID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "eventClass": 800, "eventID": "FQXHMTS0009G", "sourceLogSequence": 0, "systemSerialNumberText": "Not Available", "cn": "242679", "service": 300, "typeText": "System", "msgID": "", "systemFruNumberText": "Not Available", "systemText": "Management Server" }, { "eventDate": "2016-12-21T17:13:58Z", "systemTypeText": "Management", "chassisText": "Not Available", "timeStamp": "2016-12-21T17:13:58Z", "location": "", "args": [ "EAAC33576492E511B46A70E28412CA06", "03.76.208", "TB5TS381" ], "originatorUUID": "", "systemName": "Management Server", "bayText": "Not Available", "mtm": "", "userid": "", "fruSerialNumberText": "Not Available", "eventSourceText": "Management", "senderUUID": "", "serialnum": "", "sourceLogID": "", "action": 100, "parameters": {}, "localLogSequence": "", "localLogID": "", "sourceID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "systemTypeModelText": "Not Available", "commonEventID": "FQXHMTS0012X", "flags": "", "userIDIndex": 0, "failSNs": "", "severityText": "Warning", "severity": 300, "serviceabilityText": "User", "failFRUs": "", "msg": "Inventory data could not be retrieved from the endpoint EAAC33576492E511B46A70E28412CA06. BIOS: 03.76.208, BMC: TB5TS381", "componentID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "eventClass": 800, "eventID": "FQXHMTS0003G", "sourceLogSequence": 0, "systemSerialNumberText": "Not Available", "cn": "242678", "service": 300, "typeText": "System", "msgID": "", "systemFruNumberText": "Not Available", "systemText": "Management Server" }, { "eventDate": "2016-12-21T17:13:58Z", "systemTypeText": "Management", "chassisText": "Not Available", "timeStamp": "2016-12-21T17:13:58Z", "location": "", "args": [ "EAAC33576492E511B46A70E28412CA06" ], "originatorUUID": "", "systemName": "Management Server", "bayText": "Not Available", "mtm": "", "userid": "", "fruSerialNumberText": "Not Available", "eventSourceText": "Management", "senderUUID": "", "serialnum": "", "sourceLogID": "", "action": 100, "parameters": {}, "localLogSequence": "", "localLogID": "", "sourceID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "systemTypeModelText": "Not Available", "commonEventID": "FQXHMTS0012X", "flags": "", "userIDIndex": 0, "failSNs": "", "severityText": "Warning", "severity": 300, "serviceabilityText": "User", "failFRUs": "", "msg": "Endpoint EAAC33576492E511B46A70E28412CA06 could not be accessed because credentials were refused.", "componentID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "eventClass": 800, "eventID": "FQXHMTS0009G", "sourceLogSequence": 0, "systemSerialNumberText": "Not Available", "cn": "242677", "service": 300, "typeText": "System", "msgID": "", "systemFruNumberText": "Not Available", "systemText": "Management Server" } ]
18
17
  + Header
19
18
  Content-Range: "0-1/9999"
20
19
 
data/docs/apib/manage_request.apib ADDED
@@ -0,0 +1,359 @@
1
+ FORMAT: 1A
2
+
3
+ # XClarity Users
4
+
5
+ # GET /manageRequest/jobs/4229
6
+
7
+ + Response 200 (application/json)
8
+ {
9
+ "progress": 100.0,
10
+ "results": [{
11
+ "result": "OTHER_FAIL",
12
+ "resultLongDescription": "An internal error occurred during the management process. Attempt the management operation again. If the problem persists, contact Support.",
13
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.rest.messages",
14
+ "messageParameters": "10.240.72.172",
15
+ "resultShortDescription": "Other failure",
16
+ "progress": 100.0,
17
+ "messageID": "0509_LONG",
18
+ "uuid": "46920c143355486f97c19a34abc7d746",
19
+ "taskid": 4228,
20
+ "time_spent": 68026,
21
+ "status": {
22
+ "substatus": [{
23
+ "longDescription": "Starting endpoint management job",
24
+ "userAction": "",
25
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
26
+ "messageID": "1000_SHORT",
27
+ "progress": 100.0,
28
+ "started": true,
29
+ "id": "STARTING",
30
+ "shortDescription": "Starting",
31
+ "completed": true,
32
+ "status": {
33
+ "percentage": 100.0,
34
+ "description": [{
35
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
36
+ "messageID": "1027_LONG"
37
+ }],
38
+ "state": "Complete"
39
+ }
40
+ }, {
41
+ "longDescription": "Choosing best network path to manage the endpoint",
42
+ "userAction": "",
43
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
44
+ "messageID": "1001_SHORT",
45
+ "progress": 100.0,
46
+ "started": true,
47
+ "id": "NETWORK_CHOICE",
48
+ "shortDescription": "Network choice",
49
+ "completed": true,
50
+ "status": {
51
+ "percentage": 100.0,
52
+ "description": [{
53
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
54
+ "messageID": "1027_LONG"
55
+ }],
56
+ "state": "Complete"
57
+ }
58
+ }, {
59
+ "longDescription": "Creating hardware descriptor",
60
+ "userAction": "",
61
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
62
+ "messageID": "1002_SHORT",
63
+ "progress": 100.0,
64
+ "started": true,
65
+ "id": "DESCRIPTOR",
66
+ "shortDescription": "Descriptor",
67
+ "completed": true,
68
+ "status": {
69
+ "percentage": 100.0,
70
+ "description": [{
71
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
72
+ "messageID": "1027_LONG"
73
+ }],
74
+ "state": "Complete"
75
+ }
76
+ }, {
77
+ "longDescription": "Logging in to endpoint",
78
+ "userAction": "",
79
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
80
+ "messageID": "1003_SHORT",
81
+ "progress": 100.0,
82
+ "started": true,
83
+ "id": "LOGIN",
84
+ "shortDescription": "Login",
85
+ "completed": true,
86
+ "status": {
87
+ "percentage": 100.0,
88
+ "description": [{
89
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
90
+ "messageID": "1027_LONG"
91
+ }],
92
+ "state": "Complete"
93
+ }
94
+ }, {
95
+ "longDescription": "Checking for duplicates of endpoint management",
96
+ "userAction": "",
97
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
98
+ "messageID": "1004_SHORT",
99
+ "progress": 100.0,
100
+ "started": true,
101
+ "id": "DUPLICATE_CHECK",
102
+ "shortDescription": "Duplicate check",
103
+ "completed": true,
104
+ "status": {
105
+ "percentage": 100.0,
106
+ "description": [{
107
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
108
+ "messageID": "1027_LONG"
109
+ }],
110
+ "state": "Complete"
111
+ }
112
+ }, {
113
+ "longDescription": "Collecting endpoint inventory",
114
+ "userAction": "",
115
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
116
+ "messageID": "1005_SHORT",
117
+ "progress": 0.0,
118
+ "started": false,
119
+ "id": "INVENTORY",
120
+ "shortDescription": "Inventory",
121
+ "completed": false,
122
+ "status": {
123
+ "substatus": [{
124
+ "longDescription": "Collecting chassis inventory",
125
+ "userAction": "",
126
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
127
+ "messageID": "1006_SHORT",
128
+ "progress": 0.0,
129
+ "started": false,
130
+ "id": "INV_CHASSIS",
131
+ "shortDescription": "Chassis inventory",
132
+ "completed": false,
133
+ "status": {
134
+ "percentage": 0.0,
135
+ "description": [{
136
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
137
+ "messageID": "1027_LONG"
138
+ }],
139
+ "state": "Stopped_With_Error"
140
+ }
141
+ }, {
142
+ "longDescription": "Collecting node inventory",
143
+ "userAction": "",
144
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
145
+ "messageID": "1007_SHORT",
146
+ "progress": 0.0,
147
+ "started": false,
148
+ "id": "INV_NODES",
149
+ "shortDescription": "Node inventory",
150
+ "completed": false,
151
+ "status": {
152
+ "percentage": 0.0,
153
+ "description": [{
154
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
155
+ "messageID": "1027_LONG"
156
+ }],
157
+ "state": "Stopped_With_Error"
158
+ }
159
+ }, {
160
+ "longDescription": "Collection I/O module inventory",
161
+ "userAction": "",
162
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
163
+ "messageID": "1008_SHORT",
164
+ "progress": 0.0,
165
+ "started": false,
166
+ "id": "INV_IOMS",
167
+ "shortDescription": "I/O module inventory",
168
+ "completed": false,
169
+ "status": {
170
+ "percentage": 0.0,
171
+ "description": [{
172
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
173
+ "messageID": "1027_LONG"
174
+ }],
175
+ "state": "Stopped_With_Error"
176
+ }
177
+ }],
178
+ "percentage": 0.0,
179
+ "description": [{
180
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
181
+ "messageID": "1027_LONG"
182
+ }],
183
+ "state": "Stopped_With_Error"
184
+ }
185
+ }, {
186
+ "longDescription": "Verifying endpoint interoperability",
187
+ "userAction": "",
188
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
189
+ "messageID": "1009_SHORT",
190
+ "progress": 0.0,
191
+ "started": false,
192
+ "id": "INTEROP_CHECK",
193
+ "shortDescription": "Interoperability check",
194
+ "completed": false,
195
+ "status": {
196
+ "percentage": 0.0,
197
+ "description": [{
198
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
199
+ "messageID": "1027_LONG"
200
+ }],
201
+ "state": "Stopped_With_Error"
202
+ }
203
+ }, {
204
+ "longDescription": "Configuring endpoint for management",
205
+ "userAction": "",
206
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
207
+ "messageID": "1010_SHORT",
208
+ "progress": 0.0,
209
+ "started": false,
210
+ "id": "CONFIGURATION",
211
+ "shortDescription": "Configuration",
212
+ "completed": false,
213
+ "status": {
214
+ "substatus": [{
215
+ "longDescription": "Configuring NTP",
216
+ "userAction": "",
217
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
218
+ "messageID": "1011_SHORT",
219
+ "progress": 0.0,
220
+ "started": false,
221
+ "id": "CFG_NTP",
222
+ "shortDescription": "NTP",
223
+ "completed": false,
224
+ "status": {
225
+ "percentage": 0.0,
226
+ "description": [{
227
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
228
+ "messageID": "1027_LONG"
229
+ }],
230
+ "state": "Stopped_With_Error"
231
+ }
232
+ }, {
233
+ "longDescription": "Updating DNS servers ip addresses on CMM as part of the manage chassis process.",
234
+ "userAction": "",
235
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
236
+ "messageID": "1067_SHORT",
237
+ "progress": 0.0,
238
+ "started": false,
239
+ "id": "CFG_DNS_UPD",
240
+ "shortDescription": "Updating DNS servers ip addresses on CMM",
241
+ "completed": false,
242
+ "status": {
243
+ "percentage": 0.0,
244
+ "description": [{
245
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
246
+ "messageID": "1027_LONG"
247
+ }],
248
+ "state": "Stopped_With_Error"
249
+ }
250
+ }, {
251
+ "longDescription": "Configuring security",
252
+ "userAction": "",
253
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
254
+ "messageID": "1012_SHORT",
255
+ "progress": 0.0,
256
+ "started": false,
257
+ "id": "CFG_SECURITY",
258
+ "shortDescription": "Security",
259
+ "completed": false,
260
+ "status": {
261
+ "percentage": 0.0,
262
+ "description": [{
263
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
264
+ "messageID": "1027_LONG"
265
+ }],
266
+ "state": "Stopped_With_Error"
267
+ }
268
+ }, {
269
+ "longDescription": "Putting endpoint under managed authentication",
270
+ "userAction": "",
271
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
272
+ "messageID": "1013_SHORT",
273
+ "progress": 0.0,
274
+ "started": false,
275
+ "id": "CFG_CMGMT",
276
+ "shortDescription": "Managed authentication",
277
+ "completed": false,
278
+ "status": {
279
+ "percentage": 0.0,
280
+ "description": [{
281
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
282
+ "messageID": "1027_LONG"
283
+ }],
284
+ "state": "Stopped_With_Error"
285
+ }
286
+ }],
287
+ "percentage": 0.0,
288
+ "description": [{
289
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
290
+ "messageID": "1027_LONG"
291
+ }],
292
+ "state": "Stopped_With_Error"
293
+ }
294
+ }, {
295
+ "longDescription": "Configuring Hardware location",
296
+ "userAction": "",
297
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
298
+ "messageID": "1097_SHORT",
299
+ "progress": 0.0,
300
+ "started": false,
301
+ "id": "CFG_CABINET",
302
+ "shortDescription": "Configuring Hardware location",
303
+ "completed": false,
304
+ "status": {
305
+ "percentage": 0.0,
306
+ "description": [{
307
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
308
+ "messageID": "1027_LONG"
309
+ }],
310
+ "state": "Stopped_With_Error"
311
+ }
312
+ }, {
313
+ "longDescription": "Completing endpoint management job",
314
+ "userAction": "",
315
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
316
+ "messageID": "1114_SHORT",
317
+ "progress": 0.0,
318
+ "started": true,
319
+ "id": "MANAGESTOP",
320
+ "shortDescription": "Completing",
321
+ "completed": false,
322
+ "status": {
323
+ "percentage": 0.0,
324
+ "description": [{
325
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
326
+ "messageID": "1027_LONG"
327
+ }],
328
+ "state": "Running"
329
+ }
330
+ }],
331
+ "percentage": 100.0,
332
+ "description": [{
333
+ "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
334
+ "messageID": "1027_LONG"
335
+ }],
336
+ "state": "Stopped_With_Error"
337
+ }
338
+ }],
339
+ "status": "INCOMPLETE"
340
+ }
341
+
342
+ + Response 400
343
+ + Response 401
344
+ + Response 404
345
+ + Response 409
346
+ + Response 500
347
+
348
+ # POST /manageRequest
349
+ + Request (application/json)
350
+
351
+ + Response 200 (application/json)
352
+ + Headers
353
+ Location: /manageRequest/jobs/4229
354
+
355
+ + Response 400
356
+ + Response 401
357
+ + Response 404
358
+ + Response 409
359
+ + Response 500
data/docs/apib/storages.apib CHANGED
@@ -2,7 +2,7 @@ FORMAT: 1A
2
2
 
3
3
  # Storages
4
4
 
5
- # GET /storages
5
+ # GET /storage
6
6
 
7
7
  + Response 200 (application/json)
8
8
  {
@@ -483,7 +483,7 @@ FORMAT: 1A
483
483
  + Response 409
484
484
  + Response 500
485
485
 
486
- # GET /storages/1B33D6D13F267A614567A897DC784F00?includeAttributes=name,type,accessState,driveBays,enclosureCount,canisterSlots,room
486
+ # GET /storage/1B33D6D13F267A614567A897DC784F00?includeAttributes=name,type,accessState,driveBays,enclosureCount,canisterSlots,room
487
487
 
488
488
  + Response 200 (application/json)
489
489
  {
@@ -506,7 +506,7 @@ FORMAT: 1A
506
506
  + Response 409
507
507
  + Response 500
508
508
 
509
- # GET /storages/1B33D6D13F267A614567A897DC784F00?excludeAttributes=type,room
509
+ # GET /storage/1B33D6D13F267A614567A897DC784F00?excludeAttributes=type,room
510
510
 
511
511
  + Response 200 (application/json)
512
512
  {
data/docs/apib/update_comp.apib ADDED
@@ -0,0 +1,426 @@
1
+ FORMAT: 1A
2
+
3
+ # XClarity UpdateComp
4
+
5
+ # Components [/updatableComponents]
6
+
7
+ ## Retrieve [GET]
8
+ + Response 200
9
+ {
10
+ "DeviceList": [
11
+ {
12
+ "CMMList": [
13
+ {
14
+ "UpdateStatus": {
15
+ "JobID": 1,
16
+ "PercentComplete": 1,
17
+ "Phase": "Applying",
18
+ "StartTime": "2015-04-13 12:50:31.077",
19
+ "State": "InProgress",
20
+ "Status": "Active",
21
+ "TaskID": 1
22
+ },
23
+ "UUID": "6134AFCEA91311E199A5A45AC8953137"
24
+ }
25
+ ]
26
+ },
27
+ {
28
+ "ServerList": [
29
+ {
30
+ "UUID": "8BFBADCC33CB11E499F740F2E9903640",
31
+ "Components": [{
32
+ "Component": "System Prerequisites",
33
+ "UpdateStatus": {
34
+ "JobID": 1,
35
+ "PercentComplete": 0,
36
+ "Phase": "Queued",
37
+ "State": "Blocked",
38
+ "Status": "Queued",
39
+ "TaskID": 4
40
+ },
41
+ "Weight": 1
42
+ },
43
+ {
44
+ "Component": "ITE",
45
+ "UpdateStatus": {
46
+ "CurrentComponent": {
47
+ "Component": "Queued"
48
+ },
49
+ "PercentComplete": 0,
50
+ "State": "NotStarted",
51
+ "Status": "Active",
52
+ "TotalComplete": 0,
53
+ "TotalComponents": 32
54
+ }
55
+ }
56
+ ]
57
+ },
58
+ {
59
+ "UUID": "0CDF130FDFC211E392806CAE8B704250",
60
+ "Components": [
61
+ {
62
+ "Component": "System Prerequisites",
63
+ "UpdateStatus": {
64
+ "JobID": 1,
65
+ "PercentComplete": 0,
66
+ "Phase": "Queued",
67
+ "State": "Blocked",
68
+ "Status": "Queued",
69
+ "TaskID": 64
70
+ },
71
+ "Weight": 1
72
+
73
+ },
74
+ {
75
+ "Component": "ITE",
76
+ "UpdateStatus": {
77
+ "CurrentComponent": {
78
+ "Component": "Queued"
79
+ },
80
+ "PercentComplete": 0,
81
+ "State": "NotStarted",
82
+ "Status": "Active",
83
+ "TotalComplete": 0,
84
+ "TotalComponents": 30
85
+ }
86
+ }
87
+ ]
88
+ }
89
+ ]
90
+ },
91
+ {
92
+ "SwitchList": [
93
+ {
94
+ "ReadinessCheck": {
95
+ "ElapsedTime": "00:00:00:01.509",
96
+ "ElapsedTimeFormatted": "1 second 509 milliseconds",
97
+ "EndTime": "2016-04-07 23:44:10.366",
98
+ "JobID": 1,
99
+ "PercentComplete": 100,
100
+ "Phase": "Complete",
101
+ "StartTime": "2016-04-07 23:44:08.857",
102
+ "State": "Complete",
103
+ "Status": "Failed",
104
+ "TaskID": 1,
105
+ "Message": {
106
+ "result": "informational",
107
+ "messages": [
108
+ {
109
+ "id": "FQXHMUP1000I",
110
+ "text": "The command completed successfully."
111
+ },
112
+ {
113
+ "id": "FQXHMUP4545L",
114
+ "text": "The device is not ready for an update.",
115
+ "explanation": "The device did not pass validation for firmware updates..",
116
+ "recovery": {
117
+ "text": "Correct the issues discovered by validation checks."
118
+ }
119
+ }
120
+ ]
121
+ }
122
+ },
123
+ "UpdateStatus": {
124
+ "EndTime": "2016-04-07 23:44:10.869",
125
+ "JobID": 1,
126
+ "PercentComplete": 100,
127
+ "Phase": "Complete",
128
+ "State": "Complete",
129
+ "Status": "Canceled",
130
+ "TaskID": 3,
131
+ "Message": {
132
+ "result": "warning",
133
+ "messages": [
134
+ {
135
+ "id": "FQXHMUP4086F",
136
+ "text": "The RackSwitch G7052 xHMCUpdates task was canceled.",
137
+ "explanation": "The task was canceled",
138
+ "recovery": {
139
+ "text": "Try to perform the update again.If the problem persists"
140
+ }
141
+ }
142
+ ]
143
+ }
144
+ },
145
+ "UUID": "0b0f5101bb8844b8b2d1c1aaeb24f446"
146
+ }
147
+ ]
148
+ }
149
+ ],
150
+ "UpdateStatusMetrics": {
151
+ "TotaldeviceUpdates": 6,
152
+ "TotaldeviceUpdatesActive": 6,
153
+ "TotaldeviceUpdatesComplete": 0,
154
+ "TotaldeviceUpdatesInProgress": 1,
155
+ "TotalJobs": 1,
156
+ "TotalJobsComplete": 0,
157
+ "TotalJobsInProgress": 1,
158
+ "TotalJobsPercentComplete": 0,
159
+ "TotalSupportTasks": 18,
160
+ "TotalSupportTasksActive": 18,
161
+ "TotalTasks": 93,
162
+ "TotalTasksBlocked": 92,
163
+ "TotalTasksCanceled": 0,
164
+ "TotalTasksComplete": 0,
165
+ "TotalTasksFailed": 0,
166
+ "TotalTasksInProgress": 1,
167
+ "TotalTasksSuccess": 0,
168
+ "TotalUpdateTasks": 75,
169
+ "TotalUpdateTasksActive": 72
170
+ },
171
+ "result": "informational",
172
+ "messages": [
173
+ {
174
+ "id": "FQXHMUP4091I",
175
+ "text": "Update Status was obtained successfully."
176
+ }
177
+ ]
178
+ }
179
+
180
+ + Response 400
181
+ + Response 401
182
+ + Response 404
183
+ + Response 409
184
+ + Response 500
185
+
186
+ # Components [/updatableComponents?action=getComponents]
187
+
188
+ ## Retrieve [GET]
189
+ + Response 200
190
+ {
191
+ "DeviceList": [
192
+ {
193
+ "CMMList": [
194
+ {
195
+ "UpdateStatus": {
196
+ "JobID": 1,
197
+ "PercentComplete": 1,
198
+ "Phase": "Applying",
199
+ "StartTime": "2015-04-13 12:50:31.077",
200
+ "State": "InProgress",
201
+ "Status": "Active",
202
+ "TaskID": 1
203
+ },
204
+ "UUID": "6134AFCEA91311E199A5A45AC8953137"
205
+ }
206
+ ]
207
+ },
208
+ {
209
+ "ServerList": [
210
+ {
211
+ "UUID": "8BFBADCC33CB11E499F740F2E9903640",
212
+ "Components": [
213
+ {
214
+ "Component": "System Prerequisites",
215
+ "UpdateStatus": {
216
+ "JobID": 1,
217
+ "PercentComplete": 0,
218
+ "Phase": "Queued",
219
+ "State": "Blocked",
220
+ "Status": "Queued",
221
+ "TaskID": 4
222
+ },
223
+ "Weight": 1
224
+ },
225
+ {
226
+ "Component": "ITE",
227
+ "UpdateStatus": {
228
+ "CurrentComponent": {
229
+ "Component": "Queued"
230
+ },
231
+ "PercentComplete": 0,
232
+ "State": "NotStarted",
233
+ "Status": "Active",
234
+ "TotalComplete": 0,
235
+ "TotalComponents": 32
236
+ }
237
+ }
238
+ ]
239
+ },
240
+ {
241
+ "UUID": "0CDF130FDFC211E392806CAE8B704250",
242
+ "Components": [
243
+ {
244
+ "Component": "System Prerequisites",
245
+ "UpdateStatus": {
246
+ "JobID": 1,
247
+ "PercentComplete": 0,
248
+ "Phase": "Queued",
249
+ "State": "Blocked",
250
+ "Status": "Queued",
251
+ "TaskID": 64
252
+ },
253
+ "Weight": 1
254
+
255
+ },
256
+ {
257
+ "Component": "ITE",
258
+ "UpdateStatus": {
259
+ "CurrentComponent": {
260
+ "Component": "Queued"
261
+ },
262
+ "PercentComplete": 0,
263
+ "State": "NotStarted",
264
+ "Status": "Active",
265
+ "TotalComplete": 0,
266
+ "TotalComponents": 30
267
+ }
268
+ }
269
+ ]
270
+ }
271
+ ]
272
+ },
273
+ {
274
+ "SwitchList": [
275
+ {
276
+ "ReadinessCheck": {
277
+ "ElapsedTime": "00:00:00:01.509",
278
+ "ElapsedTimeFormatted": "1 second 509 milliseconds",
279
+ "EndTime": "2016-04-07 23:44:10.366",
280
+ "JobID": 1,
281
+ "PercentComplete": 100,
282
+ "Phase": "Complete",
283
+ "StartTime": "2016-04-07 23:44:08.857",
284
+ "State": "Complete",
285
+ "Status": "Failed",
286
+ "TaskID": 1,
287
+ "Message": {
288
+ "result": "informational",
289
+ "messages": [
290
+ {
291
+ "id": "FQXHMUP1000I",
292
+ "text": "The command completed successfully."
293
+ },
294
+ {
295
+ "id": "FQXHMUP4545L",
296
+ "text": "The device is not ready for an update.",
297
+ "explanation": "The device did not pass validation for firmware updates..",
298
+ "recovery": {
299
+ "text": "Correct the issues discovered by validation checks."
300
+ }
301
+ }
302
+ ]
303
+ }
304
+ },
305
+ "UpdateStatus": {
306
+ "EndTime": "2016-04-07 23:44:10.869",
307
+ "JobID": 1,
308
+ "PercentComplete": 100,
309
+ "Phase": "Complete",
310
+ "State": "Complete",
311
+ "Status": "Canceled",
312
+ "TaskID": 3,
313
+ "Message": {
314
+ "result": "warning",
315
+ "messages": [
316
+ {
317
+ "id": "FQXHMUP4086F",
318
+ "text": "The RackSwitch G7052 xHMCUpdates task was canceled.",
319
+ "explanation": "The task was canceled",
320
+ "recovery": {
321
+ "text": "Try to perform the update again"
322
+ }
323
+ }
324
+ ]
325
+ }
326
+ },
327
+ "UUID": "0b0f5101bb8844b8b2d1c1aaeb24f446"
328
+ }
329
+ ]
330
+ }
331
+ ],
332
+ "UpdateStatusMetrics": {
333
+ "TotaldeviceUpdates": 6,
334
+ "TotaldeviceUpdatesActive": 6,
335
+ "TotaldeviceUpdatesComplete": 0,
336
+ "TotaldeviceUpdatesInProgress": 1,
337
+ "TotalJobs": 1,
338
+ "TotalJobsComplete": 0,
339
+ "TotalJobsInProgress": 1,
340
+ "TotalJobsPercentComplete": 0,
341
+ "TotalSupportTasks": 18,
342
+ "TotalSupportTasksActive": 18,
343
+ "TotalTasks": 93,
344
+ "TotalTasksBlocked": 92,
345
+ "TotalTasksCanceled": 0,
346
+ "TotalTasksComplete": 0,
347
+ "TotalTasksFailed": 0,
348
+ "TotalTasksInProgress": 1,
349
+ "TotalTasksSuccess": 0,
350
+ "TotalUpdateTasks": 75,
351
+ "TotalUpdateTasksActive": 72
352
+ },
353
+ "result": "informational",
354
+ "messages": [
355
+ {
356
+ "id": "FQXHMUP4091I",
357
+ "text": "Update Status was obtained successfully."
358
+ }
359
+ ]
360
+ }
361
+ + Response 400
362
+ + Response 401
363
+ + Response 404
364
+ + Response 409
365
+ + Response 500
366
+
367
+ # Components [/updatableComponents{?action,activationMode,onErrorMode,forceUpdateMode}]
368
+
369
+ + Parameters
370
+ + action - The action to take. This can be one of the following values - apply, cancelApply, powerState
371
+ + activationMode - Indicates when to activate the update. This can be one of the following values - immediate, delayed
372
+ + forceUpdateMode - Indicates whether to apply the update if firmware is already compliant. This can be one of the following values - true, false
373
+ + onErrorMode - Indicates how to handle errors during the firmware update. This can be one of the following values - stopOnError, stopdeviceOnError, continueOnError
374
+
375
+ ## Apply [PUT]
376
+ + Request (application/json)
377
+ {
378
+ "DeviceList": [
379
+ {
380
+ "ServerList":[{"UUID": "8BFBADCC33CB11E499F740F2E9903640","Components": [{"Fixid": "lnvgy_fw_storage_1.1.1","Component": "Controller a"}]}]
381
+ },
382
+ {
383
+ "SwitchList":[{"UUID": "8BFBADCC33CB11E499F740F2E9903640","Components": [{"Fixid": "lnvgy_fw_scsw_en4093r-8.3.9.0_anyons_noarch","Component": "Main application"}]}]
384
+ },
385
+ {
386
+ "StorageList":[{"UUID": "8BFBADCC33CB11E499F740F2E9903640","Components": [{"Fixid": "lnvgy_fw_storage_1.1.1","Component": "Controller a"}]}]
387
+ },
388
+ {
389
+ "CMMList":[{"UUID": "8BFBADCC33CB11E499F740F2E9903640","Components": [{"Fixid": "lnvgy_fw_storage_1.1.1","Component": "Controller a"}]
390
+ }
391
+ ]
392
+ }
393
+
394
+ + Response 200
395
+
396
+ + Response 400
397
+ + Response 401
398
+ + Response 404
399
+ + Response 409
400
+ + Response 500
401
+
402
+ + Request (application/json)
403
+ {
404
+ "DeviceList": [
405
+ {
406
+ "ServerList":[{"PowerState": "reset","UUID": "8BFBADCC33CB11E499F740F2E9972457"}]
407
+ },
408
+ {
409
+ "SwitchList":[{"PowerState": "powerOn","UUID": "8BFBADCC33CB11E499F740F2E9972458"}]
410
+ },
411
+ {
412
+ "StorageList":[{"PowerState": "powerCycleSoft","UUID": "8BFBADCC33CB11E499F740F2E9972457"}]
413
+ },
414
+ {
415
+ "CMMList":[{"PowerState": "reset","UUID": "8BFBADCC33CB11E499F740F2E213123"}]
416
+ }
417
+ ]
418
+ }
419
+
420
+ + Response 200
421
+
422
+ + Response 400
423
+ + Response 401
424
+ + Response 404
425
+ + Response 409
426
+ + Response 500