@openshift-migration-advisor/agent-sdk 0.12.0-d4bdc4301890 → 0.12.0-d5edcd6935f2
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 +450 -3
- package/dist/apis/DefaultApi.js +490 -3
- package/dist/esm/apis/DefaultApi.d.ts +450 -3
- package/dist/esm/apis/DefaultApi.js +490 -3
- 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/InspectorStatus.d.ts +0 -17
- package/dist/esm/models/InspectorStatus.js +1 -10
- 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 +112 -0
- package/dist/esm/models/RightsizingClusterUtilization.js +95 -0
- package/dist/esm/models/StartInspectionRequest.d.ts +8 -1
- package/dist/esm/models/StartInspectionRequest.js +5 -0
- package/dist/esm/models/StopForecasterPair202Response.d.ts +45 -0
- package/dist/esm/models/StopForecasterPair202Response.js +49 -0
- package/dist/esm/models/VirtualMachineDetail.d.ts +7 -0
- package/dist/esm/models/VirtualMachineDetail.js +3 -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/InspectorStatus.d.ts +0 -17
- package/dist/models/InspectorStatus.js +1 -10
- 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 +112 -0
- package/dist/models/RightsizingClusterUtilization.js +102 -0
- package/dist/models/StartInspectionRequest.d.ts +8 -1
- package/dist/models/StartInspectionRequest.js +5 -0
- package/dist/models/StopForecasterPair202Response.d.ts +45 -0
- package/dist/models/StopForecasterPair202Response.js +57 -0
- package/dist/models/VirtualMachineDetail.d.ts +7 -0
- package/dist/models/VirtualMachineDetail.js +3 -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 +977 -160
- 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/InspectorStatus.md +0 -4
- 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 +60 -0
- package/docs/StartInspectionRequest.md +3 -1
- package/docs/StopForecasterPair202Response.md +36 -0
- package/docs/VirtualMachineDetail.md +2 -0
- package/docs/VmUtilizationDetails.md +6 -0
- package/package.json +1 -1
- package/src/apis/DefaultApi.ts +933 -21
- 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/InspectorStatus.ts +1 -28
- 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 +185 -0
- package/src/models/StartInspectionRequest.ts +18 -1
- package/src/models/StopForecasterPair202Response.ts +83 -0
- package/src/models/VirtualMachineDetail.ts +15 -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)
|
|
@@ -281,11 +361,13 @@ No authorization required
|
|
|
281
361
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
282
362
|
|
|
283
363
|
|
|
284
|
-
##
|
|
364
|
+
## getForecasterDatastores
|
|
285
365
|
|
|
286
|
-
>
|
|
366
|
+
> Array<DatastoreDetail> getForecasterDatastores(forecasterDatastoresRequest)
|
|
287
367
|
|
|
288
|
-
|
|
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.
|
|
289
371
|
|
|
290
372
|
### Example
|
|
291
373
|
|
|
@@ -294,25 +376,19 @@ import {
|
|
|
294
376
|
Configuration,
|
|
295
377
|
DefaultApi,
|
|
296
378
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
297
|
-
import type {
|
|
379
|
+
import type { GetForecasterDatastoresRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
298
380
|
|
|
299
381
|
async function example() {
|
|
300
382
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
301
383
|
const api = new DefaultApi();
|
|
302
384
|
|
|
303
385
|
const body = {
|
|
304
|
-
//
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
sort: ["cluster:asc","name:desc"],
|
|
308
|
-
// number | Page number for pagination (optional)
|
|
309
|
-
page: 56,
|
|
310
|
-
// number | Number of items per page (optional)
|
|
311
|
-
pageSize: 56,
|
|
312
|
-
} satisfies GetGroupRequest;
|
|
386
|
+
// ForecasterDatastoresRequest (optional)
|
|
387
|
+
forecasterDatastoresRequest: ...,
|
|
388
|
+
} satisfies GetForecasterDatastoresRequest;
|
|
313
389
|
|
|
314
390
|
try {
|
|
315
|
-
const data = await api.
|
|
391
|
+
const data = await api.getForecasterDatastores(body);
|
|
316
392
|
console.log(data);
|
|
317
393
|
} catch (error) {
|
|
318
394
|
console.error(error);
|
|
@@ -328,14 +404,11 @@ example().catch(console.error);
|
|
|
328
404
|
|
|
329
405
|
| Name | Type | Description | Notes |
|
|
330
406
|
|------------- | ------------- | ------------- | -------------|
|
|
331
|
-
| **
|
|
332
|
-
| **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] |
|
|
333
|
-
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
334
|
-
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
407
|
+
| **forecasterDatastoresRequest** | [ForecasterDatastoresRequest](ForecasterDatastoresRequest.md) | | [Optional] |
|
|
335
408
|
|
|
336
409
|
### Return type
|
|
337
410
|
|
|
338
|
-
[**
|
|
411
|
+
[**Array<DatastoreDetail>**](DatastoreDetail.md)
|
|
339
412
|
|
|
340
413
|
### Authorization
|
|
341
414
|
|
|
@@ -343,25 +416,26 @@ No authorization required
|
|
|
343
416
|
|
|
344
417
|
### HTTP request headers
|
|
345
418
|
|
|
346
|
-
- **Content-Type**:
|
|
419
|
+
- **Content-Type**: `application/json`
|
|
347
420
|
- **Accept**: `application/json`
|
|
348
421
|
|
|
349
422
|
|
|
350
423
|
### HTTP response details
|
|
351
424
|
| Status code | Description | Response headers |
|
|
352
425
|
|-------------|-------------|------------------|
|
|
353
|
-
| **200** |
|
|
354
|
-
| **404** | Group not found | - |
|
|
426
|
+
| **200** | List of datastores | - |
|
|
355
427
|
| **500** | Internal server error | - |
|
|
356
428
|
|
|
357
429
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
358
430
|
|
|
359
431
|
|
|
360
|
-
##
|
|
432
|
+
## getForecasterRuns
|
|
361
433
|
|
|
362
|
-
>
|
|
434
|
+
> Array<BenchmarkRun> getForecasterRuns(pairName)
|
|
363
435
|
|
|
364
|
-
|
|
436
|
+
List benchmark runs
|
|
437
|
+
|
|
438
|
+
Returns individual benchmark iterations. Optionally filtered by pair name.
|
|
365
439
|
|
|
366
440
|
### Example
|
|
367
441
|
|
|
@@ -370,21 +444,19 @@ import {
|
|
|
370
444
|
Configuration,
|
|
371
445
|
DefaultApi,
|
|
372
446
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
373
|
-
import type {
|
|
447
|
+
import type { GetForecasterRunsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
374
448
|
|
|
375
449
|
async function example() {
|
|
376
450
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
377
451
|
const api = new DefaultApi();
|
|
378
452
|
|
|
379
453
|
const body = {
|
|
380
|
-
//
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
includeCredentials: true,
|
|
384
|
-
} satisfies GetInspectorStatusRequest;
|
|
454
|
+
// string | Filter runs by pair name (optional)
|
|
455
|
+
pairName: pairName_example,
|
|
456
|
+
} satisfies GetForecasterRunsRequest;
|
|
385
457
|
|
|
386
458
|
try {
|
|
387
|
-
const data = await api.
|
|
459
|
+
const data = await api.getForecasterRuns(body);
|
|
388
460
|
console.log(data);
|
|
389
461
|
} catch (error) {
|
|
390
462
|
console.error(error);
|
|
@@ -400,12 +472,11 @@ example().catch(console.error);
|
|
|
400
472
|
|
|
401
473
|
| Name | Type | Description | Notes |
|
|
402
474
|
|------------- | ------------- | ------------- | -------------|
|
|
403
|
-
| **
|
|
404
|
-
| **includeCredentials** | `boolean` | If true, include configured vCenter URL and username (password is never returned). omitted if was never set. | [Optional] [Defaults to `false`] |
|
|
475
|
+
| **pairName** | `string` | Filter runs by pair name | [Optional] [Defaults to `undefined`] |
|
|
405
476
|
|
|
406
477
|
### Return type
|
|
407
478
|
|
|
408
|
-
[**
|
|
479
|
+
[**Array<BenchmarkRun>**](BenchmarkRun.md)
|
|
409
480
|
|
|
410
481
|
### Authorization
|
|
411
482
|
|
|
@@ -420,17 +491,19 @@ No authorization required
|
|
|
420
491
|
### HTTP response details
|
|
421
492
|
| Status code | Description | Response headers |
|
|
422
493
|
|-------------|-------------|------------------|
|
|
423
|
-
| **200** |
|
|
494
|
+
| **200** | List of benchmark runs | - |
|
|
424
495
|
| **500** | Internal server error | - |
|
|
425
496
|
|
|
426
497
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
427
498
|
|
|
428
499
|
|
|
429
|
-
##
|
|
500
|
+
## getForecasterStats
|
|
430
501
|
|
|
431
|
-
>
|
|
502
|
+
> ForecastStats getForecasterStats(pairName)
|
|
432
503
|
|
|
433
|
-
Get
|
|
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.
|
|
434
507
|
|
|
435
508
|
### Example
|
|
436
509
|
|
|
@@ -439,14 +512,19 @@ import {
|
|
|
439
512
|
Configuration,
|
|
440
513
|
DefaultApi,
|
|
441
514
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
442
|
-
import type {
|
|
515
|
+
import type { GetForecasterStatsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
443
516
|
|
|
444
517
|
async function example() {
|
|
445
518
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
446
519
|
const api = new DefaultApi();
|
|
447
520
|
|
|
521
|
+
const body = {
|
|
522
|
+
// string | Pair name to get statistics for
|
|
523
|
+
pairName: pairName_example,
|
|
524
|
+
} satisfies GetForecasterStatsRequest;
|
|
525
|
+
|
|
448
526
|
try {
|
|
449
|
-
const data = await api.
|
|
527
|
+
const data = await api.getForecasterStats(body);
|
|
450
528
|
console.log(data);
|
|
451
529
|
} catch (error) {
|
|
452
530
|
console.error(error);
|
|
@@ -459,11 +537,14 @@ example().catch(console.error);
|
|
|
459
537
|
|
|
460
538
|
### Parameters
|
|
461
539
|
|
|
462
|
-
|
|
540
|
+
|
|
541
|
+
| Name | Type | Description | Notes |
|
|
542
|
+
|------------- | ------------- | ------------- | -------------|
|
|
543
|
+
| **pairName** | `string` | Pair name to get statistics for | [Defaults to `undefined`] |
|
|
463
544
|
|
|
464
545
|
### Return type
|
|
465
546
|
|
|
466
|
-
[**
|
|
547
|
+
[**ForecastStats**](ForecastStats.md)
|
|
467
548
|
|
|
468
549
|
### Authorization
|
|
469
550
|
|
|
@@ -478,18 +559,20 @@ No authorization required
|
|
|
478
559
|
### HTTP response details
|
|
479
560
|
| Status code | Description | Response headers |
|
|
480
561
|
|-------------|-------------|------------------|
|
|
481
|
-
| **200** |
|
|
482
|
-
| **
|
|
562
|
+
| **200** | Throughput statistics | - |
|
|
563
|
+
| **400** | Missing pairName parameter | - |
|
|
483
564
|
| **500** | Internal server error | - |
|
|
484
565
|
|
|
485
566
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
486
567
|
|
|
487
568
|
|
|
488
|
-
##
|
|
569
|
+
## getForecasterStatus
|
|
489
570
|
|
|
490
|
-
>
|
|
571
|
+
> ForecasterStatus getForecasterStatus()
|
|
491
572
|
|
|
492
|
-
|
|
573
|
+
Poll forecaster status
|
|
574
|
+
|
|
575
|
+
Returns current service state with per-pair progress details.
|
|
493
576
|
|
|
494
577
|
### Example
|
|
495
578
|
|
|
@@ -498,21 +581,14 @@ import {
|
|
|
498
581
|
Configuration,
|
|
499
582
|
DefaultApi,
|
|
500
583
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
501
|
-
import type {
|
|
584
|
+
import type { GetForecasterStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
502
585
|
|
|
503
586
|
async function example() {
|
|
504
587
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
505
588
|
const api = new DefaultApi();
|
|
506
589
|
|
|
507
|
-
const body = {
|
|
508
|
-
// boolean | If true, include the agentId in the response (Compatible with manual inventory upload). (optional)
|
|
509
|
-
withAgentId: true,
|
|
510
|
-
// string | Filter inventory to VMs matching this group\'s filter expression (optional)
|
|
511
|
-
groupId: groupId_example,
|
|
512
|
-
} satisfies GetInventoryRequest;
|
|
513
|
-
|
|
514
590
|
try {
|
|
515
|
-
const data = await api.
|
|
591
|
+
const data = await api.getForecasterStatus();
|
|
516
592
|
console.log(data);
|
|
517
593
|
} catch (error) {
|
|
518
594
|
console.error(error);
|
|
@@ -525,15 +601,11 @@ example().catch(console.error);
|
|
|
525
601
|
|
|
526
602
|
### Parameters
|
|
527
603
|
|
|
528
|
-
|
|
529
|
-
| Name | Type | Description | Notes |
|
|
530
|
-
|------------- | ------------- | ------------- | -------------|
|
|
531
|
-
| **withAgentId** | `boolean` | If true, include the agentId in the response (Compatible with manual inventory upload). | [Optional] [Defaults to `false`] |
|
|
532
|
-
| **groupId** | `string` | Filter inventory to VMs matching this group\'s filter expression | [Optional] [Defaults to `undefined`] |
|
|
604
|
+
This endpoint does not need any parameter.
|
|
533
605
|
|
|
534
606
|
### Return type
|
|
535
607
|
|
|
536
|
-
[**
|
|
608
|
+
[**ForecasterStatus**](ForecasterStatus.md)
|
|
537
609
|
|
|
538
610
|
### Authorization
|
|
539
611
|
|
|
@@ -548,18 +620,16 @@ No authorization required
|
|
|
548
620
|
### HTTP response details
|
|
549
621
|
| Status code | Description | Response headers |
|
|
550
622
|
|-------------|-------------|------------------|
|
|
551
|
-
| **200** |
|
|
552
|
-
| **404** | Inventory not available | - |
|
|
553
|
-
| **500** | Internal server error | - |
|
|
623
|
+
| **200** | Current forecaster status | - |
|
|
554
624
|
|
|
555
625
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
556
626
|
|
|
557
627
|
|
|
558
|
-
##
|
|
628
|
+
## getGroup
|
|
559
629
|
|
|
560
|
-
>
|
|
630
|
+
> GroupResponse getGroup(id, sort, page, pageSize)
|
|
561
631
|
|
|
562
|
-
Get
|
|
632
|
+
Get group by ID with its VMs
|
|
563
633
|
|
|
564
634
|
### Example
|
|
565
635
|
|
|
@@ -568,19 +638,25 @@ import {
|
|
|
568
638
|
Configuration,
|
|
569
639
|
DefaultApi,
|
|
570
640
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
571
|
-
import type {
|
|
641
|
+
import type { GetGroupRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
572
642
|
|
|
573
643
|
async function example() {
|
|
574
644
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
575
645
|
const api = new DefaultApi();
|
|
576
646
|
|
|
577
647
|
const body = {
|
|
578
|
-
// string |
|
|
648
|
+
// string | Group ID
|
|
579
649
|
id: id_example,
|
|
580
|
-
|
|
650
|
+
// 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)
|
|
651
|
+
sort: ["cluster:asc","name:desc"],
|
|
652
|
+
// number | Page number for pagination (optional)
|
|
653
|
+
page: 56,
|
|
654
|
+
// number | Number of items per page (optional)
|
|
655
|
+
pageSize: 56,
|
|
656
|
+
} satisfies GetGroupRequest;
|
|
581
657
|
|
|
582
658
|
try {
|
|
583
|
-
const data = await api.
|
|
659
|
+
const data = await api.getGroup(body);
|
|
584
660
|
console.log(data);
|
|
585
661
|
} catch (error) {
|
|
586
662
|
console.error(error);
|
|
@@ -596,11 +672,14 @@ example().catch(console.error);
|
|
|
596
672
|
|
|
597
673
|
| Name | Type | Description | Notes |
|
|
598
674
|
|------------- | ------------- | ------------- | -------------|
|
|
599
|
-
| **id** | `string` |
|
|
675
|
+
| **id** | `string` | Group ID | [Defaults to `undefined`] |
|
|
676
|
+
| **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] |
|
|
677
|
+
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
678
|
+
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
600
679
|
|
|
601
680
|
### Return type
|
|
602
681
|
|
|
603
|
-
[**
|
|
682
|
+
[**GroupResponse**](GroupResponse.md)
|
|
604
683
|
|
|
605
684
|
### Authorization
|
|
606
685
|
|
|
@@ -615,18 +694,18 @@ No authorization required
|
|
|
615
694
|
### HTTP response details
|
|
616
695
|
| Status code | Description | Response headers |
|
|
617
696
|
|-------------|-------------|------------------|
|
|
618
|
-
| **200** |
|
|
619
|
-
| **404** |
|
|
697
|
+
| **200** | Group details with VMs | - |
|
|
698
|
+
| **404** | Group not found | - |
|
|
620
699
|
| **500** | Internal server error | - |
|
|
621
700
|
|
|
622
701
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
623
702
|
|
|
624
703
|
|
|
625
|
-
##
|
|
704
|
+
## getInspectorStatus
|
|
626
705
|
|
|
627
|
-
>
|
|
706
|
+
> InspectorStatus getInspectorStatus(includeVddk)
|
|
628
707
|
|
|
629
|
-
Get
|
|
708
|
+
Get inspector status
|
|
630
709
|
|
|
631
710
|
### Example
|
|
632
711
|
|
|
@@ -635,19 +714,19 @@ import {
|
|
|
635
714
|
Configuration,
|
|
636
715
|
DefaultApi,
|
|
637
716
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
638
|
-
import type {
|
|
717
|
+
import type { GetInspectorStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
639
718
|
|
|
640
719
|
async function example() {
|
|
641
720
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
642
721
|
const api = new DefaultApi();
|
|
643
722
|
|
|
644
723
|
const body = {
|
|
645
|
-
//
|
|
646
|
-
|
|
647
|
-
} satisfies
|
|
724
|
+
// boolean | If true, include uploaded VDDK metadata (`version`, `md5`) when present. omitted if VDDK was never uploaded. (optional)
|
|
725
|
+
includeVddk: true,
|
|
726
|
+
} satisfies GetInspectorStatusRequest;
|
|
648
727
|
|
|
649
728
|
try {
|
|
650
|
-
const data = await api.
|
|
729
|
+
const data = await api.getInspectorStatus(body);
|
|
651
730
|
console.log(data);
|
|
652
731
|
} catch (error) {
|
|
653
732
|
console.error(error);
|
|
@@ -663,11 +742,11 @@ example().catch(console.error);
|
|
|
663
742
|
|
|
664
743
|
| Name | Type | Description | Notes |
|
|
665
744
|
|------------- | ------------- | ------------- | -------------|
|
|
666
|
-
| **
|
|
745
|
+
| **includeVddk** | `boolean` | If true, include uploaded VDDK metadata (`version`, `md5`) when present. omitted if VDDK was never uploaded. | [Optional] [Defaults to `false`] |
|
|
667
746
|
|
|
668
747
|
### Return type
|
|
669
748
|
|
|
670
|
-
[**
|
|
749
|
+
[**InspectorStatus**](InspectorStatus.md)
|
|
671
750
|
|
|
672
751
|
### Authorization
|
|
673
752
|
|
|
@@ -682,18 +761,17 @@ No authorization required
|
|
|
682
761
|
### HTTP response details
|
|
683
762
|
| Status code | Description | Response headers |
|
|
684
763
|
|-------------|-------------|------------------|
|
|
685
|
-
| **200** |
|
|
686
|
-
| **404** | VirtualMachine not found | - |
|
|
764
|
+
| **200** | Inspector status | - |
|
|
687
765
|
| **500** | Internal server error | - |
|
|
688
766
|
|
|
689
767
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
690
768
|
|
|
691
769
|
|
|
692
|
-
##
|
|
770
|
+
## getInspectorVddkStatus
|
|
693
771
|
|
|
694
|
-
>
|
|
772
|
+
> VddkProperties getInspectorVddkStatus()
|
|
695
773
|
|
|
696
|
-
Get
|
|
774
|
+
Get VDDK status
|
|
697
775
|
|
|
698
776
|
### Example
|
|
699
777
|
|
|
@@ -702,19 +780,14 @@ import {
|
|
|
702
780
|
Configuration,
|
|
703
781
|
DefaultApi,
|
|
704
782
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
705
|
-
import type {
|
|
783
|
+
import type { GetInspectorVddkStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
706
784
|
|
|
707
785
|
async function example() {
|
|
708
786
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
709
787
|
const api = new DefaultApi();
|
|
710
788
|
|
|
711
|
-
const body = {
|
|
712
|
-
// string | VirtualMachine MoRef ID
|
|
713
|
-
id: id_example,
|
|
714
|
-
} satisfies GetVMUtilizationRequest;
|
|
715
|
-
|
|
716
789
|
try {
|
|
717
|
-
const data = await api.
|
|
790
|
+
const data = await api.getInspectorVddkStatus();
|
|
718
791
|
console.log(data);
|
|
719
792
|
} catch (error) {
|
|
720
793
|
console.error(error);
|
|
@@ -727,14 +800,11 @@ example().catch(console.error);
|
|
|
727
800
|
|
|
728
801
|
### Parameters
|
|
729
802
|
|
|
730
|
-
|
|
731
|
-
| Name | Type | Description | Notes |
|
|
732
|
-
|------------- | ------------- | ------------- | -------------|
|
|
733
|
-
| **id** | `string` | VirtualMachine MoRef ID | [Defaults to `undefined`] |
|
|
803
|
+
This endpoint does not need any parameter.
|
|
734
804
|
|
|
735
805
|
### Return type
|
|
736
806
|
|
|
737
|
-
[**
|
|
807
|
+
[**VddkProperties**](VddkProperties.md)
|
|
738
808
|
|
|
739
809
|
### Authorization
|
|
740
810
|
|
|
@@ -749,18 +819,559 @@ No authorization required
|
|
|
749
819
|
### HTTP response details
|
|
750
820
|
| Status code | Description | Response headers |
|
|
751
821
|
|-------------|-------------|------------------|
|
|
752
|
-
| **200** |
|
|
753
|
-
| **404** |
|
|
822
|
+
| **200** | Returns the current properties of the uploaded VMware VDDK tar. If the VDDK package has not been uploaded, a 404 response is returned. | - |
|
|
823
|
+
| **404** | Vddk not found | - |
|
|
754
824
|
| **500** | Internal server error | - |
|
|
755
825
|
|
|
756
826
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
757
827
|
|
|
758
828
|
|
|
759
|
-
##
|
|
829
|
+
## getInventory
|
|
830
|
+
|
|
831
|
+
> GetInventory200Response getInventory(withAgentId, groupId)
|
|
832
|
+
|
|
833
|
+
Get collected inventory
|
|
834
|
+
|
|
835
|
+
### Example
|
|
836
|
+
|
|
837
|
+
```ts
|
|
838
|
+
import {
|
|
839
|
+
Configuration,
|
|
840
|
+
DefaultApi,
|
|
841
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
842
|
+
import type { GetInventoryRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
843
|
+
|
|
844
|
+
async function example() {
|
|
845
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
846
|
+
const api = new DefaultApi();
|
|
847
|
+
|
|
848
|
+
const body = {
|
|
849
|
+
// boolean | If true, include the agentId in the response (Compatible with manual inventory upload). (optional)
|
|
850
|
+
withAgentId: true,
|
|
851
|
+
// string | Filter inventory to VMs matching this group\'s filter expression (optional)
|
|
852
|
+
groupId: groupId_example,
|
|
853
|
+
} satisfies GetInventoryRequest;
|
|
854
|
+
|
|
855
|
+
try {
|
|
856
|
+
const data = await api.getInventory(body);
|
|
857
|
+
console.log(data);
|
|
858
|
+
} catch (error) {
|
|
859
|
+
console.error(error);
|
|
860
|
+
}
|
|
861
|
+
}
|
|
862
|
+
|
|
863
|
+
// Run the test
|
|
864
|
+
example().catch(console.error);
|
|
865
|
+
```
|
|
866
|
+
|
|
867
|
+
### Parameters
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
| Name | Type | Description | Notes |
|
|
871
|
+
|------------- | ------------- | ------------- | -------------|
|
|
872
|
+
| **withAgentId** | `boolean` | If true, include the agentId in the response (Compatible with manual inventory upload). | [Optional] [Defaults to `false`] |
|
|
873
|
+
| **groupId** | `string` | Filter inventory to VMs matching this group\'s filter expression | [Optional] [Defaults to `undefined`] |
|
|
874
|
+
|
|
875
|
+
### Return type
|
|
876
|
+
|
|
877
|
+
[**GetInventory200Response**](GetInventory200Response.md)
|
|
878
|
+
|
|
879
|
+
### Authorization
|
|
880
|
+
|
|
881
|
+
No authorization required
|
|
882
|
+
|
|
883
|
+
### HTTP request headers
|
|
884
|
+
|
|
885
|
+
- **Content-Type**: Not defined
|
|
886
|
+
- **Accept**: `application/json`
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
### HTTP response details
|
|
890
|
+
| Status code | Description | Response headers |
|
|
891
|
+
|-------------|-------------|------------------|
|
|
892
|
+
| **200** | Collected inventory | - |
|
|
893
|
+
| **404** | Inventory not available | - |
|
|
894
|
+
| **500** | Internal server error | - |
|
|
895
|
+
|
|
896
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
## getLatestRightsizingClusters
|
|
900
|
+
|
|
901
|
+
> RightsizingClusterListResponse getLatestRightsizingClusters(byExpression)
|
|
902
|
+
|
|
903
|
+
Get cluster-level utilization aggregates for the latest completed report
|
|
904
|
+
|
|
905
|
+
### Example
|
|
906
|
+
|
|
907
|
+
```ts
|
|
908
|
+
import {
|
|
909
|
+
Configuration,
|
|
910
|
+
DefaultApi,
|
|
911
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
912
|
+
import type { GetLatestRightsizingClustersRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
913
|
+
|
|
914
|
+
async function example() {
|
|
915
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
916
|
+
const api = new DefaultApi();
|
|
917
|
+
|
|
918
|
+
const body = {
|
|
919
|
+
// string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
|
|
920
|
+
byExpression: byExpression_example,
|
|
921
|
+
} satisfies GetLatestRightsizingClustersRequest;
|
|
922
|
+
|
|
923
|
+
try {
|
|
924
|
+
const data = await api.getLatestRightsizingClusters(body);
|
|
925
|
+
console.log(data);
|
|
926
|
+
} catch (error) {
|
|
927
|
+
console.error(error);
|
|
928
|
+
}
|
|
929
|
+
}
|
|
930
|
+
|
|
931
|
+
// Run the test
|
|
932
|
+
example().catch(console.error);
|
|
933
|
+
```
|
|
934
|
+
|
|
935
|
+
### Parameters
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
| Name | Type | Description | Notes |
|
|
939
|
+
|------------- | ------------- | ------------- | -------------|
|
|
940
|
+
| **byExpression** | `string` | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
|
|
941
|
+
|
|
942
|
+
### Return type
|
|
943
|
+
|
|
944
|
+
[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
|
|
945
|
+
|
|
946
|
+
### Authorization
|
|
947
|
+
|
|
948
|
+
No authorization required
|
|
949
|
+
|
|
950
|
+
### HTTP request headers
|
|
951
|
+
|
|
952
|
+
- **Content-Type**: Not defined
|
|
953
|
+
- **Accept**: `application/json`
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
### HTTP response details
|
|
957
|
+
| Status code | Description | Response headers |
|
|
958
|
+
|-------------|-------------|------------------|
|
|
959
|
+
| **200** | Cluster utilization aggregates | - |
|
|
960
|
+
| **404** | No completed rightsizing report found | - |
|
|
961
|
+
| **500** | Internal server error | - |
|
|
962
|
+
|
|
963
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
## getRightsizingReport
|
|
967
|
+
|
|
968
|
+
> RightsizingReport getRightsizingReport(id)
|
|
969
|
+
|
|
970
|
+
Get a specific rightsizing report with full VM metrics
|
|
971
|
+
|
|
972
|
+
### Example
|
|
973
|
+
|
|
974
|
+
```ts
|
|
975
|
+
import {
|
|
976
|
+
Configuration,
|
|
977
|
+
DefaultApi,
|
|
978
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
979
|
+
import type { GetRightsizingReportRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
980
|
+
|
|
981
|
+
async function example() {
|
|
982
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
983
|
+
const api = new DefaultApi();
|
|
984
|
+
|
|
985
|
+
const body = {
|
|
986
|
+
// string | Report UUID
|
|
987
|
+
id: id_example,
|
|
988
|
+
} satisfies GetRightsizingReportRequest;
|
|
989
|
+
|
|
990
|
+
try {
|
|
991
|
+
const data = await api.getRightsizingReport(body);
|
|
992
|
+
console.log(data);
|
|
993
|
+
} catch (error) {
|
|
994
|
+
console.error(error);
|
|
995
|
+
}
|
|
996
|
+
}
|
|
997
|
+
|
|
998
|
+
// Run the test
|
|
999
|
+
example().catch(console.error);
|
|
1000
|
+
```
|
|
1001
|
+
|
|
1002
|
+
### Parameters
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
| Name | Type | Description | Notes |
|
|
1006
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1007
|
+
| **id** | `string` | Report UUID | [Defaults to `undefined`] |
|
|
1008
|
+
|
|
1009
|
+
### Return type
|
|
1010
|
+
|
|
1011
|
+
[**RightsizingReport**](RightsizingReport.md)
|
|
1012
|
+
|
|
1013
|
+
### Authorization
|
|
1014
|
+
|
|
1015
|
+
No authorization required
|
|
1016
|
+
|
|
1017
|
+
### HTTP request headers
|
|
1018
|
+
|
|
1019
|
+
- **Content-Type**: Not defined
|
|
1020
|
+
- **Accept**: `application/json`
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
### HTTP response details
|
|
1024
|
+
| Status code | Description | Response headers |
|
|
1025
|
+
|-------------|-------------|------------------|
|
|
1026
|
+
| **200** | Rightsizing report | - |
|
|
1027
|
+
| **404** | Report not found | - |
|
|
1028
|
+
| **500** | Internal server error | - |
|
|
1029
|
+
|
|
1030
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
## getRightsizingReportClusters
|
|
1034
|
+
|
|
1035
|
+
> RightsizingClusterListResponse getRightsizingReportClusters(reportId, byExpression)
|
|
1036
|
+
|
|
1037
|
+
Get cluster-level utilization aggregates for a specific report
|
|
1038
|
+
|
|
1039
|
+
### Example
|
|
1040
|
+
|
|
1041
|
+
```ts
|
|
1042
|
+
import {
|
|
1043
|
+
Configuration,
|
|
1044
|
+
DefaultApi,
|
|
1045
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1046
|
+
import type { GetRightsizingReportClustersRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1047
|
+
|
|
1048
|
+
async function example() {
|
|
1049
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1050
|
+
const api = new DefaultApi();
|
|
1051
|
+
|
|
1052
|
+
const body = {
|
|
1053
|
+
// string | Rightsizing report UUID
|
|
1054
|
+
reportId: reportId_example,
|
|
1055
|
+
// string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
|
|
1056
|
+
byExpression: byExpression_example,
|
|
1057
|
+
} satisfies GetRightsizingReportClustersRequest;
|
|
1058
|
+
|
|
1059
|
+
try {
|
|
1060
|
+
const data = await api.getRightsizingReportClusters(body);
|
|
1061
|
+
console.log(data);
|
|
1062
|
+
} catch (error) {
|
|
1063
|
+
console.error(error);
|
|
1064
|
+
}
|
|
1065
|
+
}
|
|
1066
|
+
|
|
1067
|
+
// Run the test
|
|
1068
|
+
example().catch(console.error);
|
|
1069
|
+
```
|
|
1070
|
+
|
|
1071
|
+
### Parameters
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
| Name | Type | Description | Notes |
|
|
1075
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1076
|
+
| **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
|
|
1077
|
+
| **byExpression** | `string` | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
|
|
1078
|
+
|
|
1079
|
+
### Return type
|
|
1080
|
+
|
|
1081
|
+
[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
|
|
1082
|
+
|
|
1083
|
+
### Authorization
|
|
1084
|
+
|
|
1085
|
+
No authorization required
|
|
1086
|
+
|
|
1087
|
+
### HTTP request headers
|
|
1088
|
+
|
|
1089
|
+
- **Content-Type**: Not defined
|
|
1090
|
+
- **Accept**: `application/json`
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
### HTTP response details
|
|
1094
|
+
| Status code | Description | Response headers |
|
|
1095
|
+
|-------------|-------------|------------------|
|
|
1096
|
+
| **200** | Cluster utilization aggregates | - |
|
|
1097
|
+
| **404** | Report not found | - |
|
|
1098
|
+
| **500** | Internal server error | - |
|
|
1099
|
+
|
|
1100
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
## getVM
|
|
1104
|
+
|
|
1105
|
+
> VirtualMachineDetail getVM(id)
|
|
1106
|
+
|
|
1107
|
+
Get details about a vm
|
|
1108
|
+
|
|
1109
|
+
### Example
|
|
1110
|
+
|
|
1111
|
+
```ts
|
|
1112
|
+
import {
|
|
1113
|
+
Configuration,
|
|
1114
|
+
DefaultApi,
|
|
1115
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1116
|
+
import type { GetVMRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1117
|
+
|
|
1118
|
+
async function example() {
|
|
1119
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1120
|
+
const api = new DefaultApi();
|
|
1121
|
+
|
|
1122
|
+
const body = {
|
|
1123
|
+
// string | VirtualMachine id
|
|
1124
|
+
id: id_example,
|
|
1125
|
+
} satisfies GetVMRequest;
|
|
1126
|
+
|
|
1127
|
+
try {
|
|
1128
|
+
const data = await api.getVM(body);
|
|
1129
|
+
console.log(data);
|
|
1130
|
+
} catch (error) {
|
|
1131
|
+
console.error(error);
|
|
1132
|
+
}
|
|
1133
|
+
}
|
|
1134
|
+
|
|
1135
|
+
// Run the test
|
|
1136
|
+
example().catch(console.error);
|
|
1137
|
+
```
|
|
1138
|
+
|
|
1139
|
+
### Parameters
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
| Name | Type | Description | Notes |
|
|
1143
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1144
|
+
| **id** | `string` | VirtualMachine id | [Defaults to `undefined`] |
|
|
1145
|
+
|
|
1146
|
+
### Return type
|
|
1147
|
+
|
|
1148
|
+
[**VirtualMachineDetail**](VirtualMachineDetail.md)
|
|
1149
|
+
|
|
1150
|
+
### Authorization
|
|
1151
|
+
|
|
1152
|
+
No authorization required
|
|
1153
|
+
|
|
1154
|
+
### HTTP request headers
|
|
1155
|
+
|
|
1156
|
+
- **Content-Type**: Not defined
|
|
1157
|
+
- **Accept**: `application/json`
|
|
1158
|
+
|
|
1159
|
+
|
|
1160
|
+
### HTTP response details
|
|
1161
|
+
| Status code | Description | Response headers |
|
|
1162
|
+
|-------------|-------------|------------------|
|
|
1163
|
+
| **200** | VirtualMachine details | - |
|
|
1164
|
+
| **404** | VirtualMachine not found | - |
|
|
1165
|
+
| **500** | Internal server error | - |
|
|
1166
|
+
|
|
1167
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
## getVMUtilization
|
|
1171
|
+
|
|
1172
|
+
> VmUtilizationDetails getVMUtilization(id)
|
|
1173
|
+
|
|
1174
|
+
Get utilization breakdown for a specific VM
|
|
1175
|
+
|
|
1176
|
+
### Example
|
|
1177
|
+
|
|
1178
|
+
```ts
|
|
1179
|
+
import {
|
|
1180
|
+
Configuration,
|
|
1181
|
+
DefaultApi,
|
|
1182
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1183
|
+
import type { GetVMUtilizationRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1184
|
+
|
|
1185
|
+
async function example() {
|
|
1186
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1187
|
+
const api = new DefaultApi();
|
|
1188
|
+
|
|
1189
|
+
const body = {
|
|
1190
|
+
// string | VirtualMachine MoRef ID
|
|
1191
|
+
id: id_example,
|
|
1192
|
+
} satisfies GetVMUtilizationRequest;
|
|
1193
|
+
|
|
1194
|
+
try {
|
|
1195
|
+
const data = await api.getVMUtilization(body);
|
|
1196
|
+
console.log(data);
|
|
1197
|
+
} catch (error) {
|
|
1198
|
+
console.error(error);
|
|
1199
|
+
}
|
|
1200
|
+
}
|
|
1201
|
+
|
|
1202
|
+
// Run the test
|
|
1203
|
+
example().catch(console.error);
|
|
1204
|
+
```
|
|
1205
|
+
|
|
1206
|
+
### Parameters
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
| Name | Type | Description | Notes |
|
|
1210
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1211
|
+
| **id** | `string` | VirtualMachine MoRef ID | [Defaults to `undefined`] |
|
|
1212
|
+
|
|
1213
|
+
### Return type
|
|
1214
|
+
|
|
1215
|
+
[**VmUtilizationDetails**](VmUtilizationDetails.md)
|
|
1216
|
+
|
|
1217
|
+
### Authorization
|
|
1218
|
+
|
|
1219
|
+
No authorization required
|
|
1220
|
+
|
|
1221
|
+
### HTTP request headers
|
|
1222
|
+
|
|
1223
|
+
- **Content-Type**: Not defined
|
|
1224
|
+
- **Accept**: `application/json`
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
### HTTP response details
|
|
1228
|
+
| Status code | Description | Response headers |
|
|
1229
|
+
|-------------|-------------|------------------|
|
|
1230
|
+
| **200** | VM utilization details | - |
|
|
1231
|
+
| **404** | No utilization data found for this VM | - |
|
|
1232
|
+
| **500** | Internal server error | - |
|
|
1233
|
+
|
|
1234
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
## getVMs
|
|
1238
|
+
|
|
1239
|
+
> VirtualMachineListResponse getVMs(byExpression, sort, page, pageSize)
|
|
1240
|
+
|
|
1241
|
+
Get list of VMs with filtering and pagination
|
|
1242
|
+
|
|
1243
|
+
### Example
|
|
1244
|
+
|
|
1245
|
+
```ts
|
|
1246
|
+
import {
|
|
1247
|
+
Configuration,
|
|
1248
|
+
DefaultApi,
|
|
1249
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1250
|
+
import type { GetVMsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1251
|
+
|
|
1252
|
+
async function example() {
|
|
1253
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1254
|
+
const api = new DefaultApi();
|
|
1255
|
+
|
|
1256
|
+
const body = {
|
|
1257
|
+
// string | Filter by expression (matches VMs with the provided expression) (optional)
|
|
1258
|
+
byExpression: exp1,
|
|
1259
|
+
// 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)
|
|
1260
|
+
sort: ["cluster:asc","name:desc"],
|
|
1261
|
+
// number | Page number for pagination (optional)
|
|
1262
|
+
page: 56,
|
|
1263
|
+
// number | Number of items per page (optional)
|
|
1264
|
+
pageSize: 56,
|
|
1265
|
+
} satisfies GetVMsRequest;
|
|
1266
|
+
|
|
1267
|
+
try {
|
|
1268
|
+
const data = await api.getVMs(body);
|
|
1269
|
+
console.log(data);
|
|
1270
|
+
} catch (error) {
|
|
1271
|
+
console.error(error);
|
|
1272
|
+
}
|
|
1273
|
+
}
|
|
1274
|
+
|
|
1275
|
+
// Run the test
|
|
1276
|
+
example().catch(console.error);
|
|
1277
|
+
```
|
|
1278
|
+
|
|
1279
|
+
### Parameters
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
| Name | Type | Description | Notes |
|
|
1283
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1284
|
+
| **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
|
|
1285
|
+
| **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] |
|
|
1286
|
+
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
1287
|
+
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
1288
|
+
|
|
1289
|
+
### Return type
|
|
1290
|
+
|
|
1291
|
+
[**VirtualMachineListResponse**](VirtualMachineListResponse.md)
|
|
1292
|
+
|
|
1293
|
+
### Authorization
|
|
1294
|
+
|
|
1295
|
+
No authorization required
|
|
1296
|
+
|
|
1297
|
+
### HTTP request headers
|
|
1298
|
+
|
|
1299
|
+
- **Content-Type**: Not defined
|
|
1300
|
+
- **Accept**: `application/json`
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
### HTTP response details
|
|
1304
|
+
| Status code | Description | Response headers |
|
|
1305
|
+
|-------------|-------------|------------------|
|
|
1306
|
+
| **200** | List of VMs | - |
|
|
1307
|
+
| **400** | Invalid request parameters | - |
|
|
1308
|
+
| **500** | Internal server error | - |
|
|
1309
|
+
|
|
1310
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
## getVersion
|
|
1314
|
+
|
|
1315
|
+
> VersionInfo getVersion()
|
|
1316
|
+
|
|
1317
|
+
Get agent version information
|
|
1318
|
+
|
|
1319
|
+
### Example
|
|
1320
|
+
|
|
1321
|
+
```ts
|
|
1322
|
+
import {
|
|
1323
|
+
Configuration,
|
|
1324
|
+
DefaultApi,
|
|
1325
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1326
|
+
import type { GetVersionRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1327
|
+
|
|
1328
|
+
async function example() {
|
|
1329
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1330
|
+
const api = new DefaultApi();
|
|
1331
|
+
|
|
1332
|
+
try {
|
|
1333
|
+
const data = await api.getVersion();
|
|
1334
|
+
console.log(data);
|
|
1335
|
+
} catch (error) {
|
|
1336
|
+
console.error(error);
|
|
1337
|
+
}
|
|
1338
|
+
}
|
|
1339
|
+
|
|
1340
|
+
// Run the test
|
|
1341
|
+
example().catch(console.error);
|
|
1342
|
+
```
|
|
1343
|
+
|
|
1344
|
+
### Parameters
|
|
1345
|
+
|
|
1346
|
+
This endpoint does not need any parameter.
|
|
1347
|
+
|
|
1348
|
+
### Return type
|
|
1349
|
+
|
|
1350
|
+
[**VersionInfo**](VersionInfo.md)
|
|
1351
|
+
|
|
1352
|
+
### Authorization
|
|
1353
|
+
|
|
1354
|
+
No authorization required
|
|
1355
|
+
|
|
1356
|
+
### HTTP request headers
|
|
1357
|
+
|
|
1358
|
+
- **Content-Type**: Not defined
|
|
1359
|
+
- **Accept**: `application/json`
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
### HTTP response details
|
|
1363
|
+
| Status code | Description | Response headers |
|
|
1364
|
+
|-------------|-------------|------------------|
|
|
1365
|
+
| **200** | Version information | - |
|
|
1366
|
+
|
|
1367
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
## listGroups
|
|
760
1371
|
|
|
761
|
-
>
|
|
1372
|
+
> GroupListResponse listGroups(byName, page, pageSize)
|
|
762
1373
|
|
|
763
|
-
|
|
1374
|
+
List all groups
|
|
764
1375
|
|
|
765
1376
|
### Example
|
|
766
1377
|
|
|
@@ -769,25 +1380,23 @@ import {
|
|
|
769
1380
|
Configuration,
|
|
770
1381
|
DefaultApi,
|
|
771
1382
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
772
|
-
import type {
|
|
1383
|
+
import type { ListGroupsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
773
1384
|
|
|
774
1385
|
async function example() {
|
|
775
1386
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
776
1387
|
const api = new DefaultApi();
|
|
777
1388
|
|
|
778
1389
|
const body = {
|
|
779
|
-
// string | Filter by
|
|
780
|
-
|
|
781
|
-
//
|
|
782
|
-
sort: ["cluster:asc","name:desc"],
|
|
783
|
-
// number | Page number for pagination (optional)
|
|
1390
|
+
// string | Filter groups by name (case-insensitive substring match) (optional)
|
|
1391
|
+
byName: byName_example,
|
|
1392
|
+
// number | Page number (1-indexed) (optional)
|
|
784
1393
|
page: 56,
|
|
785
|
-
// number | Number of
|
|
1394
|
+
// number | Number of groups per page (optional)
|
|
786
1395
|
pageSize: 56,
|
|
787
|
-
} satisfies
|
|
1396
|
+
} satisfies ListGroupsRequest;
|
|
788
1397
|
|
|
789
1398
|
try {
|
|
790
|
-
const data = await api.
|
|
1399
|
+
const data = await api.listGroups(body);
|
|
791
1400
|
console.log(data);
|
|
792
1401
|
} catch (error) {
|
|
793
1402
|
console.error(error);
|
|
@@ -803,14 +1412,13 @@ example().catch(console.error);
|
|
|
803
1412
|
|
|
804
1413
|
| Name | Type | Description | Notes |
|
|
805
1414
|
|------------- | ------------- | ------------- | -------------|
|
|
806
|
-
| **
|
|
807
|
-
| **
|
|
808
|
-
| **
|
|
809
|
-
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
1415
|
+
| **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
|
|
1416
|
+
| **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
|
|
1417
|
+
| **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
|
|
810
1418
|
|
|
811
1419
|
### Return type
|
|
812
1420
|
|
|
813
|
-
[**
|
|
1421
|
+
[**GroupListResponse**](GroupListResponse.md)
|
|
814
1422
|
|
|
815
1423
|
### Authorization
|
|
816
1424
|
|
|
@@ -825,18 +1433,18 @@ No authorization required
|
|
|
825
1433
|
### HTTP response details
|
|
826
1434
|
| Status code | Description | Response headers |
|
|
827
1435
|
|-------------|-------------|------------------|
|
|
828
|
-
| **200** | List of
|
|
829
|
-
| **400** | Invalid
|
|
1436
|
+
| **200** | List of groups | - |
|
|
1437
|
+
| **400** | Invalid filter expression | - |
|
|
830
1438
|
| **500** | Internal server error | - |
|
|
831
1439
|
|
|
832
1440
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
833
1441
|
|
|
834
1442
|
|
|
835
|
-
##
|
|
1443
|
+
## listRightsizingReports
|
|
836
1444
|
|
|
837
|
-
>
|
|
1445
|
+
> RightsizingReportListResponse listRightsizingReports()
|
|
838
1446
|
|
|
839
|
-
|
|
1447
|
+
List all rightsizing reports
|
|
840
1448
|
|
|
841
1449
|
### Example
|
|
842
1450
|
|
|
@@ -845,14 +1453,14 @@ import {
|
|
|
845
1453
|
Configuration,
|
|
846
1454
|
DefaultApi,
|
|
847
1455
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
848
|
-
import type {
|
|
1456
|
+
import type { ListRightsizingReportsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
849
1457
|
|
|
850
1458
|
async function example() {
|
|
851
1459
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
852
1460
|
const api = new DefaultApi();
|
|
853
1461
|
|
|
854
1462
|
try {
|
|
855
|
-
const data = await api.
|
|
1463
|
+
const data = await api.listRightsizingReports();
|
|
856
1464
|
console.log(data);
|
|
857
1465
|
} catch (error) {
|
|
858
1466
|
console.error(error);
|
|
@@ -869,7 +1477,7 @@ This endpoint does not need any parameter.
|
|
|
869
1477
|
|
|
870
1478
|
### Return type
|
|
871
1479
|
|
|
872
|
-
[**
|
|
1480
|
+
[**RightsizingReportListResponse**](RightsizingReportListResponse.md)
|
|
873
1481
|
|
|
874
1482
|
### Authorization
|
|
875
1483
|
|
|
@@ -884,16 +1492,19 @@ No authorization required
|
|
|
884
1492
|
### HTTP response details
|
|
885
1493
|
| Status code | Description | Response headers |
|
|
886
1494
|
|-------------|-------------|------------------|
|
|
887
|
-
| **200** |
|
|
1495
|
+
| **200** | List of rightsizing reports | - |
|
|
1496
|
+
| **500** | Internal server error | - |
|
|
888
1497
|
|
|
889
1498
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
890
1499
|
|
|
891
1500
|
|
|
892
|
-
##
|
|
1501
|
+
## postForecasterPairCapabilities
|
|
893
1502
|
|
|
894
|
-
>
|
|
1503
|
+
> Array<PairCapability> postForecasterPairCapabilities(pairCapabilityRequest)
|
|
895
1504
|
|
|
896
|
-
|
|
1505
|
+
Compute pair capabilities
|
|
1506
|
+
|
|
1507
|
+
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
1508
|
|
|
898
1509
|
### Example
|
|
899
1510
|
|
|
@@ -902,23 +1513,19 @@ import {
|
|
|
902
1513
|
Configuration,
|
|
903
1514
|
DefaultApi,
|
|
904
1515
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
905
|
-
import type {
|
|
1516
|
+
import type { PostForecasterPairCapabilitiesRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
906
1517
|
|
|
907
1518
|
async function example() {
|
|
908
1519
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
909
1520
|
const api = new DefaultApi();
|
|
910
1521
|
|
|
911
1522
|
const body = {
|
|
912
|
-
//
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
page: 56,
|
|
916
|
-
// number | Number of groups per page (optional)
|
|
917
|
-
pageSize: 56,
|
|
918
|
-
} satisfies ListGroupsRequest;
|
|
1523
|
+
// PairCapabilityRequest
|
|
1524
|
+
pairCapabilityRequest: ...,
|
|
1525
|
+
} satisfies PostForecasterPairCapabilitiesRequest;
|
|
919
1526
|
|
|
920
1527
|
try {
|
|
921
|
-
const data = await api.
|
|
1528
|
+
const data = await api.postForecasterPairCapabilities(body);
|
|
922
1529
|
console.log(data);
|
|
923
1530
|
} catch (error) {
|
|
924
1531
|
console.error(error);
|
|
@@ -934,13 +1541,11 @@ example().catch(console.error);
|
|
|
934
1541
|
|
|
935
1542
|
| Name | Type | Description | Notes |
|
|
936
1543
|
|------------- | ------------- | ------------- | -------------|
|
|
937
|
-
| **
|
|
938
|
-
| **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
|
|
939
|
-
| **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
|
|
1544
|
+
| **pairCapabilityRequest** | [PairCapabilityRequest](PairCapabilityRequest.md) | | |
|
|
940
1545
|
|
|
941
1546
|
### Return type
|
|
942
1547
|
|
|
943
|
-
[**
|
|
1548
|
+
[**Array<PairCapability>**](PairCapability.md)
|
|
944
1549
|
|
|
945
1550
|
### Authorization
|
|
946
1551
|
|
|
@@ -948,25 +1553,27 @@ No authorization required
|
|
|
948
1553
|
|
|
949
1554
|
### HTTP request headers
|
|
950
1555
|
|
|
951
|
-
- **Content-Type**:
|
|
1556
|
+
- **Content-Type**: `application/json`
|
|
952
1557
|
- **Accept**: `application/json`
|
|
953
1558
|
|
|
954
1559
|
|
|
955
1560
|
### HTTP response details
|
|
956
1561
|
| Status code | Description | Response headers |
|
|
957
1562
|
|-------------|-------------|------------------|
|
|
958
|
-
| **200** |
|
|
959
|
-
| **400** |
|
|
1563
|
+
| **200** | Capabilities per pair | - |
|
|
1564
|
+
| **400** | Datastore not found | - |
|
|
960
1565
|
| **500** | Internal server error | - |
|
|
961
1566
|
|
|
962
1567
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
963
1568
|
|
|
964
1569
|
|
|
965
|
-
##
|
|
1570
|
+
## putForecasterCredentials
|
|
966
1571
|
|
|
967
|
-
>
|
|
1572
|
+
> putForecasterCredentials(vcenterCredentials)
|
|
968
1573
|
|
|
969
|
-
|
|
1574
|
+
Verify vCenter credentials and permissions
|
|
1575
|
+
|
|
1576
|
+
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
1577
|
|
|
971
1578
|
### Example
|
|
972
1579
|
|
|
@@ -975,14 +1582,19 @@ import {
|
|
|
975
1582
|
Configuration,
|
|
976
1583
|
DefaultApi,
|
|
977
1584
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
978
|
-
import type {
|
|
1585
|
+
import type { PutForecasterCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
979
1586
|
|
|
980
1587
|
async function example() {
|
|
981
1588
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
982
1589
|
const api = new DefaultApi();
|
|
983
1590
|
|
|
1591
|
+
const body = {
|
|
1592
|
+
// VcenterCredentials
|
|
1593
|
+
vcenterCredentials: ...,
|
|
1594
|
+
} satisfies PutForecasterCredentialsRequest;
|
|
1595
|
+
|
|
984
1596
|
try {
|
|
985
|
-
const data = await api.
|
|
1597
|
+
const data = await api.putForecasterCredentials(body);
|
|
986
1598
|
console.log(data);
|
|
987
1599
|
} catch (error) {
|
|
988
1600
|
console.error(error);
|
|
@@ -995,11 +1607,14 @@ example().catch(console.error);
|
|
|
995
1607
|
|
|
996
1608
|
### Parameters
|
|
997
1609
|
|
|
998
|
-
|
|
1610
|
+
|
|
1611
|
+
| Name | Type | Description | Notes |
|
|
1612
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1613
|
+
| **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
|
|
999
1614
|
|
|
1000
1615
|
### Return type
|
|
1001
1616
|
|
|
1002
|
-
|
|
1617
|
+
`void` (Empty response body)
|
|
1003
1618
|
|
|
1004
1619
|
### Authorization
|
|
1005
1620
|
|
|
@@ -1007,14 +1622,16 @@ No authorization required
|
|
|
1007
1622
|
|
|
1008
1623
|
### HTTP request headers
|
|
1009
1624
|
|
|
1010
|
-
- **Content-Type**:
|
|
1625
|
+
- **Content-Type**: `application/json`
|
|
1011
1626
|
- **Accept**: `application/json`
|
|
1012
1627
|
|
|
1013
1628
|
|
|
1014
1629
|
### HTTP response details
|
|
1015
1630
|
| Status code | Description | Response headers |
|
|
1016
1631
|
|-------------|-------------|------------------|
|
|
1017
|
-
| **200** |
|
|
1632
|
+
| **200** | Credentials valid and all required privileges are granted | - |
|
|
1633
|
+
| **400** | Invalid credentials or unreachable vCenter | - |
|
|
1634
|
+
| **403** | Authentication succeeded but user lacks required privileges | - |
|
|
1018
1635
|
| **500** | Internal server error | - |
|
|
1019
1636
|
|
|
1020
1637
|
[[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 +1977,76 @@ No authorization required
|
|
|
1360
1977
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1361
1978
|
|
|
1362
1979
|
|
|
1980
|
+
## startForecaster
|
|
1981
|
+
|
|
1982
|
+
> ForecasterStatus startForecaster(forecasterStartRequest)
|
|
1983
|
+
|
|
1984
|
+
Start benchmark
|
|
1985
|
+
|
|
1986
|
+
Starts async benchmarking for one or more datastore pairs. Credentials can be passed inline or omitted if previously provided in an earlier request.
|
|
1987
|
+
|
|
1988
|
+
### Example
|
|
1989
|
+
|
|
1990
|
+
```ts
|
|
1991
|
+
import {
|
|
1992
|
+
Configuration,
|
|
1993
|
+
DefaultApi,
|
|
1994
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1995
|
+
import type { StartForecasterRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1996
|
+
|
|
1997
|
+
async function example() {
|
|
1998
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1999
|
+
const api = new DefaultApi();
|
|
2000
|
+
|
|
2001
|
+
const body = {
|
|
2002
|
+
// ForecasterStartRequest
|
|
2003
|
+
forecasterStartRequest: ...,
|
|
2004
|
+
} satisfies StartForecasterRequest;
|
|
2005
|
+
|
|
2006
|
+
try {
|
|
2007
|
+
const data = await api.startForecaster(body);
|
|
2008
|
+
console.log(data);
|
|
2009
|
+
} catch (error) {
|
|
2010
|
+
console.error(error);
|
|
2011
|
+
}
|
|
2012
|
+
}
|
|
2013
|
+
|
|
2014
|
+
// Run the test
|
|
2015
|
+
example().catch(console.error);
|
|
2016
|
+
```
|
|
2017
|
+
|
|
2018
|
+
### Parameters
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
| Name | Type | Description | Notes |
|
|
2022
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2023
|
+
| **forecasterStartRequest** | [ForecasterStartRequest](ForecasterStartRequest.md) | | |
|
|
2024
|
+
|
|
2025
|
+
### Return type
|
|
2026
|
+
|
|
2027
|
+
[**ForecasterStatus**](ForecasterStatus.md)
|
|
2028
|
+
|
|
2029
|
+
### Authorization
|
|
2030
|
+
|
|
2031
|
+
No authorization required
|
|
2032
|
+
|
|
2033
|
+
### HTTP request headers
|
|
2034
|
+
|
|
2035
|
+
- **Content-Type**: `application/json`
|
|
2036
|
+
- **Accept**: `application/json`
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
### HTTP response details
|
|
2040
|
+
| Status code | Description | Response headers |
|
|
2041
|
+
|-------------|-------------|------------------|
|
|
2042
|
+
| **202** | Benchmark started | - |
|
|
2043
|
+
| **400** | Invalid credentials, validation error, or pair limit exceeded | - |
|
|
2044
|
+
| **409** | Another benchmark is already running | - |
|
|
2045
|
+
| **500** | Internal server error | - |
|
|
2046
|
+
|
|
2047
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2048
|
+
|
|
2049
|
+
|
|
1363
2050
|
## startInspection
|
|
1364
2051
|
|
|
1365
2052
|
> InspectorStatus startInspection(startInspectionRequest)
|
|
@@ -1486,6 +2173,136 @@ No authorization required
|
|
|
1486
2173
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1487
2174
|
|
|
1488
2175
|
|
|
2176
|
+
## stopForecaster
|
|
2177
|
+
|
|
2178
|
+
> ForecasterStatus stopForecaster()
|
|
2179
|
+
|
|
2180
|
+
Cancel benchmark
|
|
2181
|
+
|
|
2182
|
+
Stops the running benchmark. Already-completed runs are preserved in the database.
|
|
2183
|
+
|
|
2184
|
+
### Example
|
|
2185
|
+
|
|
2186
|
+
```ts
|
|
2187
|
+
import {
|
|
2188
|
+
Configuration,
|
|
2189
|
+
DefaultApi,
|
|
2190
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2191
|
+
import type { StopForecasterRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2192
|
+
|
|
2193
|
+
async function example() {
|
|
2194
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2195
|
+
const api = new DefaultApi();
|
|
2196
|
+
|
|
2197
|
+
try {
|
|
2198
|
+
const data = await api.stopForecaster();
|
|
2199
|
+
console.log(data);
|
|
2200
|
+
} catch (error) {
|
|
2201
|
+
console.error(error);
|
|
2202
|
+
}
|
|
2203
|
+
}
|
|
2204
|
+
|
|
2205
|
+
// Run the test
|
|
2206
|
+
example().catch(console.error);
|
|
2207
|
+
```
|
|
2208
|
+
|
|
2209
|
+
### Parameters
|
|
2210
|
+
|
|
2211
|
+
This endpoint does not need any parameter.
|
|
2212
|
+
|
|
2213
|
+
### Return type
|
|
2214
|
+
|
|
2215
|
+
[**ForecasterStatus**](ForecasterStatus.md)
|
|
2216
|
+
|
|
2217
|
+
### Authorization
|
|
2218
|
+
|
|
2219
|
+
No authorization required
|
|
2220
|
+
|
|
2221
|
+
### HTTP request headers
|
|
2222
|
+
|
|
2223
|
+
- **Content-Type**: Not defined
|
|
2224
|
+
- **Accept**: `application/json`
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
### HTTP response details
|
|
2228
|
+
| Status code | Description | Response headers |
|
|
2229
|
+
|-------------|-------------|------------------|
|
|
2230
|
+
| **202** | Benchmark canceled, service returned to ready | - |
|
|
2231
|
+
| **404** | No benchmark is running | - |
|
|
2232
|
+
| **500** | Internal server error | - |
|
|
2233
|
+
|
|
2234
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2235
|
+
|
|
2236
|
+
|
|
2237
|
+
## stopForecasterPair
|
|
2238
|
+
|
|
2239
|
+
> StopForecasterPair202Response stopForecasterPair(name)
|
|
2240
|
+
|
|
2241
|
+
Cancel a single pair
|
|
2242
|
+
|
|
2243
|
+
Cancels the benchmark for a specific pair by name. The forecaster continues running if other pairs are still active.
|
|
2244
|
+
|
|
2245
|
+
### Example
|
|
2246
|
+
|
|
2247
|
+
```ts
|
|
2248
|
+
import {
|
|
2249
|
+
Configuration,
|
|
2250
|
+
DefaultApi,
|
|
2251
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2252
|
+
import type { StopForecasterPairRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2253
|
+
|
|
2254
|
+
async function example() {
|
|
2255
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2256
|
+
const api = new DefaultApi();
|
|
2257
|
+
|
|
2258
|
+
const body = {
|
|
2259
|
+
// string | Pair name as specified in the start request
|
|
2260
|
+
name: name_example,
|
|
2261
|
+
} satisfies StopForecasterPairRequest;
|
|
2262
|
+
|
|
2263
|
+
try {
|
|
2264
|
+
const data = await api.stopForecasterPair(body);
|
|
2265
|
+
console.log(data);
|
|
2266
|
+
} catch (error) {
|
|
2267
|
+
console.error(error);
|
|
2268
|
+
}
|
|
2269
|
+
}
|
|
2270
|
+
|
|
2271
|
+
// Run the test
|
|
2272
|
+
example().catch(console.error);
|
|
2273
|
+
```
|
|
2274
|
+
|
|
2275
|
+
### Parameters
|
|
2276
|
+
|
|
2277
|
+
|
|
2278
|
+
| Name | Type | Description | Notes |
|
|
2279
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2280
|
+
| **name** | `string` | Pair name as specified in the start request | [Defaults to `undefined`] |
|
|
2281
|
+
|
|
2282
|
+
### Return type
|
|
2283
|
+
|
|
2284
|
+
[**StopForecasterPair202Response**](StopForecasterPair202Response.md)
|
|
2285
|
+
|
|
2286
|
+
### Authorization
|
|
2287
|
+
|
|
2288
|
+
No authorization required
|
|
2289
|
+
|
|
2290
|
+
### HTTP request headers
|
|
2291
|
+
|
|
2292
|
+
- **Content-Type**: Not defined
|
|
2293
|
+
- **Accept**: `application/json`
|
|
2294
|
+
|
|
2295
|
+
|
|
2296
|
+
### HTTP response details
|
|
2297
|
+
| Status code | Description | Response headers |
|
|
2298
|
+
|-------------|-------------|------------------|
|
|
2299
|
+
| **202** | Pair canceled | - |
|
|
2300
|
+
| **404** | No benchmark running, or pair not found / already finished | - |
|
|
2301
|
+
| **500** | Internal server error | - |
|
|
2302
|
+
|
|
2303
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2304
|
+
|
|
2305
|
+
|
|
1489
2306
|
## stopInspection
|
|
1490
2307
|
|
|
1491
2308
|
> InspectorStatus stopInspection()
|