@openshift-migration-advisor/agent-sdk 0.12.0-914fe80385ee → 0.12.0-a3d6bdc8bce2
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 +16 -0
- package/README.md +19 -4
- package/dist/apis/DefaultApi.d.ts +303 -41
- package/dist/apis/DefaultApi.js +335 -46
- package/dist/esm/apis/DefaultApi.d.ts +303 -41
- package/dist/esm/apis/DefaultApi.js +335 -46
- package/dist/esm/models/AgentStatus.d.ts +1 -1
- package/dist/esm/models/AgentStatus.js +3 -3
- package/dist/esm/models/ClusterFeatures.d.ts +54 -0
- package/dist/esm/models/ClusterFeatures.js +54 -0
- package/dist/esm/models/ClusterUtilization.d.ts +68 -0
- package/dist/esm/models/ClusterUtilization.js +67 -0
- package/dist/esm/models/CreateGroupRequest.d.ts +0 -6
- package/dist/esm/models/CreateGroupRequest.js +0 -2
- package/dist/esm/models/DeleteLabelGloballyResponse.d.ts +38 -0
- package/dist/esm/models/DeleteLabelGloballyResponse.js +47 -0
- package/dist/esm/models/Group.d.ts +0 -6
- package/dist/esm/models/Group.js +0 -2
- package/dist/esm/models/GroupResponse.d.ts +7 -0
- package/dist/esm/models/GroupResponse.js +3 -0
- package/dist/esm/models/InspectorStatus.d.ts +0 -17
- package/dist/esm/models/InspectorStatus.js +1 -10
- package/dist/esm/models/Inventory.d.ts +7 -1
- package/dist/esm/models/Inventory.js +5 -3
- package/dist/esm/models/InventoryData.d.ts +14 -0
- package/dist/esm/models/InventoryData.js +6 -0
- package/dist/esm/models/RightsizingClusterListResponse.d.ts +1 -1
- package/dist/esm/models/RightsizingClusterListResponse.js +3 -3
- package/dist/esm/models/RightsizingClusterResponse.d.ts +39 -0
- package/dist/esm/models/RightsizingClusterResponse.js +48 -0
- package/dist/esm/models/RightsizingClusterUtilization.d.ts +12 -12
- package/dist/esm/models/RightsizingClusterUtilization.js +36 -36
- package/dist/esm/models/RightsizingCollectRequest.d.ts +6 -6
- package/dist/esm/models/RightsizingCollectRequest.js +12 -12
- package/dist/esm/models/RightsizingMetricStats.d.ts +1 -1
- package/dist/esm/models/RightsizingMetricStats.js +3 -3
- package/dist/esm/models/RightsizingReport.d.ts +6 -6
- package/dist/esm/models/RightsizingReport.js +18 -18
- package/dist/esm/models/RightsizingReportSummary.d.ts +6 -6
- package/dist/esm/models/RightsizingReportSummary.js +18 -18
- package/dist/esm/models/StartInspectionRequest.d.ts +8 -1
- package/dist/esm/models/StartInspectionRequest.js +5 -0
- package/dist/esm/models/UpdateGroupRequest.d.ts +0 -6
- package/dist/esm/models/UpdateGroupRequest.js +0 -2
- package/dist/esm/models/UpdateLabelVMsRequest.d.ts +38 -0
- package/dist/esm/models/UpdateLabelVMsRequest.js +43 -0
- package/dist/esm/models/VMFilterOptionsResponse.d.ts +50 -0
- package/dist/esm/models/VMFilterOptionsResponse.js +55 -0
- package/dist/esm/models/VMLabelsResponse.d.ts +38 -0
- package/dist/esm/models/VMLabelsResponse.js +47 -0
- package/dist/esm/models/VirtualMachine.d.ts +18 -6
- package/dist/esm/models/VirtualMachine.js +14 -10
- package/dist/esm/models/VirtualMachineDetail.d.ts +19 -0
- package/dist/esm/models/VirtualMachineDetail.js +7 -0
- package/dist/esm/models/VirtualMachineUpdateRequest.d.ts +38 -0
- package/dist/esm/models/VirtualMachineUpdateRequest.js +43 -0
- package/dist/esm/models/VmUtilizationDetails.d.ts +12 -12
- package/dist/esm/models/VmUtilizationDetails.js +36 -36
- package/dist/esm/models/index.d.ts +8 -0
- package/dist/esm/models/index.js +8 -0
- package/dist/models/AgentStatus.d.ts +1 -1
- package/dist/models/AgentStatus.js +3 -3
- package/dist/models/ClusterFeatures.d.ts +54 -0
- package/dist/models/ClusterFeatures.js +62 -0
- package/dist/models/ClusterUtilization.d.ts +68 -0
- package/dist/models/ClusterUtilization.js +74 -0
- package/dist/models/CreateGroupRequest.d.ts +0 -6
- package/dist/models/CreateGroupRequest.js +0 -2
- package/dist/models/DeleteLabelGloballyResponse.d.ts +38 -0
- package/dist/models/DeleteLabelGloballyResponse.js +54 -0
- package/dist/models/Group.d.ts +0 -6
- package/dist/models/Group.js +0 -2
- package/dist/models/GroupResponse.d.ts +7 -0
- package/dist/models/GroupResponse.js +3 -0
- package/dist/models/InspectorStatus.d.ts +0 -17
- package/dist/models/InspectorStatus.js +1 -10
- package/dist/models/Inventory.d.ts +7 -1
- package/dist/models/Inventory.js +5 -3
- package/dist/models/InventoryData.d.ts +14 -0
- package/dist/models/InventoryData.js +6 -0
- package/dist/models/RightsizingClusterListResponse.d.ts +1 -1
- package/dist/models/RightsizingClusterListResponse.js +3 -3
- package/dist/models/RightsizingClusterResponse.d.ts +39 -0
- package/dist/models/RightsizingClusterResponse.js +55 -0
- package/dist/models/RightsizingClusterUtilization.d.ts +12 -12
- package/dist/models/RightsizingClusterUtilization.js +36 -36
- package/dist/models/RightsizingCollectRequest.d.ts +6 -6
- package/dist/models/RightsizingCollectRequest.js +12 -12
- package/dist/models/RightsizingMetricStats.d.ts +1 -1
- package/dist/models/RightsizingMetricStats.js +3 -3
- package/dist/models/RightsizingReport.d.ts +6 -6
- package/dist/models/RightsizingReport.js +18 -18
- package/dist/models/RightsizingReportSummary.d.ts +6 -6
- package/dist/models/RightsizingReportSummary.js +18 -18
- package/dist/models/StartInspectionRequest.d.ts +8 -1
- package/dist/models/StartInspectionRequest.js +5 -0
- package/dist/models/UpdateGroupRequest.d.ts +0 -6
- package/dist/models/UpdateGroupRequest.js +0 -2
- package/dist/models/UpdateLabelVMsRequest.d.ts +38 -0
- package/dist/models/UpdateLabelVMsRequest.js +50 -0
- package/dist/models/VMFilterOptionsResponse.d.ts +50 -0
- package/dist/models/VMFilterOptionsResponse.js +62 -0
- package/dist/models/VMLabelsResponse.d.ts +38 -0
- package/dist/models/VMLabelsResponse.js +54 -0
- package/dist/models/VirtualMachine.d.ts +18 -6
- package/dist/models/VirtualMachine.js +14 -10
- package/dist/models/VirtualMachineDetail.d.ts +19 -0
- package/dist/models/VirtualMachineDetail.js +7 -0
- package/dist/models/VirtualMachineUpdateRequest.d.ts +38 -0
- package/dist/models/VirtualMachineUpdateRequest.js +50 -0
- package/dist/models/VmUtilizationDetails.d.ts +12 -12
- package/dist/models/VmUtilizationDetails.js +36 -36
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/docs/AgentStatus.md +2 -2
- package/docs/ClusterFeatures.md +38 -0
- package/docs/ClusterUtilization.md +46 -0
- package/docs/CreateGroupRequest.md +0 -2
- package/docs/DefaultApi.md +529 -60
- package/docs/DeleteLabelGloballyResponse.md +36 -0
- package/docs/GetInventory200Response.md +4 -2
- package/docs/Group.md +0 -2
- package/docs/GroupResponse.md +2 -0
- package/docs/InspectorStatus.md +0 -4
- package/docs/Inventory.md +4 -2
- package/docs/InventoryData.md +4 -0
- package/docs/RightsizingClusterListResponse.md +2 -2
- package/docs/RightsizingClusterResponse.md +36 -0
- package/docs/RightsizingClusterUtilization.md +24 -24
- package/docs/RightsizingCollectRequest.md +12 -12
- package/docs/RightsizingMetricStats.md +2 -2
- package/docs/RightsizingReport.md +12 -12
- package/docs/RightsizingReportSummary.md +12 -12
- package/docs/StartInspectionRequest.md +3 -1
- package/docs/UpdateGroupRequest.md +0 -2
- package/docs/UpdateLabelVMsRequest.md +36 -0
- package/docs/VMFilterOptionsResponse.md +40 -0
- package/docs/VMLabelsResponse.md +36 -0
- package/docs/VirtualMachine.md +14 -10
- package/docs/VirtualMachineDetail.md +6 -0
- package/docs/VirtualMachineUpdateRequest.md +36 -0
- package/docs/VmUtilizationDetails.md +24 -24
- package/package.json +1 -1
- package/src/apis/DefaultApi.ts +641 -88
- package/src/models/AgentStatus.ts +4 -4
- package/src/models/ClusterFeatures.ts +94 -0
- package/src/models/ClusterUtilization.ts +120 -0
- package/src/models/CreateGroupRequest.ts +0 -8
- package/src/models/DeleteLabelGloballyResponse.ts +75 -0
- package/src/models/Group.ts +0 -8
- package/src/models/GroupResponse.ts +15 -0
- package/src/models/InspectorStatus.ts +1 -28
- package/src/models/Inventory.ts +12 -4
- package/src/models/InventoryData.ts +30 -0
- package/src/models/RightsizingClusterListResponse.ts +4 -4
- package/src/models/RightsizingClusterResponse.ts +83 -0
- package/src/models/RightsizingClusterUtilization.ts +48 -48
- package/src/models/RightsizingCollectRequest.ts +18 -18
- package/src/models/RightsizingMetricStats.ts +4 -4
- package/src/models/RightsizingReport.ts +24 -24
- package/src/models/RightsizingReportSummary.ts +24 -24
- package/src/models/StartInspectionRequest.ts +18 -1
- package/src/models/UpdateGroupRequest.ts +0 -8
- package/src/models/UpdateLabelVMsRequest.ts +73 -0
- package/src/models/VMFilterOptionsResponse.ts +93 -0
- package/src/models/VMLabelsResponse.ts +75 -0
- package/src/models/VirtualMachine.ts +32 -16
- package/src/models/VirtualMachineDetail.ts +31 -0
- package/src/models/VirtualMachineUpdateRequest.ts +73 -0
- package/src/models/VmUtilizationDetails.ts +48 -48
- package/src/models/index.ts +8 -0
package/docs/DefaultApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
7
7
|
| [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /groups | Create a new group |
|
|
8
8
|
| [**deleteForecasterRun**](DefaultApi.md#deleteforecasterrun) | **DELETE** /forecaster/runs/{id} | Delete a benchmark run |
|
|
9
9
|
| [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /groups/{id} | Delete group |
|
|
10
|
+
| [**deleteLabelGlobally**](DefaultApi.md#deletelabelglobally) | **DELETE** /vms/labels/{label} | Delete label from all VMs |
|
|
10
11
|
| [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
|
|
11
12
|
| [**getCollectorStatus**](DefaultApi.md#getcollectorstatus) | **GET** /collector | Get collector status |
|
|
12
13
|
| [**getForecasterDatastores**](DefaultApi.md#getforecasterdatastores) | **POST** /forecaster/datastores | List available datastores |
|
|
@@ -18,17 +19,20 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
18
19
|
| [**getInspectorVddkStatus**](DefaultApi.md#getinspectorvddkstatus) | **GET** /inspector/vddk | Get VDDK status |
|
|
19
20
|
| [**getInventory**](DefaultApi.md#getinventory) | **GET** /inventory | Get collected inventory |
|
|
20
21
|
| [**getLatestRightsizingClusters**](DefaultApi.md#getlatestrightsizingclusters) | **GET** /cluster_rightsizing | Get cluster-level utilization aggregates for the latest completed report |
|
|
21
|
-
| [**getRightsizingReport**](DefaultApi.md#getrightsizingreport) | **GET** /rightsizing/{
|
|
22
|
+
| [**getRightsizingReport**](DefaultApi.md#getrightsizingreport) | **GET** /rightsizing/{report_id} | Get a specific rightsizing report with full VM metrics |
|
|
23
|
+
| [**getRightsizingReportCluster**](DefaultApi.md#getrightsizingreportcluster) | **GET** /rightsizing/{report_id}/clusters/{cluster_id} | Get utilization for a specific cluster from a specific report |
|
|
22
24
|
| [**getRightsizingReportClusters**](DefaultApi.md#getrightsizingreportclusters) | **GET** /cluster_rightsizing/{report_id} | Get cluster-level utilization aggregates for a specific report |
|
|
23
25
|
| [**getVM**](DefaultApi.md#getvm) | **GET** /vms/{id} | Get details about a vm |
|
|
26
|
+
| [**getVMLabels**](DefaultApi.md#getvmlabels) | **GET** /vms/labels | Get all distinct labels in use across VMs |
|
|
24
27
|
| [**getVMUtilization**](DefaultApi.md#getvmutilization) | **GET** /vms/{id}/utilization | Get utilization breakdown for a specific VM |
|
|
25
28
|
| [**getVMs**](DefaultApi.md#getvms) | **GET** /vms | Get list of VMs with filtering and pagination |
|
|
29
|
+
| [**getVMsFilterOptions**](DefaultApi.md#getvmsfilteroptions) | **GET** /vms/filter-options | Get distinct filter option values for VMs |
|
|
26
30
|
| [**getVersion**](DefaultApi.md#getversion) | **GET** /version | Get agent version information |
|
|
27
31
|
| [**listGroups**](DefaultApi.md#listgroups) | **GET** /groups | List all groups |
|
|
32
|
+
| [**listRightsizingReportClusters**](DefaultApi.md#listrightsizingreportclusters) | **GET** /rightsizing/{report_id}/clusters | Get cluster-level utilization aggregates for a specific report |
|
|
28
33
|
| [**listRightsizingReports**](DefaultApi.md#listrightsizingreports) | **GET** /rightsizing | List all rightsizing reports |
|
|
29
34
|
| [**postForecasterPairCapabilities**](DefaultApi.md#postforecasterpaircapabilities) | **POST** /forecaster/capabilities | Compute pair capabilities |
|
|
30
35
|
| [**putForecasterCredentials**](DefaultApi.md#putforecastercredentials) | **PUT** /forecaster/credentials | Verify vCenter credentials and permissions |
|
|
31
|
-
| [**putInspectorCredentials**](DefaultApi.md#putinspectorcredentials) | **PUT** /inspector/credentials | Set or replace inspector credentials |
|
|
32
36
|
| [**putInspectorVddk**](DefaultApi.md#putinspectorvddk) | **PUT** /inspector/vddk | Upload VDDK tarball |
|
|
33
37
|
| [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspection | Remove VirtualMachine from inspection queue |
|
|
34
38
|
| [**setAgentMode**](DefaultApi.md#setagentmode) | **POST** /agent | Change agent mode |
|
|
@@ -41,6 +45,9 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
41
45
|
| [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /inspector | Stop inspector entirely |
|
|
42
46
|
| [**triggerRightsizingCollection**](DefaultApi.md#triggerrightsizingcollection) | **POST** /rightsizing | Trigger rightsizing metrics collection |
|
|
43
47
|
| [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /groups/{id} | Update group |
|
|
48
|
+
| [**updateLabelVMs**](DefaultApi.md#updatelabelvmsoperation) | **PATCH** /vms/labels/{label} | Modify label VM membership (add/remove label to/from VMs) |
|
|
49
|
+
| [**updateVM**](DefaultApi.md#updatevm) | **PATCH** /vms/{id} | Update VM properties |
|
|
50
|
+
| [**validateInspectorCredentials**](DefaultApi.md#validateinspectorcredentials) | **POST** /inspector/credentials | Validate vCenter credentials for inspector |
|
|
44
51
|
|
|
45
52
|
|
|
46
53
|
|
|
@@ -245,6 +252,73 @@ No authorization required
|
|
|
245
252
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
246
253
|
|
|
247
254
|
|
|
255
|
+
## deleteLabelGlobally
|
|
256
|
+
|
|
257
|
+
> DeleteLabelGloballyResponse deleteLabelGlobally(label)
|
|
258
|
+
|
|
259
|
+
Delete label from all VMs
|
|
260
|
+
|
|
261
|
+
### Example
|
|
262
|
+
|
|
263
|
+
```ts
|
|
264
|
+
import {
|
|
265
|
+
Configuration,
|
|
266
|
+
DefaultApi,
|
|
267
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
268
|
+
import type { DeleteLabelGloballyRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
269
|
+
|
|
270
|
+
async function example() {
|
|
271
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
272
|
+
const api = new DefaultApi();
|
|
273
|
+
|
|
274
|
+
const body = {
|
|
275
|
+
// string | The label to remove from all VMs
|
|
276
|
+
label: label_example,
|
|
277
|
+
} satisfies DeleteLabelGloballyRequest;
|
|
278
|
+
|
|
279
|
+
try {
|
|
280
|
+
const data = await api.deleteLabelGlobally(body);
|
|
281
|
+
console.log(data);
|
|
282
|
+
} catch (error) {
|
|
283
|
+
console.error(error);
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
// Run the test
|
|
288
|
+
example().catch(console.error);
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### Parameters
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
| Name | Type | Description | Notes |
|
|
295
|
+
|------------- | ------------- | ------------- | -------------|
|
|
296
|
+
| **label** | `string` | The label to remove from all VMs | [Defaults to `undefined`] |
|
|
297
|
+
|
|
298
|
+
### Return type
|
|
299
|
+
|
|
300
|
+
[**DeleteLabelGloballyResponse**](DeleteLabelGloballyResponse.md)
|
|
301
|
+
|
|
302
|
+
### Authorization
|
|
303
|
+
|
|
304
|
+
No authorization required
|
|
305
|
+
|
|
306
|
+
### HTTP request headers
|
|
307
|
+
|
|
308
|
+
- **Content-Type**: Not defined
|
|
309
|
+
- **Accept**: `application/json`
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
### HTTP response details
|
|
313
|
+
| Status code | Description | Response headers |
|
|
314
|
+
|-------------|-------------|------------------|
|
|
315
|
+
| **200** | Label removed globally | - |
|
|
316
|
+
| **400** | Invalid label parameter | - |
|
|
317
|
+
| **500** | Internal server error | - |
|
|
318
|
+
|
|
319
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
320
|
+
|
|
321
|
+
|
|
248
322
|
## getAgentStatus
|
|
249
323
|
|
|
250
324
|
> AgentStatus getAgentStatus()
|
|
@@ -703,7 +777,7 @@ No authorization required
|
|
|
703
777
|
|
|
704
778
|
## getInspectorStatus
|
|
705
779
|
|
|
706
|
-
> InspectorStatus getInspectorStatus(includeVddk
|
|
780
|
+
> InspectorStatus getInspectorStatus(includeVddk)
|
|
707
781
|
|
|
708
782
|
Get inspector status
|
|
709
783
|
|
|
@@ -723,8 +797,6 @@ async function example() {
|
|
|
723
797
|
const body = {
|
|
724
798
|
// boolean | If true, include uploaded VDDK metadata (`version`, `md5`) when present. omitted if VDDK was never uploaded. (optional)
|
|
725
799
|
includeVddk: true,
|
|
726
|
-
// boolean | If true, include configured vCenter URL and username (password is never returned). omitted if was never set. (optional)
|
|
727
|
-
includeCredentials: true,
|
|
728
800
|
} satisfies GetInspectorStatusRequest;
|
|
729
801
|
|
|
730
802
|
try {
|
|
@@ -745,7 +817,6 @@ example().catch(console.error);
|
|
|
745
817
|
| Name | Type | Description | Notes |
|
|
746
818
|
|------------- | ------------- | ------------- | -------------|
|
|
747
819
|
| **includeVddk** | `boolean` | If true, include uploaded VDDK metadata (`version`, `md5`) when present. omitted if VDDK was never uploaded. | [Optional] [Defaults to `false`] |
|
|
748
|
-
| **includeCredentials** | `boolean` | If true, include configured vCenter URL and username (password is never returned). omitted if was never set. | [Optional] [Defaults to `false`] |
|
|
749
820
|
|
|
750
821
|
### Return type
|
|
751
822
|
|
|
@@ -968,7 +1039,7 @@ No authorization required
|
|
|
968
1039
|
|
|
969
1040
|
## getRightsizingReport
|
|
970
1041
|
|
|
971
|
-
> RightsizingReport getRightsizingReport(
|
|
1042
|
+
> RightsizingReport getRightsizingReport(reportId)
|
|
972
1043
|
|
|
973
1044
|
Get a specific rightsizing report with full VM metrics
|
|
974
1045
|
|
|
@@ -987,7 +1058,7 @@ async function example() {
|
|
|
987
1058
|
|
|
988
1059
|
const body = {
|
|
989
1060
|
// string | Report UUID
|
|
990
|
-
|
|
1061
|
+
reportId: reportId_example,
|
|
991
1062
|
} satisfies GetRightsizingReportRequest;
|
|
992
1063
|
|
|
993
1064
|
try {
|
|
@@ -1007,7 +1078,7 @@ example().catch(console.error);
|
|
|
1007
1078
|
|
|
1008
1079
|
| Name | Type | Description | Notes |
|
|
1009
1080
|
|------------- | ------------- | ------------- | -------------|
|
|
1010
|
-
| **
|
|
1081
|
+
| **reportId** | `string` | Report UUID | [Defaults to `undefined`] |
|
|
1011
1082
|
|
|
1012
1083
|
### Return type
|
|
1013
1084
|
|
|
@@ -1033,6 +1104,76 @@ No authorization required
|
|
|
1033
1104
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1034
1105
|
|
|
1035
1106
|
|
|
1107
|
+
## getRightsizingReportCluster
|
|
1108
|
+
|
|
1109
|
+
> RightsizingClusterResponse getRightsizingReportCluster(reportId, clusterId)
|
|
1110
|
+
|
|
1111
|
+
Get utilization for a specific cluster from a specific report
|
|
1112
|
+
|
|
1113
|
+
### Example
|
|
1114
|
+
|
|
1115
|
+
```ts
|
|
1116
|
+
import {
|
|
1117
|
+
Configuration,
|
|
1118
|
+
DefaultApi,
|
|
1119
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1120
|
+
import type { GetRightsizingReportClusterRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1121
|
+
|
|
1122
|
+
async function example() {
|
|
1123
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1124
|
+
const api = new DefaultApi();
|
|
1125
|
+
|
|
1126
|
+
const body = {
|
|
1127
|
+
// string | Rightsizing report UUID
|
|
1128
|
+
reportId: reportId_example,
|
|
1129
|
+
// string | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\")
|
|
1130
|
+
clusterId: clusterId_example,
|
|
1131
|
+
} satisfies GetRightsizingReportClusterRequest;
|
|
1132
|
+
|
|
1133
|
+
try {
|
|
1134
|
+
const data = await api.getRightsizingReportCluster(body);
|
|
1135
|
+
console.log(data);
|
|
1136
|
+
} catch (error) {
|
|
1137
|
+
console.error(error);
|
|
1138
|
+
}
|
|
1139
|
+
}
|
|
1140
|
+
|
|
1141
|
+
// Run the test
|
|
1142
|
+
example().catch(console.error);
|
|
1143
|
+
```
|
|
1144
|
+
|
|
1145
|
+
### Parameters
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
| Name | Type | Description | Notes |
|
|
1149
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1150
|
+
| **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
|
|
1151
|
+
| **clusterId** | `string` | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\") | [Defaults to `undefined`] |
|
|
1152
|
+
|
|
1153
|
+
### Return type
|
|
1154
|
+
|
|
1155
|
+
[**RightsizingClusterResponse**](RightsizingClusterResponse.md)
|
|
1156
|
+
|
|
1157
|
+
### Authorization
|
|
1158
|
+
|
|
1159
|
+
No authorization required
|
|
1160
|
+
|
|
1161
|
+
### HTTP request headers
|
|
1162
|
+
|
|
1163
|
+
- **Content-Type**: Not defined
|
|
1164
|
+
- **Accept**: `application/json`
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
### HTTP response details
|
|
1168
|
+
| Status code | Description | Response headers |
|
|
1169
|
+
|-------------|-------------|------------------|
|
|
1170
|
+
| **200** | Cluster utilization data | - |
|
|
1171
|
+
| **404** | Report not found, or cluster not found in report | - |
|
|
1172
|
+
| **500** | Internal server error | - |
|
|
1173
|
+
|
|
1174
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1175
|
+
|
|
1176
|
+
|
|
1036
1177
|
## getRightsizingReportClusters
|
|
1037
1178
|
|
|
1038
1179
|
> RightsizingClusterListResponse getRightsizingReportClusters(reportId, byExpression)
|
|
@@ -1170,6 +1311,64 @@ No authorization required
|
|
|
1170
1311
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1171
1312
|
|
|
1172
1313
|
|
|
1314
|
+
## getVMLabels
|
|
1315
|
+
|
|
1316
|
+
> VMLabelsResponse getVMLabels()
|
|
1317
|
+
|
|
1318
|
+
Get all distinct labels in use across VMs
|
|
1319
|
+
|
|
1320
|
+
### Example
|
|
1321
|
+
|
|
1322
|
+
```ts
|
|
1323
|
+
import {
|
|
1324
|
+
Configuration,
|
|
1325
|
+
DefaultApi,
|
|
1326
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1327
|
+
import type { GetVMLabelsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1328
|
+
|
|
1329
|
+
async function example() {
|
|
1330
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1331
|
+
const api = new DefaultApi();
|
|
1332
|
+
|
|
1333
|
+
try {
|
|
1334
|
+
const data = await api.getVMLabels();
|
|
1335
|
+
console.log(data);
|
|
1336
|
+
} catch (error) {
|
|
1337
|
+
console.error(error);
|
|
1338
|
+
}
|
|
1339
|
+
}
|
|
1340
|
+
|
|
1341
|
+
// Run the test
|
|
1342
|
+
example().catch(console.error);
|
|
1343
|
+
```
|
|
1344
|
+
|
|
1345
|
+
### Parameters
|
|
1346
|
+
|
|
1347
|
+
This endpoint does not need any parameter.
|
|
1348
|
+
|
|
1349
|
+
### Return type
|
|
1350
|
+
|
|
1351
|
+
[**VMLabelsResponse**](VMLabelsResponse.md)
|
|
1352
|
+
|
|
1353
|
+
### Authorization
|
|
1354
|
+
|
|
1355
|
+
No authorization required
|
|
1356
|
+
|
|
1357
|
+
### HTTP request headers
|
|
1358
|
+
|
|
1359
|
+
- **Content-Type**: Not defined
|
|
1360
|
+
- **Accept**: `application/json`
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
### HTTP response details
|
|
1364
|
+
| Status code | Description | Response headers |
|
|
1365
|
+
|-------------|-------------|------------------|
|
|
1366
|
+
| **200** | List of distinct labels | - |
|
|
1367
|
+
| **500** | Internal server error | - |
|
|
1368
|
+
|
|
1369
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1370
|
+
|
|
1371
|
+
|
|
1173
1372
|
## getVMUtilization
|
|
1174
1373
|
|
|
1175
1374
|
> VmUtilizationDetails getVMUtilization(id)
|
|
@@ -1313,6 +1512,64 @@ No authorization required
|
|
|
1313
1512
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1314
1513
|
|
|
1315
1514
|
|
|
1515
|
+
## getVMsFilterOptions
|
|
1516
|
+
|
|
1517
|
+
> VMFilterOptionsResponse getVMsFilterOptions()
|
|
1518
|
+
|
|
1519
|
+
Get distinct filter option values for VMs
|
|
1520
|
+
|
|
1521
|
+
### Example
|
|
1522
|
+
|
|
1523
|
+
```ts
|
|
1524
|
+
import {
|
|
1525
|
+
Configuration,
|
|
1526
|
+
DefaultApi,
|
|
1527
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1528
|
+
import type { GetVMsFilterOptionsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1529
|
+
|
|
1530
|
+
async function example() {
|
|
1531
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1532
|
+
const api = new DefaultApi();
|
|
1533
|
+
|
|
1534
|
+
try {
|
|
1535
|
+
const data = await api.getVMsFilterOptions();
|
|
1536
|
+
console.log(data);
|
|
1537
|
+
} catch (error) {
|
|
1538
|
+
console.error(error);
|
|
1539
|
+
}
|
|
1540
|
+
}
|
|
1541
|
+
|
|
1542
|
+
// Run the test
|
|
1543
|
+
example().catch(console.error);
|
|
1544
|
+
```
|
|
1545
|
+
|
|
1546
|
+
### Parameters
|
|
1547
|
+
|
|
1548
|
+
This endpoint does not need any parameter.
|
|
1549
|
+
|
|
1550
|
+
### Return type
|
|
1551
|
+
|
|
1552
|
+
[**VMFilterOptionsResponse**](VMFilterOptionsResponse.md)
|
|
1553
|
+
|
|
1554
|
+
### Authorization
|
|
1555
|
+
|
|
1556
|
+
No authorization required
|
|
1557
|
+
|
|
1558
|
+
### HTTP request headers
|
|
1559
|
+
|
|
1560
|
+
- **Content-Type**: Not defined
|
|
1561
|
+
- **Accept**: `application/json`
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
### HTTP response details
|
|
1565
|
+
| Status code | Description | Response headers |
|
|
1566
|
+
|-------------|-------------|------------------|
|
|
1567
|
+
| **200** | Filter options | - |
|
|
1568
|
+
| **500** | Internal server error | - |
|
|
1569
|
+
|
|
1570
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1571
|
+
|
|
1572
|
+
|
|
1316
1573
|
## getVersion
|
|
1317
1574
|
|
|
1318
1575
|
> VersionInfo getVersion()
|
|
@@ -1443,11 +1700,11 @@ No authorization required
|
|
|
1443
1700
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1444
1701
|
|
|
1445
1702
|
|
|
1446
|
-
##
|
|
1703
|
+
## listRightsizingReportClusters
|
|
1447
1704
|
|
|
1448
|
-
>
|
|
1705
|
+
> RightsizingClusterListResponse listRightsizingReportClusters(reportId, byExpression)
|
|
1449
1706
|
|
|
1450
|
-
|
|
1707
|
+
Get cluster-level utilization aggregates for a specific report
|
|
1451
1708
|
|
|
1452
1709
|
### Example
|
|
1453
1710
|
|
|
@@ -1456,14 +1713,21 @@ import {
|
|
|
1456
1713
|
Configuration,
|
|
1457
1714
|
DefaultApi,
|
|
1458
1715
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1459
|
-
import type {
|
|
1716
|
+
import type { ListRightsizingReportClustersRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1460
1717
|
|
|
1461
1718
|
async function example() {
|
|
1462
1719
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1463
1720
|
const api = new DefaultApi();
|
|
1464
1721
|
|
|
1722
|
+
const body = {
|
|
1723
|
+
// string | Rightsizing report UUID
|
|
1724
|
+
reportId: reportId_example,
|
|
1725
|
+
// string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
|
|
1726
|
+
byExpression: byExpression_example,
|
|
1727
|
+
} satisfies ListRightsizingReportClustersRequest;
|
|
1728
|
+
|
|
1465
1729
|
try {
|
|
1466
|
-
const data = await api.
|
|
1730
|
+
const data = await api.listRightsizingReportClusters(body);
|
|
1467
1731
|
console.log(data);
|
|
1468
1732
|
} catch (error) {
|
|
1469
1733
|
console.error(error);
|
|
@@ -1476,11 +1740,15 @@ example().catch(console.error);
|
|
|
1476
1740
|
|
|
1477
1741
|
### Parameters
|
|
1478
1742
|
|
|
1479
|
-
|
|
1743
|
+
|
|
1744
|
+
| Name | Type | Description | Notes |
|
|
1745
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1746
|
+
| **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
|
|
1747
|
+
| **byExpression** | `string` | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
|
|
1480
1748
|
|
|
1481
1749
|
### Return type
|
|
1482
1750
|
|
|
1483
|
-
[**
|
|
1751
|
+
[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
|
|
1484
1752
|
|
|
1485
1753
|
### Authorization
|
|
1486
1754
|
|
|
@@ -1495,19 +1763,18 @@ No authorization required
|
|
|
1495
1763
|
### HTTP response details
|
|
1496
1764
|
| Status code | Description | Response headers |
|
|
1497
1765
|
|-------------|-------------|------------------|
|
|
1498
|
-
| **200** |
|
|
1766
|
+
| **200** | Cluster utilization aggregates | - |
|
|
1767
|
+
| **404** | Report not found | - |
|
|
1499
1768
|
| **500** | Internal server error | - |
|
|
1500
1769
|
|
|
1501
1770
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1502
1771
|
|
|
1503
1772
|
|
|
1504
|
-
##
|
|
1505
|
-
|
|
1506
|
-
> Array<PairCapability> postForecasterPairCapabilities(pairCapabilityRequest)
|
|
1773
|
+
## listRightsizingReports
|
|
1507
1774
|
|
|
1508
|
-
|
|
1775
|
+
> RightsizingReportListResponse listRightsizingReports()
|
|
1509
1776
|
|
|
1510
|
-
|
|
1777
|
+
List all rightsizing reports
|
|
1511
1778
|
|
|
1512
1779
|
### Example
|
|
1513
1780
|
|
|
@@ -1516,19 +1783,14 @@ import {
|
|
|
1516
1783
|
Configuration,
|
|
1517
1784
|
DefaultApi,
|
|
1518
1785
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1519
|
-
import type {
|
|
1786
|
+
import type { ListRightsizingReportsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1520
1787
|
|
|
1521
1788
|
async function example() {
|
|
1522
1789
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1523
1790
|
const api = new DefaultApi();
|
|
1524
1791
|
|
|
1525
|
-
const body = {
|
|
1526
|
-
// PairCapabilityRequest
|
|
1527
|
-
pairCapabilityRequest: ...,
|
|
1528
|
-
} satisfies PostForecasterPairCapabilitiesRequest;
|
|
1529
|
-
|
|
1530
1792
|
try {
|
|
1531
|
-
const data = await api.
|
|
1793
|
+
const data = await api.listRightsizingReports();
|
|
1532
1794
|
console.log(data);
|
|
1533
1795
|
} catch (error) {
|
|
1534
1796
|
console.error(error);
|
|
@@ -1541,14 +1803,11 @@ example().catch(console.error);
|
|
|
1541
1803
|
|
|
1542
1804
|
### Parameters
|
|
1543
1805
|
|
|
1544
|
-
|
|
1545
|
-
| Name | Type | Description | Notes |
|
|
1546
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1547
|
-
| **pairCapabilityRequest** | [PairCapabilityRequest](PairCapabilityRequest.md) | | |
|
|
1806
|
+
This endpoint does not need any parameter.
|
|
1548
1807
|
|
|
1549
1808
|
### Return type
|
|
1550
1809
|
|
|
1551
|
-
[**
|
|
1810
|
+
[**RightsizingReportListResponse**](RightsizingReportListResponse.md)
|
|
1552
1811
|
|
|
1553
1812
|
### Authorization
|
|
1554
1813
|
|
|
@@ -1556,27 +1815,26 @@ No authorization required
|
|
|
1556
1815
|
|
|
1557
1816
|
### HTTP request headers
|
|
1558
1817
|
|
|
1559
|
-
- **Content-Type**:
|
|
1818
|
+
- **Content-Type**: Not defined
|
|
1560
1819
|
- **Accept**: `application/json`
|
|
1561
1820
|
|
|
1562
1821
|
|
|
1563
1822
|
### HTTP response details
|
|
1564
1823
|
| Status code | Description | Response headers |
|
|
1565
1824
|
|-------------|-------------|------------------|
|
|
1566
|
-
| **200** |
|
|
1567
|
-
| **400** | Datastore not found | - |
|
|
1825
|
+
| **200** | List of rightsizing reports | - |
|
|
1568
1826
|
| **500** | Internal server error | - |
|
|
1569
1827
|
|
|
1570
1828
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1571
1829
|
|
|
1572
1830
|
|
|
1573
|
-
##
|
|
1831
|
+
## postForecasterPairCapabilities
|
|
1574
1832
|
|
|
1575
|
-
>
|
|
1833
|
+
> Array<PairCapability> postForecasterPairCapabilities(pairCapabilityRequest)
|
|
1576
1834
|
|
|
1577
|
-
|
|
1835
|
+
Compute pair capabilities
|
|
1578
1836
|
|
|
1579
|
-
|
|
1837
|
+
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.
|
|
1580
1838
|
|
|
1581
1839
|
### Example
|
|
1582
1840
|
|
|
@@ -1585,19 +1843,19 @@ import {
|
|
|
1585
1843
|
Configuration,
|
|
1586
1844
|
DefaultApi,
|
|
1587
1845
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1588
|
-
import type {
|
|
1846
|
+
import type { PostForecasterPairCapabilitiesRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1589
1847
|
|
|
1590
1848
|
async function example() {
|
|
1591
1849
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1592
1850
|
const api = new DefaultApi();
|
|
1593
1851
|
|
|
1594
1852
|
const body = {
|
|
1595
|
-
//
|
|
1596
|
-
|
|
1597
|
-
} satisfies
|
|
1853
|
+
// PairCapabilityRequest
|
|
1854
|
+
pairCapabilityRequest: ...,
|
|
1855
|
+
} satisfies PostForecasterPairCapabilitiesRequest;
|
|
1598
1856
|
|
|
1599
1857
|
try {
|
|
1600
|
-
const data = await api.
|
|
1858
|
+
const data = await api.postForecasterPairCapabilities(body);
|
|
1601
1859
|
console.log(data);
|
|
1602
1860
|
} catch (error) {
|
|
1603
1861
|
console.error(error);
|
|
@@ -1613,11 +1871,11 @@ example().catch(console.error);
|
|
|
1613
1871
|
|
|
1614
1872
|
| Name | Type | Description | Notes |
|
|
1615
1873
|
|------------- | ------------- | ------------- | -------------|
|
|
1616
|
-
| **
|
|
1874
|
+
| **pairCapabilityRequest** | [PairCapabilityRequest](PairCapabilityRequest.md) | | |
|
|
1617
1875
|
|
|
1618
1876
|
### Return type
|
|
1619
1877
|
|
|
1620
|
-
|
|
1878
|
+
[**Array<PairCapability>**](PairCapability.md)
|
|
1621
1879
|
|
|
1622
1880
|
### Authorization
|
|
1623
1881
|
|
|
@@ -1632,19 +1890,20 @@ No authorization required
|
|
|
1632
1890
|
### HTTP response details
|
|
1633
1891
|
| Status code | Description | Response headers |
|
|
1634
1892
|
|-------------|-------------|------------------|
|
|
1635
|
-
| **200** |
|
|
1636
|
-
| **400** |
|
|
1637
|
-
| **403** | Authentication succeeded but user lacks required privileges | - |
|
|
1893
|
+
| **200** | Capabilities per pair | - |
|
|
1894
|
+
| **400** | Datastore not found | - |
|
|
1638
1895
|
| **500** | Internal server error | - |
|
|
1639
1896
|
|
|
1640
1897
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1641
1898
|
|
|
1642
1899
|
|
|
1643
|
-
##
|
|
1900
|
+
## putForecasterCredentials
|
|
1644
1901
|
|
|
1645
|
-
>
|
|
1902
|
+
> putForecasterCredentials(vcenterCredentials)
|
|
1646
1903
|
|
|
1647
|
-
|
|
1904
|
+
Verify vCenter credentials and permissions
|
|
1905
|
+
|
|
1906
|
+
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.
|
|
1648
1907
|
|
|
1649
1908
|
### Example
|
|
1650
1909
|
|
|
@@ -1653,7 +1912,7 @@ import {
|
|
|
1653
1912
|
Configuration,
|
|
1654
1913
|
DefaultApi,
|
|
1655
1914
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1656
|
-
import type {
|
|
1915
|
+
import type { PutForecasterCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1657
1916
|
|
|
1658
1917
|
async function example() {
|
|
1659
1918
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
@@ -1662,10 +1921,10 @@ async function example() {
|
|
|
1662
1921
|
const body = {
|
|
1663
1922
|
// VcenterCredentials
|
|
1664
1923
|
vcenterCredentials: ...,
|
|
1665
|
-
} satisfies
|
|
1924
|
+
} satisfies PutForecasterCredentialsRequest;
|
|
1666
1925
|
|
|
1667
1926
|
try {
|
|
1668
|
-
const data = await api.
|
|
1927
|
+
const data = await api.putForecasterCredentials(body);
|
|
1669
1928
|
console.log(data);
|
|
1670
1929
|
} catch (error) {
|
|
1671
1930
|
console.error(error);
|
|
@@ -1694,14 +1953,15 @@ No authorization required
|
|
|
1694
1953
|
### HTTP request headers
|
|
1695
1954
|
|
|
1696
1955
|
- **Content-Type**: `application/json`
|
|
1697
|
-
- **Accept**:
|
|
1956
|
+
- **Accept**: `application/json`
|
|
1698
1957
|
|
|
1699
1958
|
|
|
1700
1959
|
### HTTP response details
|
|
1701
1960
|
| Status code | Description | Response headers |
|
|
1702
1961
|
|-------------|-------------|------------------|
|
|
1703
|
-
| **200** | Credentials
|
|
1704
|
-
| **400** |
|
|
1962
|
+
| **200** | Credentials valid and all required privileges are granted | - |
|
|
1963
|
+
| **400** | Invalid credentials or unreachable vCenter | - |
|
|
1964
|
+
| **403** | Authentication succeeded but user lacks required privileges | - |
|
|
1705
1965
|
| **500** | Internal server error | - |
|
|
1706
1966
|
|
|
1707
1967
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -2503,3 +2763,212 @@ No authorization required
|
|
|
2503
2763
|
|
|
2504
2764
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2505
2765
|
|
|
2766
|
+
|
|
2767
|
+
## updateLabelVMs
|
|
2768
|
+
|
|
2769
|
+
> updateLabelVMs(label, updateLabelVMsRequest)
|
|
2770
|
+
|
|
2771
|
+
Modify label VM membership (add/remove label to/from VMs)
|
|
2772
|
+
|
|
2773
|
+
### Example
|
|
2774
|
+
|
|
2775
|
+
```ts
|
|
2776
|
+
import {
|
|
2777
|
+
Configuration,
|
|
2778
|
+
DefaultApi,
|
|
2779
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2780
|
+
import type { UpdateLabelVMsOperationRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2781
|
+
|
|
2782
|
+
async function example() {
|
|
2783
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2784
|
+
const api = new DefaultApi();
|
|
2785
|
+
|
|
2786
|
+
const body = {
|
|
2787
|
+
// string | The label to modify
|
|
2788
|
+
label: label_example,
|
|
2789
|
+
// UpdateLabelVMsRequest
|
|
2790
|
+
updateLabelVMsRequest: ...,
|
|
2791
|
+
} satisfies UpdateLabelVMsOperationRequest;
|
|
2792
|
+
|
|
2793
|
+
try {
|
|
2794
|
+
const data = await api.updateLabelVMs(body);
|
|
2795
|
+
console.log(data);
|
|
2796
|
+
} catch (error) {
|
|
2797
|
+
console.error(error);
|
|
2798
|
+
}
|
|
2799
|
+
}
|
|
2800
|
+
|
|
2801
|
+
// Run the test
|
|
2802
|
+
example().catch(console.error);
|
|
2803
|
+
```
|
|
2804
|
+
|
|
2805
|
+
### Parameters
|
|
2806
|
+
|
|
2807
|
+
|
|
2808
|
+
| Name | Type | Description | Notes |
|
|
2809
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2810
|
+
| **label** | `string` | The label to modify | [Defaults to `undefined`] |
|
|
2811
|
+
| **updateLabelVMsRequest** | [UpdateLabelVMsRequest](UpdateLabelVMsRequest.md) | | |
|
|
2812
|
+
|
|
2813
|
+
### Return type
|
|
2814
|
+
|
|
2815
|
+
`void` (Empty response body)
|
|
2816
|
+
|
|
2817
|
+
### Authorization
|
|
2818
|
+
|
|
2819
|
+
No authorization required
|
|
2820
|
+
|
|
2821
|
+
### HTTP request headers
|
|
2822
|
+
|
|
2823
|
+
- **Content-Type**: `application/json`
|
|
2824
|
+
- **Accept**: Not defined
|
|
2825
|
+
|
|
2826
|
+
|
|
2827
|
+
### HTTP response details
|
|
2828
|
+
| Status code | Description | Response headers |
|
|
2829
|
+
|-------------|-------------|------------------|
|
|
2830
|
+
| **200** | Label operation completed successfully (all VMs updated atomically) | - |
|
|
2831
|
+
| **400** | Invalid request | - |
|
|
2832
|
+
| **404** | One or more VMs not found (no changes made) | - |
|
|
2833
|
+
| **500** | Internal server error | - |
|
|
2834
|
+
|
|
2835
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2836
|
+
|
|
2837
|
+
|
|
2838
|
+
## updateVM
|
|
2839
|
+
|
|
2840
|
+
> updateVM(id, virtualMachineUpdateRequest)
|
|
2841
|
+
|
|
2842
|
+
Update VM properties
|
|
2843
|
+
|
|
2844
|
+
### Example
|
|
2845
|
+
|
|
2846
|
+
```ts
|
|
2847
|
+
import {
|
|
2848
|
+
Configuration,
|
|
2849
|
+
DefaultApi,
|
|
2850
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2851
|
+
import type { UpdateVMRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2852
|
+
|
|
2853
|
+
async function example() {
|
|
2854
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2855
|
+
const api = new DefaultApi();
|
|
2856
|
+
|
|
2857
|
+
const body = {
|
|
2858
|
+
// string | VirtualMachine id
|
|
2859
|
+
id: id_example,
|
|
2860
|
+
// VirtualMachineUpdateRequest
|
|
2861
|
+
virtualMachineUpdateRequest: ...,
|
|
2862
|
+
} satisfies UpdateVMRequest;
|
|
2863
|
+
|
|
2864
|
+
try {
|
|
2865
|
+
const data = await api.updateVM(body);
|
|
2866
|
+
console.log(data);
|
|
2867
|
+
} catch (error) {
|
|
2868
|
+
console.error(error);
|
|
2869
|
+
}
|
|
2870
|
+
}
|
|
2871
|
+
|
|
2872
|
+
// Run the test
|
|
2873
|
+
example().catch(console.error);
|
|
2874
|
+
```
|
|
2875
|
+
|
|
2876
|
+
### Parameters
|
|
2877
|
+
|
|
2878
|
+
|
|
2879
|
+
| Name | Type | Description | Notes |
|
|
2880
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2881
|
+
| **id** | `string` | VirtualMachine id | [Defaults to `undefined`] |
|
|
2882
|
+
| **virtualMachineUpdateRequest** | [VirtualMachineUpdateRequest](VirtualMachineUpdateRequest.md) | | |
|
|
2883
|
+
|
|
2884
|
+
### Return type
|
|
2885
|
+
|
|
2886
|
+
`void` (Empty response body)
|
|
2887
|
+
|
|
2888
|
+
### Authorization
|
|
2889
|
+
|
|
2890
|
+
No authorization required
|
|
2891
|
+
|
|
2892
|
+
### HTTP request headers
|
|
2893
|
+
|
|
2894
|
+
- **Content-Type**: `application/json`
|
|
2895
|
+
- **Accept**: Not defined
|
|
2896
|
+
|
|
2897
|
+
|
|
2898
|
+
### HTTP response details
|
|
2899
|
+
| Status code | Description | Response headers |
|
|
2900
|
+
|-------------|-------------|------------------|
|
|
2901
|
+
| **200** | VM updated successfully | - |
|
|
2902
|
+
| **400** | Invalid request | - |
|
|
2903
|
+
| **404** | VM not found | - |
|
|
2904
|
+
| **500** | Internal server error | - |
|
|
2905
|
+
|
|
2906
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2907
|
+
|
|
2908
|
+
|
|
2909
|
+
## validateInspectorCredentials
|
|
2910
|
+
|
|
2911
|
+
> validateInspectorCredentials(vcenterCredentials)
|
|
2912
|
+
|
|
2913
|
+
Validate vCenter credentials for inspector
|
|
2914
|
+
|
|
2915
|
+
### Example
|
|
2916
|
+
|
|
2917
|
+
```ts
|
|
2918
|
+
import {
|
|
2919
|
+
Configuration,
|
|
2920
|
+
DefaultApi,
|
|
2921
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2922
|
+
import type { ValidateInspectorCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2923
|
+
|
|
2924
|
+
async function example() {
|
|
2925
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2926
|
+
const api = new DefaultApi();
|
|
2927
|
+
|
|
2928
|
+
const body = {
|
|
2929
|
+
// VcenterCredentials
|
|
2930
|
+
vcenterCredentials: ...,
|
|
2931
|
+
} satisfies ValidateInspectorCredentialsRequest;
|
|
2932
|
+
|
|
2933
|
+
try {
|
|
2934
|
+
const data = await api.validateInspectorCredentials(body);
|
|
2935
|
+
console.log(data);
|
|
2936
|
+
} catch (error) {
|
|
2937
|
+
console.error(error);
|
|
2938
|
+
}
|
|
2939
|
+
}
|
|
2940
|
+
|
|
2941
|
+
// Run the test
|
|
2942
|
+
example().catch(console.error);
|
|
2943
|
+
```
|
|
2944
|
+
|
|
2945
|
+
### Parameters
|
|
2946
|
+
|
|
2947
|
+
|
|
2948
|
+
| Name | Type | Description | Notes |
|
|
2949
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2950
|
+
| **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
|
|
2951
|
+
|
|
2952
|
+
### Return type
|
|
2953
|
+
|
|
2954
|
+
`void` (Empty response body)
|
|
2955
|
+
|
|
2956
|
+
### Authorization
|
|
2957
|
+
|
|
2958
|
+
No authorization required
|
|
2959
|
+
|
|
2960
|
+
### HTTP request headers
|
|
2961
|
+
|
|
2962
|
+
- **Content-Type**: `application/json`
|
|
2963
|
+
- **Accept**: Not defined
|
|
2964
|
+
|
|
2965
|
+
|
|
2966
|
+
### HTTP response details
|
|
2967
|
+
| Status code | Description | Response headers |
|
|
2968
|
+
|-------------|-------------|------------------|
|
|
2969
|
+
| **200** | Credentials updated successfully | - |
|
|
2970
|
+
| **400** | Bad Credentials | - |
|
|
2971
|
+
| **500** | Internal server error | - |
|
|
2972
|
+
|
|
2973
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2974
|
+
|