@openshift-migration-advisor/agent-sdk 0.12.0-d4bdc4301890 → 0.12.0-e6e9d25bdc36
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +30 -0
- package/README.md +29 -2
- package/dist/apis/DefaultApi.d.ts +442 -0
- package/dist/apis/DefaultApi.js +484 -0
- package/dist/esm/apis/DefaultApi.d.ts +442 -0
- package/dist/esm/apis/DefaultApi.js +484 -0
- package/dist/esm/models/BenchmarkRun.d.ts +104 -0
- package/dist/esm/models/BenchmarkRun.js +85 -0
- package/dist/esm/models/DatastoreDetail.d.ts +90 -0
- package/dist/esm/models/DatastoreDetail.js +74 -0
- package/dist/esm/models/DatastorePair.d.ts +50 -0
- package/dist/esm/models/DatastorePair.js +53 -0
- package/dist/esm/models/EstimateRange.d.ts +44 -0
- package/dist/esm/models/EstimateRange.js +45 -0
- package/dist/esm/models/ForecastStats.d.ts +87 -0
- package/dist/esm/models/ForecastStats.js +64 -0
- package/dist/esm/models/ForecasterDatastoresRequest.d.ts +33 -0
- package/dist/esm/models/ForecasterDatastoresRequest.js +42 -0
- package/dist/esm/models/ForecasterPairStatus.d.ts +98 -0
- package/dist/esm/models/ForecasterPairStatus.js +82 -0
- package/dist/esm/models/ForecasterStartRequest.d.ts +58 -0
- package/dist/esm/models/ForecasterStartRequest.js +53 -0
- package/dist/esm/models/ForecasterStatus.d.ts +47 -0
- package/dist/esm/models/ForecasterStatus.js +53 -0
- package/dist/esm/models/PairCapability.d.ts +60 -0
- package/dist/esm/models/PairCapability.js +64 -0
- package/dist/esm/models/PairCapabilityRequest.d.ts +40 -0
- package/dist/esm/models/PairCapabilityRequest.js +47 -0
- package/dist/esm/models/PutForecasterCredentials403Response.d.ts +38 -0
- package/dist/esm/models/PutForecasterCredentials403Response.js +43 -0
- package/dist/esm/models/RightsizingClusterListResponse.d.ts +39 -0
- package/dist/esm/models/RightsizingClusterListResponse.js +48 -0
- package/dist/esm/models/RightsizingClusterUtilization.d.ts +106 -0
- package/dist/esm/models/RightsizingClusterUtilization.js +91 -0
- package/dist/esm/models/StopForecasterPair202Response.d.ts +45 -0
- package/dist/esm/models/StopForecasterPair202Response.js +49 -0
- package/dist/esm/models/VmUtilizationDetails.d.ts +18 -0
- package/dist/esm/models/VmUtilizationDetails.js +12 -0
- package/dist/esm/models/index.d.ts +15 -0
- package/dist/esm/models/index.js +15 -0
- package/dist/models/BenchmarkRun.d.ts +104 -0
- package/dist/models/BenchmarkRun.js +92 -0
- package/dist/models/DatastoreDetail.d.ts +90 -0
- package/dist/models/DatastoreDetail.js +82 -0
- package/dist/models/DatastorePair.d.ts +50 -0
- package/dist/models/DatastorePair.js +60 -0
- package/dist/models/EstimateRange.d.ts +44 -0
- package/dist/models/EstimateRange.js +52 -0
- package/dist/models/ForecastStats.d.ts +87 -0
- package/dist/models/ForecastStats.js +71 -0
- package/dist/models/ForecasterDatastoresRequest.d.ts +33 -0
- package/dist/models/ForecasterDatastoresRequest.js +49 -0
- package/dist/models/ForecasterPairStatus.d.ts +98 -0
- package/dist/models/ForecasterPairStatus.js +90 -0
- package/dist/models/ForecasterStartRequest.d.ts +58 -0
- package/dist/models/ForecasterStartRequest.js +60 -0
- package/dist/models/ForecasterStatus.d.ts +47 -0
- package/dist/models/ForecasterStatus.js +61 -0
- package/dist/models/PairCapability.d.ts +60 -0
- package/dist/models/PairCapability.js +72 -0
- package/dist/models/PairCapabilityRequest.d.ts +40 -0
- package/dist/models/PairCapabilityRequest.js +54 -0
- package/dist/models/PutForecasterCredentials403Response.d.ts +38 -0
- package/dist/models/PutForecasterCredentials403Response.js +50 -0
- package/dist/models/RightsizingClusterListResponse.d.ts +39 -0
- package/dist/models/RightsizingClusterListResponse.js +55 -0
- package/dist/models/RightsizingClusterUtilization.d.ts +106 -0
- package/dist/models/RightsizingClusterUtilization.js +98 -0
- package/dist/models/StopForecasterPair202Response.d.ts +45 -0
- package/dist/models/StopForecasterPair202Response.js +57 -0
- package/dist/models/VmUtilizationDetails.d.ts +18 -0
- package/dist/models/VmUtilizationDetails.js +12 -0
- package/dist/models/index.d.ts +15 -0
- package/dist/models/index.js +15 -0
- package/docs/BenchmarkRun.md +58 -0
- package/docs/DatastoreDetail.md +50 -0
- package/docs/DatastorePair.md +40 -0
- package/docs/DefaultApi.md +875 -66
- package/docs/EstimateRange.md +39 -0
- package/docs/ForecastStats.md +52 -0
- package/docs/ForecasterDatastoresRequest.md +34 -0
- package/docs/ForecasterPairStatus.md +52 -0
- package/docs/ForecasterStartRequest.md +42 -0
- package/docs/ForecasterStatus.md +36 -0
- package/docs/PairCapability.md +40 -0
- package/docs/PairCapabilityRequest.md +36 -0
- package/docs/PutForecasterCredentials403Response.md +36 -0
- package/docs/RightsizingClusterListResponse.md +36 -0
- package/docs/RightsizingClusterUtilization.md +58 -0
- package/docs/StopForecasterPair202Response.md +36 -0
- package/docs/VmUtilizationDetails.md +6 -0
- package/package.json +1 -1
- package/src/apis/DefaultApi.ts +919 -17
- package/src/models/BenchmarkRun.ts +171 -0
- package/src/models/DatastoreDetail.ts +146 -0
- package/src/models/DatastorePair.ts +92 -0
- package/src/models/EstimateRange.ts +81 -0
- package/src/models/ForecastStats.ts +147 -0
- package/src/models/ForecasterDatastoresRequest.ts +73 -0
- package/src/models/ForecasterPairStatus.ts +158 -0
- package/src/models/ForecasterStartRequest.ts +113 -0
- package/src/models/ForecasterStatus.ts +93 -0
- package/src/models/PairCapability.ts +106 -0
- package/src/models/PairCapabilityRequest.ts +89 -0
- package/src/models/PutForecasterCredentials403Response.ts +73 -0
- package/src/models/RightsizingClusterListResponse.ts +83 -0
- package/src/models/RightsizingClusterUtilization.ts +176 -0
- package/src/models/StopForecasterPair202Response.ts +83 -0
- package/src/models/VmUtilizationDetails.ts +27 -0
- package/src/models/index.ts +15 -0
package/docs/DefaultApi.md
CHANGED
|
@@ -5,27 +5,39 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /groups | Create a new group |
|
|
8
|
+
| [**deleteForecasterRun**](DefaultApi.md#deleteforecasterrun) | **DELETE** /forecaster/runs/{id} | Delete a benchmark run |
|
|
8
9
|
| [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /groups/{id} | Delete group |
|
|
9
10
|
| [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
|
|
10
11
|
| [**getCollectorStatus**](DefaultApi.md#getcollectorstatus) | **GET** /collector | Get collector status |
|
|
12
|
+
| [**getForecasterDatastores**](DefaultApi.md#getforecasterdatastores) | **POST** /forecaster/datastores | List available datastores |
|
|
13
|
+
| [**getForecasterRuns**](DefaultApi.md#getforecasterruns) | **GET** /forecaster/runs | List benchmark runs |
|
|
14
|
+
| [**getForecasterStats**](DefaultApi.md#getforecasterstats) | **GET** /forecaster/stats | Get throughput statistics |
|
|
15
|
+
| [**getForecasterStatus**](DefaultApi.md#getforecasterstatus) | **GET** /forecaster | Poll forecaster status |
|
|
11
16
|
| [**getGroup**](DefaultApi.md#getgroup) | **GET** /groups/{id} | Get group by ID with its VMs |
|
|
12
17
|
| [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /inspector | Get inspector status |
|
|
13
18
|
| [**getInspectorVddkStatus**](DefaultApi.md#getinspectorvddkstatus) | **GET** /inspector/vddk | Get VDDK status |
|
|
14
19
|
| [**getInventory**](DefaultApi.md#getinventory) | **GET** /inventory | Get collected inventory |
|
|
20
|
+
| [**getLatestRightsizingClusters**](DefaultApi.md#getlatestrightsizingclusters) | **GET** /cluster_rightsizing | Get cluster-level utilization aggregates for the latest completed report |
|
|
15
21
|
| [**getRightsizingReport**](DefaultApi.md#getrightsizingreport) | **GET** /rightsizing/{id} | Get a specific rightsizing report with full VM metrics |
|
|
22
|
+
| [**getRightsizingReportClusters**](DefaultApi.md#getrightsizingreportclusters) | **GET** /cluster_rightsizing/{report_id} | Get cluster-level utilization aggregates for a specific report |
|
|
16
23
|
| [**getVM**](DefaultApi.md#getvm) | **GET** /vms/{id} | Get details about a vm |
|
|
17
24
|
| [**getVMUtilization**](DefaultApi.md#getvmutilization) | **GET** /vms/{id}/utilization | Get utilization breakdown for a specific VM |
|
|
18
25
|
| [**getVMs**](DefaultApi.md#getvms) | **GET** /vms | Get list of VMs with filtering and pagination |
|
|
19
26
|
| [**getVersion**](DefaultApi.md#getversion) | **GET** /version | Get agent version information |
|
|
20
27
|
| [**listGroups**](DefaultApi.md#listgroups) | **GET** /groups | List all groups |
|
|
21
28
|
| [**listRightsizingReports**](DefaultApi.md#listrightsizingreports) | **GET** /rightsizing | List all rightsizing reports |
|
|
29
|
+
| [**postForecasterPairCapabilities**](DefaultApi.md#postforecasterpaircapabilities) | **POST** /forecaster/capabilities | Compute pair capabilities |
|
|
30
|
+
| [**putForecasterCredentials**](DefaultApi.md#putforecastercredentials) | **PUT** /forecaster/credentials | Verify vCenter credentials and permissions |
|
|
22
31
|
| [**putInspectorCredentials**](DefaultApi.md#putinspectorcredentials) | **PUT** /inspector/credentials | Set or replace inspector credentials |
|
|
23
32
|
| [**putInspectorVddk**](DefaultApi.md#putinspectorvddk) | **PUT** /inspector/vddk | Upload VDDK tarball |
|
|
24
33
|
| [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspection | Remove VirtualMachine from inspection queue |
|
|
25
34
|
| [**setAgentMode**](DefaultApi.md#setagentmode) | **POST** /agent | Change agent mode |
|
|
26
35
|
| [**startCollector**](DefaultApi.md#startcollector) | **POST** /collector | Start inventory collection |
|
|
36
|
+
| [**startForecaster**](DefaultApi.md#startforecaster) | **POST** /forecaster | Start benchmark |
|
|
27
37
|
| [**startInspection**](DefaultApi.md#startinspectionoperation) | **POST** /inspector | Start inspection for VMs |
|
|
28
38
|
| [**stopCollector**](DefaultApi.md#stopcollector) | **DELETE** /collector | Stop collection |
|
|
39
|
+
| [**stopForecaster**](DefaultApi.md#stopforecaster) | **DELETE** /forecaster | Cancel benchmark |
|
|
40
|
+
| [**stopForecasterPair**](DefaultApi.md#stopforecasterpair) | **DELETE** /forecaster/pairs/{name} | Cancel a single pair |
|
|
29
41
|
| [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /inspector | Stop inspector entirely |
|
|
30
42
|
| [**triggerRightsizingCollection**](DefaultApi.md#triggerrightsizingcollection) | **POST** /rightsizing | Trigger rightsizing metrics collection |
|
|
31
43
|
| [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /groups/{id} | Update group |
|
|
@@ -99,6 +111,74 @@ No authorization required
|
|
|
99
111
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
100
112
|
|
|
101
113
|
|
|
114
|
+
## deleteForecasterRun
|
|
115
|
+
|
|
116
|
+
> deleteForecasterRun(id)
|
|
117
|
+
|
|
118
|
+
Delete a benchmark run
|
|
119
|
+
|
|
120
|
+
### Example
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import {
|
|
124
|
+
Configuration,
|
|
125
|
+
DefaultApi,
|
|
126
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
127
|
+
import type { DeleteForecasterRunRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
128
|
+
|
|
129
|
+
async function example() {
|
|
130
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
131
|
+
const api = new DefaultApi();
|
|
132
|
+
|
|
133
|
+
const body = {
|
|
134
|
+
// number | Run ID
|
|
135
|
+
id: 789,
|
|
136
|
+
} satisfies DeleteForecasterRunRequest;
|
|
137
|
+
|
|
138
|
+
try {
|
|
139
|
+
const data = await api.deleteForecasterRun(body);
|
|
140
|
+
console.log(data);
|
|
141
|
+
} catch (error) {
|
|
142
|
+
console.error(error);
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
// Run the test
|
|
147
|
+
example().catch(console.error);
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Parameters
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
| Name | Type | Description | Notes |
|
|
154
|
+
|------------- | ------------- | ------------- | -------------|
|
|
155
|
+
| **id** | `number` | Run ID | [Defaults to `undefined`] |
|
|
156
|
+
|
|
157
|
+
### Return type
|
|
158
|
+
|
|
159
|
+
`void` (Empty response body)
|
|
160
|
+
|
|
161
|
+
### Authorization
|
|
162
|
+
|
|
163
|
+
No authorization required
|
|
164
|
+
|
|
165
|
+
### HTTP request headers
|
|
166
|
+
|
|
167
|
+
- **Content-Type**: Not defined
|
|
168
|
+
- **Accept**: Not defined
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
### HTTP response details
|
|
172
|
+
| Status code | Description | Response headers |
|
|
173
|
+
|-------------|-------------|------------------|
|
|
174
|
+
| **204** | Run deleted | - |
|
|
175
|
+
| **400** | Invalid run ID | - |
|
|
176
|
+
| **404** | Run not found | - |
|
|
177
|
+
| **500** | Internal server error | - |
|
|
178
|
+
|
|
179
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
180
|
+
|
|
181
|
+
|
|
102
182
|
## deleteGroup
|
|
103
183
|
|
|
104
184
|
> deleteGroup(id)
|
|
@@ -185,7 +265,266 @@ async function example() {
|
|
|
185
265
|
const api = new DefaultApi();
|
|
186
266
|
|
|
187
267
|
try {
|
|
188
|
-
const data = await api.getAgentStatus();
|
|
268
|
+
const data = await api.getAgentStatus();
|
|
269
|
+
console.log(data);
|
|
270
|
+
} catch (error) {
|
|
271
|
+
console.error(error);
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
// Run the test
|
|
276
|
+
example().catch(console.error);
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
### Parameters
|
|
280
|
+
|
|
281
|
+
This endpoint does not need any parameter.
|
|
282
|
+
|
|
283
|
+
### Return type
|
|
284
|
+
|
|
285
|
+
[**AgentStatus**](AgentStatus.md)
|
|
286
|
+
|
|
287
|
+
### Authorization
|
|
288
|
+
|
|
289
|
+
No authorization required
|
|
290
|
+
|
|
291
|
+
### HTTP request headers
|
|
292
|
+
|
|
293
|
+
- **Content-Type**: Not defined
|
|
294
|
+
- **Accept**: `application/json`
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
### HTTP response details
|
|
298
|
+
| Status code | Description | Response headers |
|
|
299
|
+
|-------------|-------------|------------------|
|
|
300
|
+
| **200** | Agent status | - |
|
|
301
|
+
| **500** | Internal server error | - |
|
|
302
|
+
|
|
303
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
## getCollectorStatus
|
|
307
|
+
|
|
308
|
+
> CollectorStatus getCollectorStatus()
|
|
309
|
+
|
|
310
|
+
Get collector status
|
|
311
|
+
|
|
312
|
+
### Example
|
|
313
|
+
|
|
314
|
+
```ts
|
|
315
|
+
import {
|
|
316
|
+
Configuration,
|
|
317
|
+
DefaultApi,
|
|
318
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
319
|
+
import type { GetCollectorStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
320
|
+
|
|
321
|
+
async function example() {
|
|
322
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
323
|
+
const api = new DefaultApi();
|
|
324
|
+
|
|
325
|
+
try {
|
|
326
|
+
const data = await api.getCollectorStatus();
|
|
327
|
+
console.log(data);
|
|
328
|
+
} catch (error) {
|
|
329
|
+
console.error(error);
|
|
330
|
+
}
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
// Run the test
|
|
334
|
+
example().catch(console.error);
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
### Parameters
|
|
338
|
+
|
|
339
|
+
This endpoint does not need any parameter.
|
|
340
|
+
|
|
341
|
+
### Return type
|
|
342
|
+
|
|
343
|
+
[**CollectorStatus**](CollectorStatus.md)
|
|
344
|
+
|
|
345
|
+
### Authorization
|
|
346
|
+
|
|
347
|
+
No authorization required
|
|
348
|
+
|
|
349
|
+
### HTTP request headers
|
|
350
|
+
|
|
351
|
+
- **Content-Type**: Not defined
|
|
352
|
+
- **Accept**: `application/json`
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
### HTTP response details
|
|
356
|
+
| Status code | Description | Response headers |
|
|
357
|
+
|-------------|-------------|------------------|
|
|
358
|
+
| **200** | Collector status | - |
|
|
359
|
+
| **500** | Internal server error | - |
|
|
360
|
+
|
|
361
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
## getForecasterDatastores
|
|
365
|
+
|
|
366
|
+
> Array<DatastoreDetail> getForecasterDatastores(forecasterDatastoresRequest)
|
|
367
|
+
|
|
368
|
+
List available datastores
|
|
369
|
+
|
|
370
|
+
Returns datastores from the forklift-collected inventory with storage vendor and capability information derived from NAA device identifiers. No vSphere credentials are required.
|
|
371
|
+
|
|
372
|
+
### Example
|
|
373
|
+
|
|
374
|
+
```ts
|
|
375
|
+
import {
|
|
376
|
+
Configuration,
|
|
377
|
+
DefaultApi,
|
|
378
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
379
|
+
import type { GetForecasterDatastoresRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
380
|
+
|
|
381
|
+
async function example() {
|
|
382
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
383
|
+
const api = new DefaultApi();
|
|
384
|
+
|
|
385
|
+
const body = {
|
|
386
|
+
// ForecasterDatastoresRequest (optional)
|
|
387
|
+
forecasterDatastoresRequest: ...,
|
|
388
|
+
} satisfies GetForecasterDatastoresRequest;
|
|
389
|
+
|
|
390
|
+
try {
|
|
391
|
+
const data = await api.getForecasterDatastores(body);
|
|
392
|
+
console.log(data);
|
|
393
|
+
} catch (error) {
|
|
394
|
+
console.error(error);
|
|
395
|
+
}
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
// Run the test
|
|
399
|
+
example().catch(console.error);
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
### Parameters
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
| Name | Type | Description | Notes |
|
|
406
|
+
|------------- | ------------- | ------------- | -------------|
|
|
407
|
+
| **forecasterDatastoresRequest** | [ForecasterDatastoresRequest](ForecasterDatastoresRequest.md) | | [Optional] |
|
|
408
|
+
|
|
409
|
+
### Return type
|
|
410
|
+
|
|
411
|
+
[**Array<DatastoreDetail>**](DatastoreDetail.md)
|
|
412
|
+
|
|
413
|
+
### Authorization
|
|
414
|
+
|
|
415
|
+
No authorization required
|
|
416
|
+
|
|
417
|
+
### HTTP request headers
|
|
418
|
+
|
|
419
|
+
- **Content-Type**: `application/json`
|
|
420
|
+
- **Accept**: `application/json`
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
### HTTP response details
|
|
424
|
+
| Status code | Description | Response headers |
|
|
425
|
+
|-------------|-------------|------------------|
|
|
426
|
+
| **200** | List of datastores | - |
|
|
427
|
+
| **500** | Internal server error | - |
|
|
428
|
+
|
|
429
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
## getForecasterRuns
|
|
433
|
+
|
|
434
|
+
> Array<BenchmarkRun> getForecasterRuns(pairName)
|
|
435
|
+
|
|
436
|
+
List benchmark runs
|
|
437
|
+
|
|
438
|
+
Returns individual benchmark iterations. Optionally filtered by pair name.
|
|
439
|
+
|
|
440
|
+
### Example
|
|
441
|
+
|
|
442
|
+
```ts
|
|
443
|
+
import {
|
|
444
|
+
Configuration,
|
|
445
|
+
DefaultApi,
|
|
446
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
447
|
+
import type { GetForecasterRunsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
448
|
+
|
|
449
|
+
async function example() {
|
|
450
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
451
|
+
const api = new DefaultApi();
|
|
452
|
+
|
|
453
|
+
const body = {
|
|
454
|
+
// string | Filter runs by pair name (optional)
|
|
455
|
+
pairName: pairName_example,
|
|
456
|
+
} satisfies GetForecasterRunsRequest;
|
|
457
|
+
|
|
458
|
+
try {
|
|
459
|
+
const data = await api.getForecasterRuns(body);
|
|
460
|
+
console.log(data);
|
|
461
|
+
} catch (error) {
|
|
462
|
+
console.error(error);
|
|
463
|
+
}
|
|
464
|
+
}
|
|
465
|
+
|
|
466
|
+
// Run the test
|
|
467
|
+
example().catch(console.error);
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
### Parameters
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
| Name | Type | Description | Notes |
|
|
474
|
+
|------------- | ------------- | ------------- | -------------|
|
|
475
|
+
| **pairName** | `string` | Filter runs by pair name | [Optional] [Defaults to `undefined`] |
|
|
476
|
+
|
|
477
|
+
### Return type
|
|
478
|
+
|
|
479
|
+
[**Array<BenchmarkRun>**](BenchmarkRun.md)
|
|
480
|
+
|
|
481
|
+
### Authorization
|
|
482
|
+
|
|
483
|
+
No authorization required
|
|
484
|
+
|
|
485
|
+
### HTTP request headers
|
|
486
|
+
|
|
487
|
+
- **Content-Type**: Not defined
|
|
488
|
+
- **Accept**: `application/json`
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
### HTTP response details
|
|
492
|
+
| Status code | Description | Response headers |
|
|
493
|
+
|-------------|-------------|------------------|
|
|
494
|
+
| **200** | List of benchmark runs | - |
|
|
495
|
+
| **500** | Internal server error | - |
|
|
496
|
+
|
|
497
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
## getForecasterStats
|
|
501
|
+
|
|
502
|
+
> ForecastStats getForecasterStats(pairName)
|
|
503
|
+
|
|
504
|
+
Get throughput statistics
|
|
505
|
+
|
|
506
|
+
Returns computed statistics for a datastore pair\'s benchmark results. Primary endpoint for the UI to display migration time estimates.
|
|
507
|
+
|
|
508
|
+
### Example
|
|
509
|
+
|
|
510
|
+
```ts
|
|
511
|
+
import {
|
|
512
|
+
Configuration,
|
|
513
|
+
DefaultApi,
|
|
514
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
515
|
+
import type { GetForecasterStatsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
516
|
+
|
|
517
|
+
async function example() {
|
|
518
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
519
|
+
const api = new DefaultApi();
|
|
520
|
+
|
|
521
|
+
const body = {
|
|
522
|
+
// string | Pair name to get statistics for
|
|
523
|
+
pairName: pairName_example,
|
|
524
|
+
} satisfies GetForecasterStatsRequest;
|
|
525
|
+
|
|
526
|
+
try {
|
|
527
|
+
const data = await api.getForecasterStats(body);
|
|
189
528
|
console.log(data);
|
|
190
529
|
} catch (error) {
|
|
191
530
|
console.error(error);
|
|
@@ -198,11 +537,14 @@ example().catch(console.error);
|
|
|
198
537
|
|
|
199
538
|
### Parameters
|
|
200
539
|
|
|
201
|
-
|
|
540
|
+
|
|
541
|
+
| Name | Type | Description | Notes |
|
|
542
|
+
|------------- | ------------- | ------------- | -------------|
|
|
543
|
+
| **pairName** | `string` | Pair name to get statistics for | [Defaults to `undefined`] |
|
|
202
544
|
|
|
203
545
|
### Return type
|
|
204
546
|
|
|
205
|
-
[**
|
|
547
|
+
[**ForecastStats**](ForecastStats.md)
|
|
206
548
|
|
|
207
549
|
### Authorization
|
|
208
550
|
|
|
@@ -217,17 +559,20 @@ No authorization required
|
|
|
217
559
|
### HTTP response details
|
|
218
560
|
| Status code | Description | Response headers |
|
|
219
561
|
|-------------|-------------|------------------|
|
|
220
|
-
| **200** |
|
|
562
|
+
| **200** | Throughput statistics | - |
|
|
563
|
+
| **400** | Missing pairName parameter | - |
|
|
221
564
|
| **500** | Internal server error | - |
|
|
222
565
|
|
|
223
566
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
224
567
|
|
|
225
568
|
|
|
226
|
-
##
|
|
569
|
+
## getForecasterStatus
|
|
227
570
|
|
|
228
|
-
>
|
|
571
|
+
> ForecasterStatus getForecasterStatus()
|
|
229
572
|
|
|
230
|
-
|
|
573
|
+
Poll forecaster status
|
|
574
|
+
|
|
575
|
+
Returns current service state with per-pair progress details.
|
|
231
576
|
|
|
232
577
|
### Example
|
|
233
578
|
|
|
@@ -236,14 +581,14 @@ import {
|
|
|
236
581
|
Configuration,
|
|
237
582
|
DefaultApi,
|
|
238
583
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
239
|
-
import type {
|
|
584
|
+
import type { GetForecasterStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
240
585
|
|
|
241
586
|
async function example() {
|
|
242
587
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
243
588
|
const api = new DefaultApi();
|
|
244
589
|
|
|
245
590
|
try {
|
|
246
|
-
const data = await api.
|
|
591
|
+
const data = await api.getForecasterStatus();
|
|
247
592
|
console.log(data);
|
|
248
593
|
} catch (error) {
|
|
249
594
|
console.error(error);
|
|
@@ -260,7 +605,7 @@ This endpoint does not need any parameter.
|
|
|
260
605
|
|
|
261
606
|
### Return type
|
|
262
607
|
|
|
263
|
-
[**
|
|
608
|
+
[**ForecasterStatus**](ForecasterStatus.md)
|
|
264
609
|
|
|
265
610
|
### Authorization
|
|
266
611
|
|
|
@@ -275,8 +620,7 @@ No authorization required
|
|
|
275
620
|
### HTTP response details
|
|
276
621
|
| Status code | Description | Response headers |
|
|
277
622
|
|-------------|-------------|------------------|
|
|
278
|
-
| **200** |
|
|
279
|
-
| **500** | Internal server error | - |
|
|
623
|
+
| **200** | Current forecaster status | - |
|
|
280
624
|
|
|
281
625
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
282
626
|
|
|
@@ -555,6 +899,65 @@ No authorization required
|
|
|
555
899
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
556
900
|
|
|
557
901
|
|
|
902
|
+
## getLatestRightsizingClusters
|
|
903
|
+
|
|
904
|
+
> RightsizingClusterListResponse getLatestRightsizingClusters()
|
|
905
|
+
|
|
906
|
+
Get cluster-level utilization aggregates for the latest completed report
|
|
907
|
+
|
|
908
|
+
### Example
|
|
909
|
+
|
|
910
|
+
```ts
|
|
911
|
+
import {
|
|
912
|
+
Configuration,
|
|
913
|
+
DefaultApi,
|
|
914
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
915
|
+
import type { GetLatestRightsizingClustersRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
916
|
+
|
|
917
|
+
async function example() {
|
|
918
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
919
|
+
const api = new DefaultApi();
|
|
920
|
+
|
|
921
|
+
try {
|
|
922
|
+
const data = await api.getLatestRightsizingClusters();
|
|
923
|
+
console.log(data);
|
|
924
|
+
} catch (error) {
|
|
925
|
+
console.error(error);
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
// Run the test
|
|
930
|
+
example().catch(console.error);
|
|
931
|
+
```
|
|
932
|
+
|
|
933
|
+
### Parameters
|
|
934
|
+
|
|
935
|
+
This endpoint does not need any parameter.
|
|
936
|
+
|
|
937
|
+
### Return type
|
|
938
|
+
|
|
939
|
+
[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
|
|
940
|
+
|
|
941
|
+
### Authorization
|
|
942
|
+
|
|
943
|
+
No authorization required
|
|
944
|
+
|
|
945
|
+
### HTTP request headers
|
|
946
|
+
|
|
947
|
+
- **Content-Type**: Not defined
|
|
948
|
+
- **Accept**: `application/json`
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
### HTTP response details
|
|
952
|
+
| Status code | Description | Response headers |
|
|
953
|
+
|-------------|-------------|------------------|
|
|
954
|
+
| **200** | Cluster utilization aggregates | - |
|
|
955
|
+
| **404** | No completed rightsizing report found | - |
|
|
956
|
+
| **500** | Internal server error | - |
|
|
957
|
+
|
|
958
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
959
|
+
|
|
960
|
+
|
|
558
961
|
## getRightsizingReport
|
|
559
962
|
|
|
560
963
|
> RightsizingReport getRightsizingReport(id)
|
|
@@ -622,6 +1025,73 @@ No authorization required
|
|
|
622
1025
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
623
1026
|
|
|
624
1027
|
|
|
1028
|
+
## getRightsizingReportClusters
|
|
1029
|
+
|
|
1030
|
+
> RightsizingClusterListResponse getRightsizingReportClusters(reportId)
|
|
1031
|
+
|
|
1032
|
+
Get cluster-level utilization aggregates for a specific report
|
|
1033
|
+
|
|
1034
|
+
### Example
|
|
1035
|
+
|
|
1036
|
+
```ts
|
|
1037
|
+
import {
|
|
1038
|
+
Configuration,
|
|
1039
|
+
DefaultApi,
|
|
1040
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1041
|
+
import type { GetRightsizingReportClustersRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1042
|
+
|
|
1043
|
+
async function example() {
|
|
1044
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1045
|
+
const api = new DefaultApi();
|
|
1046
|
+
|
|
1047
|
+
const body = {
|
|
1048
|
+
// string | Rightsizing report UUID
|
|
1049
|
+
reportId: reportId_example,
|
|
1050
|
+
} satisfies GetRightsizingReportClustersRequest;
|
|
1051
|
+
|
|
1052
|
+
try {
|
|
1053
|
+
const data = await api.getRightsizingReportClusters(body);
|
|
1054
|
+
console.log(data);
|
|
1055
|
+
} catch (error) {
|
|
1056
|
+
console.error(error);
|
|
1057
|
+
}
|
|
1058
|
+
}
|
|
1059
|
+
|
|
1060
|
+
// Run the test
|
|
1061
|
+
example().catch(console.error);
|
|
1062
|
+
```
|
|
1063
|
+
|
|
1064
|
+
### Parameters
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
| Name | Type | Description | Notes |
|
|
1068
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1069
|
+
| **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
|
|
1070
|
+
|
|
1071
|
+
### Return type
|
|
1072
|
+
|
|
1073
|
+
[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
|
|
1074
|
+
|
|
1075
|
+
### Authorization
|
|
1076
|
+
|
|
1077
|
+
No authorization required
|
|
1078
|
+
|
|
1079
|
+
### HTTP request headers
|
|
1080
|
+
|
|
1081
|
+
- **Content-Type**: Not defined
|
|
1082
|
+
- **Accept**: `application/json`
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
### HTTP response details
|
|
1086
|
+
| Status code | Description | Response headers |
|
|
1087
|
+
|-------------|-------------|------------------|
|
|
1088
|
+
| **200** | Cluster utilization aggregates | - |
|
|
1089
|
+
| **404** | Report not found | - |
|
|
1090
|
+
| **500** | Internal server error | - |
|
|
1091
|
+
|
|
1092
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1093
|
+
|
|
1094
|
+
|
|
625
1095
|
## getVM
|
|
626
1096
|
|
|
627
1097
|
> VirtualMachineDetail getVM(id)
|
|
@@ -756,11 +1226,144 @@ No authorization required
|
|
|
756
1226
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
757
1227
|
|
|
758
1228
|
|
|
759
|
-
## getVMs
|
|
1229
|
+
## getVMs
|
|
1230
|
+
|
|
1231
|
+
> VirtualMachineListResponse getVMs(byExpression, sort, page, pageSize)
|
|
1232
|
+
|
|
1233
|
+
Get list of VMs with filtering and pagination
|
|
1234
|
+
|
|
1235
|
+
### Example
|
|
1236
|
+
|
|
1237
|
+
```ts
|
|
1238
|
+
import {
|
|
1239
|
+
Configuration,
|
|
1240
|
+
DefaultApi,
|
|
1241
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1242
|
+
import type { GetVMsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1243
|
+
|
|
1244
|
+
async function example() {
|
|
1245
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1246
|
+
const api = new DefaultApi();
|
|
1247
|
+
|
|
1248
|
+
const body = {
|
|
1249
|
+
// string | Filter by expression (matches VMs with the provided expression) (optional)
|
|
1250
|
+
byExpression: exp1,
|
|
1251
|
+
// Array<string> | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. (optional)
|
|
1252
|
+
sort: ["cluster:asc","name:desc"],
|
|
1253
|
+
// number | Page number for pagination (optional)
|
|
1254
|
+
page: 56,
|
|
1255
|
+
// number | Number of items per page (optional)
|
|
1256
|
+
pageSize: 56,
|
|
1257
|
+
} satisfies GetVMsRequest;
|
|
1258
|
+
|
|
1259
|
+
try {
|
|
1260
|
+
const data = await api.getVMs(body);
|
|
1261
|
+
console.log(data);
|
|
1262
|
+
} catch (error) {
|
|
1263
|
+
console.error(error);
|
|
1264
|
+
}
|
|
1265
|
+
}
|
|
1266
|
+
|
|
1267
|
+
// Run the test
|
|
1268
|
+
example().catch(console.error);
|
|
1269
|
+
```
|
|
1270
|
+
|
|
1271
|
+
### Parameters
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
| Name | Type | Description | Notes |
|
|
1275
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1276
|
+
| **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
|
|
1277
|
+
| **sort** | `Array<string>` | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. | [Optional] |
|
|
1278
|
+
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
1279
|
+
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
1280
|
+
|
|
1281
|
+
### Return type
|
|
1282
|
+
|
|
1283
|
+
[**VirtualMachineListResponse**](VirtualMachineListResponse.md)
|
|
1284
|
+
|
|
1285
|
+
### Authorization
|
|
1286
|
+
|
|
1287
|
+
No authorization required
|
|
1288
|
+
|
|
1289
|
+
### HTTP request headers
|
|
1290
|
+
|
|
1291
|
+
- **Content-Type**: Not defined
|
|
1292
|
+
- **Accept**: `application/json`
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
### HTTP response details
|
|
1296
|
+
| Status code | Description | Response headers |
|
|
1297
|
+
|-------------|-------------|------------------|
|
|
1298
|
+
| **200** | List of VMs | - |
|
|
1299
|
+
| **400** | Invalid request parameters | - |
|
|
1300
|
+
| **500** | Internal server error | - |
|
|
1301
|
+
|
|
1302
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
## getVersion
|
|
1306
|
+
|
|
1307
|
+
> VersionInfo getVersion()
|
|
1308
|
+
|
|
1309
|
+
Get agent version information
|
|
1310
|
+
|
|
1311
|
+
### Example
|
|
1312
|
+
|
|
1313
|
+
```ts
|
|
1314
|
+
import {
|
|
1315
|
+
Configuration,
|
|
1316
|
+
DefaultApi,
|
|
1317
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1318
|
+
import type { GetVersionRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1319
|
+
|
|
1320
|
+
async function example() {
|
|
1321
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1322
|
+
const api = new DefaultApi();
|
|
1323
|
+
|
|
1324
|
+
try {
|
|
1325
|
+
const data = await api.getVersion();
|
|
1326
|
+
console.log(data);
|
|
1327
|
+
} catch (error) {
|
|
1328
|
+
console.error(error);
|
|
1329
|
+
}
|
|
1330
|
+
}
|
|
1331
|
+
|
|
1332
|
+
// Run the test
|
|
1333
|
+
example().catch(console.error);
|
|
1334
|
+
```
|
|
1335
|
+
|
|
1336
|
+
### Parameters
|
|
1337
|
+
|
|
1338
|
+
This endpoint does not need any parameter.
|
|
1339
|
+
|
|
1340
|
+
### Return type
|
|
1341
|
+
|
|
1342
|
+
[**VersionInfo**](VersionInfo.md)
|
|
1343
|
+
|
|
1344
|
+
### Authorization
|
|
1345
|
+
|
|
1346
|
+
No authorization required
|
|
1347
|
+
|
|
1348
|
+
### HTTP request headers
|
|
1349
|
+
|
|
1350
|
+
- **Content-Type**: Not defined
|
|
1351
|
+
- **Accept**: `application/json`
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
### HTTP response details
|
|
1355
|
+
| Status code | Description | Response headers |
|
|
1356
|
+
|-------------|-------------|------------------|
|
|
1357
|
+
| **200** | Version information | - |
|
|
1358
|
+
|
|
1359
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
## listGroups
|
|
760
1363
|
|
|
761
|
-
>
|
|
1364
|
+
> GroupListResponse listGroups(byName, page, pageSize)
|
|
762
1365
|
|
|
763
|
-
|
|
1366
|
+
List all groups
|
|
764
1367
|
|
|
765
1368
|
### Example
|
|
766
1369
|
|
|
@@ -769,25 +1372,23 @@ import {
|
|
|
769
1372
|
Configuration,
|
|
770
1373
|
DefaultApi,
|
|
771
1374
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
772
|
-
import type {
|
|
1375
|
+
import type { ListGroupsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
773
1376
|
|
|
774
1377
|
async function example() {
|
|
775
1378
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
776
1379
|
const api = new DefaultApi();
|
|
777
1380
|
|
|
778
1381
|
const body = {
|
|
779
|
-
// string | Filter by
|
|
780
|
-
|
|
781
|
-
//
|
|
782
|
-
sort: ["cluster:asc","name:desc"],
|
|
783
|
-
// number | Page number for pagination (optional)
|
|
1382
|
+
// string | Filter groups by name (case-insensitive substring match) (optional)
|
|
1383
|
+
byName: byName_example,
|
|
1384
|
+
// number | Page number (1-indexed) (optional)
|
|
784
1385
|
page: 56,
|
|
785
|
-
// number | Number of
|
|
1386
|
+
// number | Number of groups per page (optional)
|
|
786
1387
|
pageSize: 56,
|
|
787
|
-
} satisfies
|
|
1388
|
+
} satisfies ListGroupsRequest;
|
|
788
1389
|
|
|
789
1390
|
try {
|
|
790
|
-
const data = await api.
|
|
1391
|
+
const data = await api.listGroups(body);
|
|
791
1392
|
console.log(data);
|
|
792
1393
|
} catch (error) {
|
|
793
1394
|
console.error(error);
|
|
@@ -803,14 +1404,13 @@ example().catch(console.error);
|
|
|
803
1404
|
|
|
804
1405
|
| Name | Type | Description | Notes |
|
|
805
1406
|
|------------- | ------------- | ------------- | -------------|
|
|
806
|
-
| **
|
|
807
|
-
| **
|
|
808
|
-
| **
|
|
809
|
-
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
1407
|
+
| **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
|
|
1408
|
+
| **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
|
|
1409
|
+
| **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
|
|
810
1410
|
|
|
811
1411
|
### Return type
|
|
812
1412
|
|
|
813
|
-
[**
|
|
1413
|
+
[**GroupListResponse**](GroupListResponse.md)
|
|
814
1414
|
|
|
815
1415
|
### Authorization
|
|
816
1416
|
|
|
@@ -825,18 +1425,18 @@ No authorization required
|
|
|
825
1425
|
### HTTP response details
|
|
826
1426
|
| Status code | Description | Response headers |
|
|
827
1427
|
|-------------|-------------|------------------|
|
|
828
|
-
| **200** | List of
|
|
829
|
-
| **400** | Invalid
|
|
1428
|
+
| **200** | List of groups | - |
|
|
1429
|
+
| **400** | Invalid filter expression | - |
|
|
830
1430
|
| **500** | Internal server error | - |
|
|
831
1431
|
|
|
832
1432
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
833
1433
|
|
|
834
1434
|
|
|
835
|
-
##
|
|
1435
|
+
## listRightsizingReports
|
|
836
1436
|
|
|
837
|
-
>
|
|
1437
|
+
> RightsizingReportListResponse listRightsizingReports()
|
|
838
1438
|
|
|
839
|
-
|
|
1439
|
+
List all rightsizing reports
|
|
840
1440
|
|
|
841
1441
|
### Example
|
|
842
1442
|
|
|
@@ -845,14 +1445,14 @@ import {
|
|
|
845
1445
|
Configuration,
|
|
846
1446
|
DefaultApi,
|
|
847
1447
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
848
|
-
import type {
|
|
1448
|
+
import type { ListRightsizingReportsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
849
1449
|
|
|
850
1450
|
async function example() {
|
|
851
1451
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
852
1452
|
const api = new DefaultApi();
|
|
853
1453
|
|
|
854
1454
|
try {
|
|
855
|
-
const data = await api.
|
|
1455
|
+
const data = await api.listRightsizingReports();
|
|
856
1456
|
console.log(data);
|
|
857
1457
|
} catch (error) {
|
|
858
1458
|
console.error(error);
|
|
@@ -869,7 +1469,7 @@ This endpoint does not need any parameter.
|
|
|
869
1469
|
|
|
870
1470
|
### Return type
|
|
871
1471
|
|
|
872
|
-
[**
|
|
1472
|
+
[**RightsizingReportListResponse**](RightsizingReportListResponse.md)
|
|
873
1473
|
|
|
874
1474
|
### Authorization
|
|
875
1475
|
|
|
@@ -884,16 +1484,19 @@ No authorization required
|
|
|
884
1484
|
### HTTP response details
|
|
885
1485
|
| Status code | Description | Response headers |
|
|
886
1486
|
|-------------|-------------|------------------|
|
|
887
|
-
| **200** |
|
|
1487
|
+
| **200** | List of rightsizing reports | - |
|
|
1488
|
+
| **500** | Internal server error | - |
|
|
888
1489
|
|
|
889
1490
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
890
1491
|
|
|
891
1492
|
|
|
892
|
-
##
|
|
1493
|
+
## postForecasterPairCapabilities
|
|
893
1494
|
|
|
894
|
-
>
|
|
1495
|
+
> Array<PairCapability> postForecasterPairCapabilities(pairCapabilityRequest)
|
|
895
1496
|
|
|
896
|
-
|
|
1497
|
+
Compute pair capabilities
|
|
1498
|
+
|
|
1499
|
+
Computes which offload methods are feasible for specific source-target datastore pairs based on vendor support and storage array topology derived from the forklift-collected inventory. No vSphere credentials are required.
|
|
897
1500
|
|
|
898
1501
|
### Example
|
|
899
1502
|
|
|
@@ -902,23 +1505,19 @@ import {
|
|
|
902
1505
|
Configuration,
|
|
903
1506
|
DefaultApi,
|
|
904
1507
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
905
|
-
import type {
|
|
1508
|
+
import type { PostForecasterPairCapabilitiesRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
906
1509
|
|
|
907
1510
|
async function example() {
|
|
908
1511
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
909
1512
|
const api = new DefaultApi();
|
|
910
1513
|
|
|
911
1514
|
const body = {
|
|
912
|
-
//
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
page: 56,
|
|
916
|
-
// number | Number of groups per page (optional)
|
|
917
|
-
pageSize: 56,
|
|
918
|
-
} satisfies ListGroupsRequest;
|
|
1515
|
+
// PairCapabilityRequest
|
|
1516
|
+
pairCapabilityRequest: ...,
|
|
1517
|
+
} satisfies PostForecasterPairCapabilitiesRequest;
|
|
919
1518
|
|
|
920
1519
|
try {
|
|
921
|
-
const data = await api.
|
|
1520
|
+
const data = await api.postForecasterPairCapabilities(body);
|
|
922
1521
|
console.log(data);
|
|
923
1522
|
} catch (error) {
|
|
924
1523
|
console.error(error);
|
|
@@ -934,13 +1533,11 @@ example().catch(console.error);
|
|
|
934
1533
|
|
|
935
1534
|
| Name | Type | Description | Notes |
|
|
936
1535
|
|------------- | ------------- | ------------- | -------------|
|
|
937
|
-
| **
|
|
938
|
-
| **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
|
|
939
|
-
| **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
|
|
1536
|
+
| **pairCapabilityRequest** | [PairCapabilityRequest](PairCapabilityRequest.md) | | |
|
|
940
1537
|
|
|
941
1538
|
### Return type
|
|
942
1539
|
|
|
943
|
-
[**
|
|
1540
|
+
[**Array<PairCapability>**](PairCapability.md)
|
|
944
1541
|
|
|
945
1542
|
### Authorization
|
|
946
1543
|
|
|
@@ -948,25 +1545,27 @@ No authorization required
|
|
|
948
1545
|
|
|
949
1546
|
### HTTP request headers
|
|
950
1547
|
|
|
951
|
-
- **Content-Type**:
|
|
1548
|
+
- **Content-Type**: `application/json`
|
|
952
1549
|
- **Accept**: `application/json`
|
|
953
1550
|
|
|
954
1551
|
|
|
955
1552
|
### HTTP response details
|
|
956
1553
|
| Status code | Description | Response headers |
|
|
957
1554
|
|-------------|-------------|------------------|
|
|
958
|
-
| **200** |
|
|
959
|
-
| **400** |
|
|
1555
|
+
| **200** | Capabilities per pair | - |
|
|
1556
|
+
| **400** | Datastore not found | - |
|
|
960
1557
|
| **500** | Internal server error | - |
|
|
961
1558
|
|
|
962
1559
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
963
1560
|
|
|
964
1561
|
|
|
965
|
-
##
|
|
1562
|
+
## putForecasterCredentials
|
|
966
1563
|
|
|
967
|
-
>
|
|
1564
|
+
> putForecasterCredentials(vcenterCredentials)
|
|
968
1565
|
|
|
969
|
-
|
|
1566
|
+
Verify vCenter credentials and permissions
|
|
1567
|
+
|
|
1568
|
+
Validates vCenter connectivity and verifies the user has the required vSphere privileges for forecaster operations (datastore file management, VM provisioning, disk cloning). Verification only — credentials are not saved.
|
|
970
1569
|
|
|
971
1570
|
### Example
|
|
972
1571
|
|
|
@@ -975,14 +1574,19 @@ import {
|
|
|
975
1574
|
Configuration,
|
|
976
1575
|
DefaultApi,
|
|
977
1576
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
978
|
-
import type {
|
|
1577
|
+
import type { PutForecasterCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
979
1578
|
|
|
980
1579
|
async function example() {
|
|
981
1580
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
982
1581
|
const api = new DefaultApi();
|
|
983
1582
|
|
|
1583
|
+
const body = {
|
|
1584
|
+
// VcenterCredentials
|
|
1585
|
+
vcenterCredentials: ...,
|
|
1586
|
+
} satisfies PutForecasterCredentialsRequest;
|
|
1587
|
+
|
|
984
1588
|
try {
|
|
985
|
-
const data = await api.
|
|
1589
|
+
const data = await api.putForecasterCredentials(body);
|
|
986
1590
|
console.log(data);
|
|
987
1591
|
} catch (error) {
|
|
988
1592
|
console.error(error);
|
|
@@ -995,11 +1599,14 @@ example().catch(console.error);
|
|
|
995
1599
|
|
|
996
1600
|
### Parameters
|
|
997
1601
|
|
|
998
|
-
|
|
1602
|
+
|
|
1603
|
+
| Name | Type | Description | Notes |
|
|
1604
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1605
|
+
| **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
|
|
999
1606
|
|
|
1000
1607
|
### Return type
|
|
1001
1608
|
|
|
1002
|
-
|
|
1609
|
+
`void` (Empty response body)
|
|
1003
1610
|
|
|
1004
1611
|
### Authorization
|
|
1005
1612
|
|
|
@@ -1007,14 +1614,16 @@ No authorization required
|
|
|
1007
1614
|
|
|
1008
1615
|
### HTTP request headers
|
|
1009
1616
|
|
|
1010
|
-
- **Content-Type**:
|
|
1617
|
+
- **Content-Type**: `application/json`
|
|
1011
1618
|
- **Accept**: `application/json`
|
|
1012
1619
|
|
|
1013
1620
|
|
|
1014
1621
|
### HTTP response details
|
|
1015
1622
|
| Status code | Description | Response headers |
|
|
1016
1623
|
|-------------|-------------|------------------|
|
|
1017
|
-
| **200** |
|
|
1624
|
+
| **200** | Credentials valid and all required privileges are granted | - |
|
|
1625
|
+
| **400** | Invalid credentials or unreachable vCenter | - |
|
|
1626
|
+
| **403** | Authentication succeeded but user lacks required privileges | - |
|
|
1018
1627
|
| **500** | Internal server error | - |
|
|
1019
1628
|
|
|
1020
1629
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -1360,6 +1969,76 @@ No authorization required
|
|
|
1360
1969
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1361
1970
|
|
|
1362
1971
|
|
|
1972
|
+
## startForecaster
|
|
1973
|
+
|
|
1974
|
+
> ForecasterStatus startForecaster(forecasterStartRequest)
|
|
1975
|
+
|
|
1976
|
+
Start benchmark
|
|
1977
|
+
|
|
1978
|
+
Starts async benchmarking for one or more datastore pairs. Credentials can be passed inline or omitted if previously provided in an earlier request.
|
|
1979
|
+
|
|
1980
|
+
### Example
|
|
1981
|
+
|
|
1982
|
+
```ts
|
|
1983
|
+
import {
|
|
1984
|
+
Configuration,
|
|
1985
|
+
DefaultApi,
|
|
1986
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1987
|
+
import type { StartForecasterRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1988
|
+
|
|
1989
|
+
async function example() {
|
|
1990
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1991
|
+
const api = new DefaultApi();
|
|
1992
|
+
|
|
1993
|
+
const body = {
|
|
1994
|
+
// ForecasterStartRequest
|
|
1995
|
+
forecasterStartRequest: ...,
|
|
1996
|
+
} satisfies StartForecasterRequest;
|
|
1997
|
+
|
|
1998
|
+
try {
|
|
1999
|
+
const data = await api.startForecaster(body);
|
|
2000
|
+
console.log(data);
|
|
2001
|
+
} catch (error) {
|
|
2002
|
+
console.error(error);
|
|
2003
|
+
}
|
|
2004
|
+
}
|
|
2005
|
+
|
|
2006
|
+
// Run the test
|
|
2007
|
+
example().catch(console.error);
|
|
2008
|
+
```
|
|
2009
|
+
|
|
2010
|
+
### Parameters
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
| Name | Type | Description | Notes |
|
|
2014
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2015
|
+
| **forecasterStartRequest** | [ForecasterStartRequest](ForecasterStartRequest.md) | | |
|
|
2016
|
+
|
|
2017
|
+
### Return type
|
|
2018
|
+
|
|
2019
|
+
[**ForecasterStatus**](ForecasterStatus.md)
|
|
2020
|
+
|
|
2021
|
+
### Authorization
|
|
2022
|
+
|
|
2023
|
+
No authorization required
|
|
2024
|
+
|
|
2025
|
+
### HTTP request headers
|
|
2026
|
+
|
|
2027
|
+
- **Content-Type**: `application/json`
|
|
2028
|
+
- **Accept**: `application/json`
|
|
2029
|
+
|
|
2030
|
+
|
|
2031
|
+
### HTTP response details
|
|
2032
|
+
| Status code | Description | Response headers |
|
|
2033
|
+
|-------------|-------------|------------------|
|
|
2034
|
+
| **202** | Benchmark started | - |
|
|
2035
|
+
| **400** | Invalid credentials, validation error, or pair limit exceeded | - |
|
|
2036
|
+
| **409** | Another benchmark is already running | - |
|
|
2037
|
+
| **500** | Internal server error | - |
|
|
2038
|
+
|
|
2039
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2040
|
+
|
|
2041
|
+
|
|
1363
2042
|
## startInspection
|
|
1364
2043
|
|
|
1365
2044
|
> InspectorStatus startInspection(startInspectionRequest)
|
|
@@ -1486,6 +2165,136 @@ No authorization required
|
|
|
1486
2165
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1487
2166
|
|
|
1488
2167
|
|
|
2168
|
+
## stopForecaster
|
|
2169
|
+
|
|
2170
|
+
> ForecasterStatus stopForecaster()
|
|
2171
|
+
|
|
2172
|
+
Cancel benchmark
|
|
2173
|
+
|
|
2174
|
+
Stops the running benchmark. Already-completed runs are preserved in the database.
|
|
2175
|
+
|
|
2176
|
+
### Example
|
|
2177
|
+
|
|
2178
|
+
```ts
|
|
2179
|
+
import {
|
|
2180
|
+
Configuration,
|
|
2181
|
+
DefaultApi,
|
|
2182
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2183
|
+
import type { StopForecasterRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2184
|
+
|
|
2185
|
+
async function example() {
|
|
2186
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2187
|
+
const api = new DefaultApi();
|
|
2188
|
+
|
|
2189
|
+
try {
|
|
2190
|
+
const data = await api.stopForecaster();
|
|
2191
|
+
console.log(data);
|
|
2192
|
+
} catch (error) {
|
|
2193
|
+
console.error(error);
|
|
2194
|
+
}
|
|
2195
|
+
}
|
|
2196
|
+
|
|
2197
|
+
// Run the test
|
|
2198
|
+
example().catch(console.error);
|
|
2199
|
+
```
|
|
2200
|
+
|
|
2201
|
+
### Parameters
|
|
2202
|
+
|
|
2203
|
+
This endpoint does not need any parameter.
|
|
2204
|
+
|
|
2205
|
+
### Return type
|
|
2206
|
+
|
|
2207
|
+
[**ForecasterStatus**](ForecasterStatus.md)
|
|
2208
|
+
|
|
2209
|
+
### Authorization
|
|
2210
|
+
|
|
2211
|
+
No authorization required
|
|
2212
|
+
|
|
2213
|
+
### HTTP request headers
|
|
2214
|
+
|
|
2215
|
+
- **Content-Type**: Not defined
|
|
2216
|
+
- **Accept**: `application/json`
|
|
2217
|
+
|
|
2218
|
+
|
|
2219
|
+
### HTTP response details
|
|
2220
|
+
| Status code | Description | Response headers |
|
|
2221
|
+
|-------------|-------------|------------------|
|
|
2222
|
+
| **202** | Benchmark canceled, service returned to ready | - |
|
|
2223
|
+
| **404** | No benchmark is running | - |
|
|
2224
|
+
| **500** | Internal server error | - |
|
|
2225
|
+
|
|
2226
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2227
|
+
|
|
2228
|
+
|
|
2229
|
+
## stopForecasterPair
|
|
2230
|
+
|
|
2231
|
+
> StopForecasterPair202Response stopForecasterPair(name)
|
|
2232
|
+
|
|
2233
|
+
Cancel a single pair
|
|
2234
|
+
|
|
2235
|
+
Cancels the benchmark for a specific pair by name. The forecaster continues running if other pairs are still active.
|
|
2236
|
+
|
|
2237
|
+
### Example
|
|
2238
|
+
|
|
2239
|
+
```ts
|
|
2240
|
+
import {
|
|
2241
|
+
Configuration,
|
|
2242
|
+
DefaultApi,
|
|
2243
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2244
|
+
import type { StopForecasterPairRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2245
|
+
|
|
2246
|
+
async function example() {
|
|
2247
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2248
|
+
const api = new DefaultApi();
|
|
2249
|
+
|
|
2250
|
+
const body = {
|
|
2251
|
+
// string | Pair name as specified in the start request
|
|
2252
|
+
name: name_example,
|
|
2253
|
+
} satisfies StopForecasterPairRequest;
|
|
2254
|
+
|
|
2255
|
+
try {
|
|
2256
|
+
const data = await api.stopForecasterPair(body);
|
|
2257
|
+
console.log(data);
|
|
2258
|
+
} catch (error) {
|
|
2259
|
+
console.error(error);
|
|
2260
|
+
}
|
|
2261
|
+
}
|
|
2262
|
+
|
|
2263
|
+
// Run the test
|
|
2264
|
+
example().catch(console.error);
|
|
2265
|
+
```
|
|
2266
|
+
|
|
2267
|
+
### Parameters
|
|
2268
|
+
|
|
2269
|
+
|
|
2270
|
+
| Name | Type | Description | Notes |
|
|
2271
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2272
|
+
| **name** | `string` | Pair name as specified in the start request | [Defaults to `undefined`] |
|
|
2273
|
+
|
|
2274
|
+
### Return type
|
|
2275
|
+
|
|
2276
|
+
[**StopForecasterPair202Response**](StopForecasterPair202Response.md)
|
|
2277
|
+
|
|
2278
|
+
### Authorization
|
|
2279
|
+
|
|
2280
|
+
No authorization required
|
|
2281
|
+
|
|
2282
|
+
### HTTP request headers
|
|
2283
|
+
|
|
2284
|
+
- **Content-Type**: Not defined
|
|
2285
|
+
- **Accept**: `application/json`
|
|
2286
|
+
|
|
2287
|
+
|
|
2288
|
+
### HTTP response details
|
|
2289
|
+
| Status code | Description | Response headers |
|
|
2290
|
+
|-------------|-------------|------------------|
|
|
2291
|
+
| **202** | Pair canceled | - |
|
|
2292
|
+
| **404** | No benchmark running, or pair not found / already finished | - |
|
|
2293
|
+
| **500** | Internal server error | - |
|
|
2294
|
+
|
|
2295
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2296
|
+
|
|
2297
|
+
|
|
1489
2298
|
## stopInspection
|
|
1490
2299
|
|
|
1491
2300
|
> InspectorStatus stopInspection()
|