@openshift-migration-advisor/agent-sdk 0.8.0 → 0.12.0-4e95135f8529
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 +74 -2
- package/.openapi-generator/VERSION +1 -1
- package/README.md +80 -17
- package/dist/apis/DefaultApi.d.ts +1108 -95
- package/dist/apis/DefaultApi.js +1374 -263
- package/dist/esm/apis/DefaultApi.d.ts +1108 -95
- package/dist/esm/apis/DefaultApi.js +1350 -239
- package/dist/esm/models/AgentStatus.d.ts +1 -1
- package/dist/esm/models/AgentStatus.js +3 -3
- package/dist/esm/models/ApplicationListResponse.d.ts +33 -0
- package/dist/esm/models/ApplicationListResponse.js +44 -0
- package/dist/esm/models/ApplicationOverview.d.ts +51 -0
- package/dist/esm/models/ApplicationOverview.js +56 -0
- package/dist/esm/models/ApplicationVM.d.ts +38 -0
- package/dist/esm/models/ApplicationVM.js +47 -0
- package/dist/esm/models/BenchmarkRun.d.ts +104 -0
- package/dist/esm/models/BenchmarkRun.js +85 -0
- 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/CollectorStartRequest.d.ts +12 -0
- package/dist/esm/models/CollectorStartRequest.js +4 -0
- package/dist/esm/models/CreateGroupRequest.d.ts +0 -6
- package/dist/esm/models/CreateGroupRequest.js +0 -2
- package/dist/esm/models/CredentialStatus.d.ts +38 -0
- package/dist/esm/models/CredentialStatus.js +47 -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/DeleteLabelGloballyResponse.d.ts +38 -0
- package/dist/esm/models/DeleteLabelGloballyResponse.js +47 -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/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 +6 -10
- package/dist/esm/models/InspectorStatus.js +5 -9
- 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/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/RightsizingClusterResponse.d.ts +39 -0
- package/dist/esm/models/RightsizingClusterResponse.js +48 -0
- package/dist/esm/models/RightsizingClusterUtilization.d.ts +112 -0
- package/dist/esm/models/RightsizingClusterUtilization.js +95 -0
- package/dist/esm/models/RightsizingCollectRequest.d.ts +70 -0
- package/dist/esm/models/RightsizingCollectRequest.js +56 -0
- package/dist/esm/models/RightsizingMetricStats.d.ts +62 -0
- package/dist/esm/models/RightsizingMetricStats.js +63 -0
- package/dist/esm/models/RightsizingReport.d.ts +81 -0
- package/dist/esm/models/RightsizingReport.js +76 -0
- package/dist/esm/models/RightsizingReportListResponse.d.ts +39 -0
- package/dist/esm/models/RightsizingReportListResponse.js +48 -0
- package/dist/esm/models/RightsizingReportSummary.d.ts +74 -0
- package/dist/esm/models/RightsizingReportSummary.js +71 -0
- package/dist/esm/models/RightsizingVMReport.d.ts +53 -0
- package/dist/esm/models/RightsizingVMReport.js +57 -0
- package/dist/esm/models/StartInspectionRequest.d.ts +39 -0
- package/dist/esm/models/{InspectorStartRequest.js → StartInspectionRequest.js} +12 -12
- package/dist/esm/models/StopForecasterPair202Response.d.ts +45 -0
- package/dist/esm/models/StopForecasterPair202Response.js +49 -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 +56 -0
- package/dist/esm/models/VMFilterOptionsResponse.js +59 -0
- package/dist/esm/models/VMLabelsResponse.d.ts +38 -0
- package/dist/esm/models/VMLabelsResponse.js +47 -0
- package/dist/esm/models/VMNIC.d.ts +12 -0
- package/dist/esm/models/VMNIC.js +4 -0
- package/dist/esm/models/VMs.d.ts +18 -0
- package/dist/esm/models/VMs.js +4 -0
- package/dist/esm/models/VcenterCredentials.d.ts +12 -0
- package/dist/esm/models/VcenterCredentials.js +4 -0
- package/dist/esm/models/VirtualMachine.d.ts +57 -3
- package/dist/esm/models/VirtualMachine.js +22 -6
- package/dist/esm/models/VirtualMachineDetail.d.ts +22 -3
- package/dist/esm/models/VirtualMachineDetail.js +10 -3
- package/dist/esm/models/VirtualMachineUpdateRequest.d.ts +38 -0
- package/dist/esm/models/VirtualMachineUpdateRequest.js +43 -0
- package/dist/esm/models/VmInspectionConcern.d.ts +44 -0
- package/dist/esm/models/VmInspectionConcern.js +51 -0
- package/dist/esm/models/VmInspectionResults.d.ts +33 -0
- package/dist/esm/models/VmInspectionResults.js +42 -0
- package/dist/esm/models/VmInspectionStatus.d.ts +0 -1
- package/dist/esm/models/VmInspectionStatus.js +1 -2
- package/dist/esm/models/VmUtilizationDetails.d.ts +116 -0
- package/dist/esm/models/VmUtilizationDetails.js +99 -0
- package/dist/esm/models/index.d.ts +37 -1
- package/dist/esm/models/index.js +37 -1
- package/dist/esm/runtime.js +3 -2
- package/dist/models/AgentStatus.d.ts +1 -1
- package/dist/models/AgentStatus.js +3 -3
- package/dist/models/ApplicationListResponse.d.ts +33 -0
- package/dist/models/ApplicationListResponse.js +51 -0
- package/dist/models/ApplicationOverview.d.ts +51 -0
- package/dist/models/ApplicationOverview.js +63 -0
- package/dist/models/ApplicationVM.d.ts +38 -0
- package/dist/models/ApplicationVM.js +54 -0
- package/dist/models/BenchmarkRun.d.ts +104 -0
- package/dist/models/BenchmarkRun.js +92 -0
- 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/CollectorStartRequest.d.ts +12 -0
- package/dist/models/CollectorStartRequest.js +4 -0
- package/dist/models/CreateGroupRequest.d.ts +0 -6
- package/dist/models/CreateGroupRequest.js +0 -2
- package/dist/models/CredentialStatus.d.ts +38 -0
- package/dist/models/CredentialStatus.js +54 -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/DeleteLabelGloballyResponse.d.ts +38 -0
- package/dist/models/DeleteLabelGloballyResponse.js +54 -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/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 +6 -10
- package/dist/models/InspectorStatus.js +5 -9
- 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/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/RightsizingClusterResponse.d.ts +39 -0
- package/dist/models/RightsizingClusterResponse.js +55 -0
- package/dist/models/RightsizingClusterUtilization.d.ts +112 -0
- package/dist/models/RightsizingClusterUtilization.js +102 -0
- package/dist/models/RightsizingCollectRequest.d.ts +70 -0
- package/dist/models/RightsizingCollectRequest.js +63 -0
- package/dist/models/RightsizingMetricStats.d.ts +62 -0
- package/dist/models/RightsizingMetricStats.js +70 -0
- package/dist/models/RightsizingReport.d.ts +81 -0
- package/dist/models/RightsizingReport.js +83 -0
- package/dist/models/RightsizingReportListResponse.d.ts +39 -0
- package/dist/models/RightsizingReportListResponse.js +55 -0
- package/dist/models/RightsizingReportSummary.d.ts +74 -0
- package/dist/models/RightsizingReportSummary.js +78 -0
- package/dist/models/RightsizingVMReport.d.ts +53 -0
- package/dist/models/RightsizingVMReport.js +64 -0
- package/dist/models/StartInspectionRequest.d.ts +39 -0
- package/dist/models/StartInspectionRequest.js +55 -0
- package/dist/models/StopForecasterPair202Response.d.ts +45 -0
- package/dist/models/StopForecasterPair202Response.js +57 -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 +56 -0
- package/dist/models/VMFilterOptionsResponse.js +66 -0
- package/dist/models/VMLabelsResponse.d.ts +38 -0
- package/dist/models/VMLabelsResponse.js +54 -0
- package/dist/models/VMNIC.d.ts +12 -0
- package/dist/models/VMNIC.js +4 -0
- package/dist/models/VMs.d.ts +18 -0
- package/dist/models/VMs.js +4 -0
- package/dist/models/VcenterCredentials.d.ts +12 -0
- package/dist/models/VcenterCredentials.js +4 -0
- package/dist/models/VirtualMachine.d.ts +57 -3
- package/dist/models/VirtualMachine.js +22 -6
- package/dist/models/VirtualMachineDetail.d.ts +22 -3
- package/dist/models/VirtualMachineDetail.js +10 -3
- package/dist/models/VirtualMachineUpdateRequest.d.ts +38 -0
- package/dist/models/VirtualMachineUpdateRequest.js +50 -0
- package/dist/models/VmInspectionConcern.d.ts +44 -0
- package/dist/models/VmInspectionConcern.js +58 -0
- package/dist/models/VmInspectionResults.d.ts +33 -0
- package/dist/models/VmInspectionResults.js +49 -0
- package/dist/models/VmInspectionStatus.d.ts +0 -1
- package/dist/models/VmInspectionStatus.js +1 -2
- package/dist/models/VmUtilizationDetails.d.ts +116 -0
- package/dist/models/VmUtilizationDetails.js +106 -0
- package/dist/models/index.d.ts +37 -1
- package/dist/models/index.js +37 -1
- package/dist/runtime.js +3 -2
- package/docs/AgentStatus.md +2 -2
- package/docs/ApplicationListResponse.md +34 -0
- package/docs/ApplicationOverview.md +40 -0
- package/docs/ApplicationVM.md +36 -0
- package/docs/BenchmarkRun.md +58 -0
- package/docs/ClusterFeatures.md +38 -0
- package/docs/ClusterUtilization.md +46 -0
- package/docs/CollectorStartRequest.md +4 -0
- package/docs/CreateGroupRequest.md +0 -2
- package/docs/CredentialStatus.md +36 -0
- package/docs/DatastoreDetail.md +50 -0
- package/docs/DatastorePair.md +40 -0
- package/docs/DefaultApi.md +2126 -310
- package/docs/DeleteLabelGloballyResponse.md +36 -0
- 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/GetInventory200Response.md +4 -2
- package/docs/Group.md +0 -2
- package/docs/GroupResponse.md +2 -0
- package/docs/InspectorStatus.md +2 -2
- package/docs/Inventory.md +4 -2
- package/docs/InventoryData.md +4 -0
- package/docs/PairCapability.md +40 -0
- package/docs/PairCapabilityRequest.md +36 -0
- package/docs/PutForecasterCredentials403Response.md +36 -0
- package/docs/RightsizingClusterListResponse.md +36 -0
- package/docs/RightsizingClusterResponse.md +36 -0
- package/docs/RightsizingClusterUtilization.md +60 -0
- package/docs/RightsizingCollectRequest.md +46 -0
- package/docs/RightsizingMetricStats.md +44 -0
- package/docs/RightsizingReport.md +50 -0
- package/docs/RightsizingReportListResponse.md +36 -0
- package/docs/RightsizingReportSummary.md +49 -0
- package/docs/RightsizingVMReport.md +40 -0
- package/docs/{InspectorStartRequest.md → StartInspectionRequest.md} +7 -6
- package/docs/StopForecasterPair202Response.md +36 -0
- package/docs/UpdateGroupRequest.md +0 -2
- package/docs/UpdateLabelVMsRequest.md +36 -0
- package/docs/VMFilterOptionsResponse.md +42 -0
- package/docs/VMLabelsResponse.md +36 -0
- package/docs/VMNIC.md +4 -0
- package/docs/VMs.md +4 -0
- package/docs/VcenterCredentials.md +4 -0
- package/docs/VirtualMachine.md +22 -4
- package/docs/VirtualMachineDetail.md +7 -1
- package/docs/VirtualMachineUpdateRequest.md +36 -0
- package/docs/VmInspectionConcern.md +39 -0
- package/docs/VmInspectionResults.md +35 -0
- package/docs/VmUtilizationDetails.md +62 -0
- package/package.json +1 -1
- package/src/apis/DefaultApi.ts +2580 -491
- package/src/models/AgentStatus.ts +4 -4
- package/src/models/ApplicationListResponse.ts +74 -0
- package/src/models/ApplicationOverview.ts +101 -0
- package/src/models/ApplicationVM.ts +75 -0
- package/src/models/BenchmarkRun.ts +171 -0
- package/src/models/ClusterFeatures.ts +94 -0
- package/src/models/ClusterUtilization.ts +120 -0
- package/src/models/CollectorStartRequest.ts +16 -0
- package/src/models/CreateGroupRequest.ts +0 -8
- package/src/models/CredentialStatus.ts +75 -0
- package/src/models/DatastoreDetail.ts +146 -0
- package/src/models/DatastorePair.ts +92 -0
- package/src/models/DeleteLabelGloballyResponse.ts +75 -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/Group.ts +0 -8
- package/src/models/GroupResponse.ts +15 -0
- package/src/models/InspectorStatus.ts +15 -12
- package/src/models/Inventory.ts +12 -4
- package/src/models/InventoryData.ts +30 -0
- package/src/models/PairCapability.ts +106 -0
- package/src/models/PairCapabilityRequest.ts +89 -0
- package/src/models/PutForecasterCredentials403Response.ts +73 -0
- package/src/models/RightsizingClusterListResponse.ts +83 -0
- package/src/models/RightsizingClusterResponse.ts +83 -0
- package/src/models/RightsizingClusterUtilization.ts +185 -0
- package/src/models/RightsizingCollectRequest.ts +123 -0
- package/src/models/RightsizingMetricStats.ts +111 -0
- package/src/models/RightsizingReport.ts +146 -0
- package/src/models/RightsizingReportListResponse.ts +83 -0
- package/src/models/RightsizingReportSummary.ts +129 -0
- package/src/models/RightsizingVMReport.ts +101 -0
- package/src/models/StartInspectionRequest.ts +83 -0
- package/src/models/StopForecasterPair202Response.ts +83 -0
- package/src/models/UpdateGroupRequest.ts +0 -8
- package/src/models/UpdateLabelVMsRequest.ts +73 -0
- package/src/models/VMFilterOptionsResponse.ts +102 -0
- package/src/models/VMLabelsResponse.ts +75 -0
- package/src/models/VMNIC.ts +16 -0
- package/src/models/VMs.ts +18 -0
- package/src/models/VcenterCredentials.ts +16 -0
- package/src/models/VirtualMachine.ts +79 -8
- package/src/models/VirtualMachineDetail.ts +42 -11
- package/src/models/VirtualMachineUpdateRequest.ts +73 -0
- package/src/models/VmInspectionConcern.ts +84 -0
- package/src/models/VmInspectionResults.ts +73 -0
- package/src/models/VmInspectionStatus.ts +1 -2
- package/src/models/VmUtilizationDetails.ts +192 -0
- package/src/models/index.ts +37 -1
- package/src/runtime.ts +2 -3
- package/dist/esm/models/InspectorStartRequest.d.ts +0 -39
- package/dist/models/InspectorStartRequest.d.ts +0 -39
- package/dist/models/InspectorStartRequest.js +0 -55
- package/src/models/InspectorStartRequest.ts +0 -83
package/docs/DefaultApi.md
CHANGED
|
@@ -4,36 +4,63 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**addVMsToInspection**](DefaultApi.md#addvmstoinspection) | **PATCH** /vms/inspector | Add more VMs to inspection queue |
|
|
8
7
|
| [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /groups | Create a new group |
|
|
8
|
+
| [**deleteCredentials**](DefaultApi.md#deletecredentials) | **DELETE** /credentials | Delete stored credentials |
|
|
9
|
+
| [**deleteForecasterRun**](DefaultApi.md#deleteforecasterrun) | **DELETE** /forecaster/runs/{id} | Delete a benchmark run |
|
|
9
10
|
| [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /groups/{id} | Delete group |
|
|
11
|
+
| [**deleteLabelGlobally**](DefaultApi.md#deletelabelglobally) | **DELETE** /vms/labels/{label} | Delete label from all VMs |
|
|
10
12
|
| [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
|
|
13
|
+
| [**getApplications**](DefaultApi.md#getapplications) | **GET** /applications | List detected applications running on VMs |
|
|
14
|
+
| [**getClusterUtilization**](DefaultApi.md#getclusterutilization) | **GET** /clusters/{cluster_id}/utilization | Get latest cluster utilization by cluster ID |
|
|
11
15
|
| [**getCollectorStatus**](DefaultApi.md#getcollectorstatus) | **GET** /collector | Get collector status |
|
|
16
|
+
| [**getCredentials**](DefaultApi.md#getcredentials) | **GET** /credentials | Get stored credential status |
|
|
17
|
+
| [**getForecasterDatastores**](DefaultApi.md#getforecasterdatastores) | **POST** /forecaster/datastores | List available datastores |
|
|
18
|
+
| [**getForecasterRuns**](DefaultApi.md#getforecasterruns) | **GET** /forecaster/runs | List benchmark runs |
|
|
19
|
+
| [**getForecasterStats**](DefaultApi.md#getforecasterstats) | **GET** /forecaster/stats | Get throughput statistics |
|
|
20
|
+
| [**getForecasterStatus**](DefaultApi.md#getforecasterstatus) | **GET** /forecaster | Poll forecaster status |
|
|
12
21
|
| [**getGroup**](DefaultApi.md#getgroup) | **GET** /groups/{id} | Get group by ID with its VMs |
|
|
13
|
-
| [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /
|
|
22
|
+
| [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /inspector | Get inspector status |
|
|
23
|
+
| [**getInspectorVddkStatus**](DefaultApi.md#getinspectorvddkstatus) | **GET** /inspector/vddk | Get VDDK status |
|
|
14
24
|
| [**getInventory**](DefaultApi.md#getinventory) | **GET** /inventory | Get collected inventory |
|
|
25
|
+
| [**getLatestRightsizingClusters**](DefaultApi.md#getlatestrightsizingclusters) | **GET** /cluster_rightsizing | Get cluster-level utilization aggregates for the latest completed report |
|
|
26
|
+
| [**getRightsizingReport**](DefaultApi.md#getrightsizingreport) | **GET** /rightsizing/{report_id} | Get a specific rightsizing report with full VM metrics |
|
|
27
|
+
| [**getRightsizingReportCluster**](DefaultApi.md#getrightsizingreportcluster) | **GET** /rightsizing/{report_id}/clusters/{cluster_id} | Get utilization for a specific cluster from a specific report |
|
|
28
|
+
| [**getRightsizingReportClusters**](DefaultApi.md#getrightsizingreportclusters) | **GET** /cluster_rightsizing/{report_id} | Get cluster-level utilization aggregates for a specific report |
|
|
15
29
|
| [**getVM**](DefaultApi.md#getvm) | **GET** /vms/{id} | Get details about a vm |
|
|
16
|
-
| [**
|
|
30
|
+
| [**getVMLabels**](DefaultApi.md#getvmlabels) | **GET** /vms/labels | Get all distinct labels in use across VMs |
|
|
31
|
+
| [**getVMUtilization**](DefaultApi.md#getvmutilization) | **GET** /vms/{id}/utilization | Get utilization breakdown for a specific VM |
|
|
17
32
|
| [**getVMs**](DefaultApi.md#getvms) | **GET** /vms | Get list of VMs with filtering and pagination |
|
|
18
|
-
| [**
|
|
33
|
+
| [**getVMsFilterOptions**](DefaultApi.md#getvmsfilteroptions) | **GET** /vms/filter-options | Get distinct filter option values for VMs |
|
|
19
34
|
| [**getVersion**](DefaultApi.md#getversion) | **GET** /version | Get agent version information |
|
|
20
35
|
| [**listGroups**](DefaultApi.md#listgroups) | **GET** /groups | List all groups |
|
|
21
|
-
| [**
|
|
36
|
+
| [**listRightsizingReportClusters**](DefaultApi.md#listrightsizingreportclusters) | **GET** /rightsizing/{report_id}/clusters | Get cluster-level utilization aggregates for a specific report |
|
|
37
|
+
| [**listRightsizingReports**](DefaultApi.md#listrightsizingreports) | **GET** /rightsizing | List all rightsizing reports |
|
|
38
|
+
| [**postForecasterPairCapabilities**](DefaultApi.md#postforecasterpaircapabilities) | **POST** /forecaster/capabilities | Compute pair capabilities |
|
|
39
|
+
| [**putCredentials**](DefaultApi.md#putcredentials) | **PUT** /credentials | Store vCenter credentials |
|
|
40
|
+
| [**putForecasterCredentials**](DefaultApi.md#putforecastercredentials) | **PUT** /forecaster/credentials | Verify vCenter credentials and permissions |
|
|
41
|
+
| [**putInspectorVddk**](DefaultApi.md#putinspectorvddk) | **PUT** /inspector/vddk | Upload VDDK tarball |
|
|
42
|
+
| [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspection | Remove VirtualMachine from inspection queue |
|
|
22
43
|
| [**setAgentMode**](DefaultApi.md#setagentmode) | **POST** /agent | Change agent mode |
|
|
23
44
|
| [**startCollector**](DefaultApi.md#startcollector) | **POST** /collector | Start inventory collection |
|
|
24
|
-
| [**
|
|
45
|
+
| [**startForecaster**](DefaultApi.md#startforecaster) | **POST** /forecaster | Start benchmark |
|
|
46
|
+
| [**startInspection**](DefaultApi.md#startinspectionoperation) | **POST** /inspector | Start inspection for VMs |
|
|
25
47
|
| [**stopCollector**](DefaultApi.md#stopcollector) | **DELETE** /collector | Stop collection |
|
|
26
|
-
| [**
|
|
48
|
+
| [**stopForecaster**](DefaultApi.md#stopforecaster) | **DELETE** /forecaster | Cancel benchmark |
|
|
49
|
+
| [**stopForecasterPair**](DefaultApi.md#stopforecasterpair) | **DELETE** /forecaster/pairs/{name} | Cancel a single pair |
|
|
50
|
+
| [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /inspector | Stop inspector entirely |
|
|
51
|
+
| [**triggerRightsizingCollection**](DefaultApi.md#triggerrightsizingcollection) | **POST** /rightsizing | Trigger rightsizing metrics collection |
|
|
27
52
|
| [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /groups/{id} | Update group |
|
|
28
|
-
| [**
|
|
53
|
+
| [**updateLabelVMs**](DefaultApi.md#updatelabelvmsoperation) | **PATCH** /vms/labels/{label} | Modify label VM membership (add/remove label to/from VMs) |
|
|
54
|
+
| [**updateVM**](DefaultApi.md#updatevm) | **PATCH** /vms/{id} | Update VM properties |
|
|
55
|
+
| [**validateInspectorCredentials**](DefaultApi.md#validateinspectorcredentials) | **POST** /inspector/credentials | Validate vCenter credentials for inspector |
|
|
29
56
|
|
|
30
57
|
|
|
31
58
|
|
|
32
|
-
##
|
|
59
|
+
## createGroup
|
|
33
60
|
|
|
34
|
-
>
|
|
61
|
+
> Group createGroup(createGroupRequest)
|
|
35
62
|
|
|
36
|
-
|
|
63
|
+
Create a new group
|
|
37
64
|
|
|
38
65
|
### Example
|
|
39
66
|
|
|
@@ -42,19 +69,19 @@ import {
|
|
|
42
69
|
Configuration,
|
|
43
70
|
DefaultApi,
|
|
44
71
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
45
|
-
import type {
|
|
72
|
+
import type { CreateGroupOperationRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
46
73
|
|
|
47
74
|
async function example() {
|
|
48
75
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
49
76
|
const api = new DefaultApi();
|
|
50
77
|
|
|
51
78
|
const body = {
|
|
52
|
-
//
|
|
53
|
-
|
|
54
|
-
} satisfies
|
|
79
|
+
// CreateGroupRequest
|
|
80
|
+
createGroupRequest: ...,
|
|
81
|
+
} satisfies CreateGroupOperationRequest;
|
|
55
82
|
|
|
56
83
|
try {
|
|
57
|
-
const data = await api.
|
|
84
|
+
const data = await api.createGroup(body);
|
|
58
85
|
console.log(data);
|
|
59
86
|
} catch (error) {
|
|
60
87
|
console.error(error);
|
|
@@ -70,11 +97,11 @@ example().catch(console.error);
|
|
|
70
97
|
|
|
71
98
|
| Name | Type | Description | Notes |
|
|
72
99
|
|------------- | ------------- | ------------- | -------------|
|
|
73
|
-
| **
|
|
100
|
+
| **createGroupRequest** | [CreateGroupRequest](CreateGroupRequest.md) | | |
|
|
74
101
|
|
|
75
102
|
### Return type
|
|
76
103
|
|
|
77
|
-
[**
|
|
104
|
+
[**Group**](Group.md)
|
|
78
105
|
|
|
79
106
|
### Authorization
|
|
80
107
|
|
|
@@ -89,19 +116,20 @@ No authorization required
|
|
|
89
116
|
### HTTP response details
|
|
90
117
|
| Status code | Description | Response headers |
|
|
91
118
|
|-------------|-------------|------------------|
|
|
92
|
-
| **
|
|
93
|
-
| **400** | Invalid request | - |
|
|
94
|
-
| **404** | Inspector not running | - |
|
|
119
|
+
| **201** | Group created | - |
|
|
120
|
+
| **400** | Invalid request (e.g., invalid filter syntax) | - |
|
|
95
121
|
| **500** | Internal server error | - |
|
|
96
122
|
|
|
97
123
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
98
124
|
|
|
99
125
|
|
|
100
|
-
##
|
|
126
|
+
## deleteCredentials
|
|
101
127
|
|
|
102
|
-
>
|
|
128
|
+
> deleteCredentials()
|
|
103
129
|
|
|
104
|
-
|
|
130
|
+
Delete stored credentials
|
|
131
|
+
|
|
132
|
+
Removes all stored vCenter credentials from the database.
|
|
105
133
|
|
|
106
134
|
### Example
|
|
107
135
|
|
|
@@ -110,19 +138,14 @@ import {
|
|
|
110
138
|
Configuration,
|
|
111
139
|
DefaultApi,
|
|
112
140
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
113
|
-
import type {
|
|
141
|
+
import type { DeleteCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
114
142
|
|
|
115
143
|
async function example() {
|
|
116
144
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
117
145
|
const api = new DefaultApi();
|
|
118
146
|
|
|
119
|
-
const body = {
|
|
120
|
-
// CreateGroupRequest
|
|
121
|
-
createGroupRequest: ...,
|
|
122
|
-
} satisfies CreateGroupOperationRequest;
|
|
123
|
-
|
|
124
147
|
try {
|
|
125
|
-
const data = await api.
|
|
148
|
+
const data = await api.deleteCredentials();
|
|
126
149
|
console.log(data);
|
|
127
150
|
} catch (error) {
|
|
128
151
|
console.error(error);
|
|
@@ -135,14 +158,11 @@ example().catch(console.error);
|
|
|
135
158
|
|
|
136
159
|
### Parameters
|
|
137
160
|
|
|
138
|
-
|
|
139
|
-
| Name | Type | Description | Notes |
|
|
140
|
-
|------------- | ------------- | ------------- | -------------|
|
|
141
|
-
| **createGroupRequest** | [CreateGroupRequest](CreateGroupRequest.md) | | |
|
|
161
|
+
This endpoint does not need any parameter.
|
|
142
162
|
|
|
143
163
|
### Return type
|
|
144
164
|
|
|
145
|
-
|
|
165
|
+
`void` (Empty response body)
|
|
146
166
|
|
|
147
167
|
### Authorization
|
|
148
168
|
|
|
@@ -150,25 +170,24 @@ No authorization required
|
|
|
150
170
|
|
|
151
171
|
### HTTP request headers
|
|
152
172
|
|
|
153
|
-
- **Content-Type**:
|
|
154
|
-
- **Accept**:
|
|
173
|
+
- **Content-Type**: Not defined
|
|
174
|
+
- **Accept**: Not defined
|
|
155
175
|
|
|
156
176
|
|
|
157
177
|
### HTTP response details
|
|
158
178
|
| Status code | Description | Response headers |
|
|
159
179
|
|-------------|-------------|------------------|
|
|
160
|
-
| **
|
|
161
|
-
| **400** | Invalid request (e.g., invalid filter syntax) | - |
|
|
180
|
+
| **204** | Credentials deleted | - |
|
|
162
181
|
| **500** | Internal server error | - |
|
|
163
182
|
|
|
164
183
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
165
184
|
|
|
166
185
|
|
|
167
|
-
##
|
|
186
|
+
## deleteForecasterRun
|
|
168
187
|
|
|
169
|
-
>
|
|
188
|
+
> deleteForecasterRun(id)
|
|
170
189
|
|
|
171
|
-
Delete
|
|
190
|
+
Delete a benchmark run
|
|
172
191
|
|
|
173
192
|
### Example
|
|
174
193
|
|
|
@@ -177,19 +196,19 @@ import {
|
|
|
177
196
|
Configuration,
|
|
178
197
|
DefaultApi,
|
|
179
198
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
180
|
-
import type {
|
|
199
|
+
import type { DeleteForecasterRunRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
181
200
|
|
|
182
201
|
async function example() {
|
|
183
202
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
184
203
|
const api = new DefaultApi();
|
|
185
204
|
|
|
186
205
|
const body = {
|
|
187
|
-
//
|
|
188
|
-
id:
|
|
189
|
-
} satisfies
|
|
206
|
+
// number | Run ID
|
|
207
|
+
id: 789,
|
|
208
|
+
} satisfies DeleteForecasterRunRequest;
|
|
190
209
|
|
|
191
210
|
try {
|
|
192
|
-
const data = await api.
|
|
211
|
+
const data = await api.deleteForecasterRun(body);
|
|
193
212
|
console.log(data);
|
|
194
213
|
} catch (error) {
|
|
195
214
|
console.error(error);
|
|
@@ -205,7 +224,7 @@ example().catch(console.error);
|
|
|
205
224
|
|
|
206
225
|
| Name | Type | Description | Notes |
|
|
207
226
|
|------------- | ------------- | ------------- | -------------|
|
|
208
|
-
| **id** | `
|
|
227
|
+
| **id** | `number` | Run ID | [Defaults to `undefined`] |
|
|
209
228
|
|
|
210
229
|
### Return type
|
|
211
230
|
|
|
@@ -224,17 +243,19 @@ No authorization required
|
|
|
224
243
|
### HTTP response details
|
|
225
244
|
| Status code | Description | Response headers |
|
|
226
245
|
|-------------|-------------|------------------|
|
|
227
|
-
| **204** |
|
|
246
|
+
| **204** | Run deleted | - |
|
|
247
|
+
| **400** | Invalid run ID | - |
|
|
248
|
+
| **404** | Run not found | - |
|
|
228
249
|
| **500** | Internal server error | - |
|
|
229
250
|
|
|
230
251
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
231
252
|
|
|
232
253
|
|
|
233
|
-
##
|
|
254
|
+
## deleteGroup
|
|
234
255
|
|
|
235
|
-
>
|
|
256
|
+
> deleteGroup(id)
|
|
236
257
|
|
|
237
|
-
|
|
258
|
+
Delete group
|
|
238
259
|
|
|
239
260
|
### Example
|
|
240
261
|
|
|
@@ -243,14 +264,19 @@ import {
|
|
|
243
264
|
Configuration,
|
|
244
265
|
DefaultApi,
|
|
245
266
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
246
|
-
import type {
|
|
267
|
+
import type { DeleteGroupRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
247
268
|
|
|
248
269
|
async function example() {
|
|
249
270
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
250
271
|
const api = new DefaultApi();
|
|
251
272
|
|
|
273
|
+
const body = {
|
|
274
|
+
// string | Group ID
|
|
275
|
+
id: id_example,
|
|
276
|
+
} satisfies DeleteGroupRequest;
|
|
277
|
+
|
|
252
278
|
try {
|
|
253
|
-
const data = await api.
|
|
279
|
+
const data = await api.deleteGroup(body);
|
|
254
280
|
console.log(data);
|
|
255
281
|
} catch (error) {
|
|
256
282
|
console.error(error);
|
|
@@ -263,11 +289,14 @@ example().catch(console.error);
|
|
|
263
289
|
|
|
264
290
|
### Parameters
|
|
265
291
|
|
|
266
|
-
|
|
292
|
+
|
|
293
|
+
| Name | Type | Description | Notes |
|
|
294
|
+
|------------- | ------------- | ------------- | -------------|
|
|
295
|
+
| **id** | `string` | Group ID | [Defaults to `undefined`] |
|
|
267
296
|
|
|
268
297
|
### Return type
|
|
269
298
|
|
|
270
|
-
|
|
299
|
+
`void` (Empty response body)
|
|
271
300
|
|
|
272
301
|
### Authorization
|
|
273
302
|
|
|
@@ -276,23 +305,23 @@ No authorization required
|
|
|
276
305
|
### HTTP request headers
|
|
277
306
|
|
|
278
307
|
- **Content-Type**: Not defined
|
|
279
|
-
- **Accept**:
|
|
308
|
+
- **Accept**: Not defined
|
|
280
309
|
|
|
281
310
|
|
|
282
311
|
### HTTP response details
|
|
283
312
|
| Status code | Description | Response headers |
|
|
284
313
|
|-------------|-------------|------------------|
|
|
285
|
-
| **
|
|
314
|
+
| **204** | Group deleted | - |
|
|
286
315
|
| **500** | Internal server error | - |
|
|
287
316
|
|
|
288
317
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
289
318
|
|
|
290
319
|
|
|
291
|
-
##
|
|
320
|
+
## deleteLabelGlobally
|
|
292
321
|
|
|
293
|
-
>
|
|
322
|
+
> DeleteLabelGloballyResponse deleteLabelGlobally(label)
|
|
294
323
|
|
|
295
|
-
|
|
324
|
+
Delete label from all VMs
|
|
296
325
|
|
|
297
326
|
### Example
|
|
298
327
|
|
|
@@ -301,14 +330,19 @@ import {
|
|
|
301
330
|
Configuration,
|
|
302
331
|
DefaultApi,
|
|
303
332
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
304
|
-
import type {
|
|
333
|
+
import type { DeleteLabelGloballyRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
305
334
|
|
|
306
335
|
async function example() {
|
|
307
336
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
308
337
|
const api = new DefaultApi();
|
|
309
338
|
|
|
339
|
+
const body = {
|
|
340
|
+
// string | The label to remove from all VMs
|
|
341
|
+
label: label_example,
|
|
342
|
+
} satisfies DeleteLabelGloballyRequest;
|
|
343
|
+
|
|
310
344
|
try {
|
|
311
|
-
const data = await api.
|
|
345
|
+
const data = await api.deleteLabelGlobally(body);
|
|
312
346
|
console.log(data);
|
|
313
347
|
} catch (error) {
|
|
314
348
|
console.error(error);
|
|
@@ -321,11 +355,14 @@ example().catch(console.error);
|
|
|
321
355
|
|
|
322
356
|
### Parameters
|
|
323
357
|
|
|
324
|
-
|
|
358
|
+
|
|
359
|
+
| Name | Type | Description | Notes |
|
|
360
|
+
|------------- | ------------- | ------------- | -------------|
|
|
361
|
+
| **label** | `string` | The label to remove from all VMs | [Defaults to `undefined`] |
|
|
325
362
|
|
|
326
363
|
### Return type
|
|
327
364
|
|
|
328
|
-
[**
|
|
365
|
+
[**DeleteLabelGloballyResponse**](DeleteLabelGloballyResponse.md)
|
|
329
366
|
|
|
330
367
|
### Authorization
|
|
331
368
|
|
|
@@ -340,17 +377,18 @@ No authorization required
|
|
|
340
377
|
### HTTP response details
|
|
341
378
|
| Status code | Description | Response headers |
|
|
342
379
|
|-------------|-------------|------------------|
|
|
343
|
-
| **200** |
|
|
380
|
+
| **200** | Label removed globally | - |
|
|
381
|
+
| **400** | Invalid label parameter | - |
|
|
344
382
|
| **500** | Internal server error | - |
|
|
345
383
|
|
|
346
384
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
347
385
|
|
|
348
386
|
|
|
349
|
-
##
|
|
387
|
+
## getAgentStatus
|
|
350
388
|
|
|
351
|
-
>
|
|
389
|
+
> AgentStatus getAgentStatus()
|
|
352
390
|
|
|
353
|
-
Get
|
|
391
|
+
Get agent status
|
|
354
392
|
|
|
355
393
|
### Example
|
|
356
394
|
|
|
@@ -359,25 +397,14 @@ import {
|
|
|
359
397
|
Configuration,
|
|
360
398
|
DefaultApi,
|
|
361
399
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
362
|
-
import type {
|
|
400
|
+
import type { GetAgentStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
363
401
|
|
|
364
402
|
async function example() {
|
|
365
403
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
366
404
|
const api = new DefaultApi();
|
|
367
405
|
|
|
368
|
-
const body = {
|
|
369
|
-
// string | Group ID
|
|
370
|
-
id: id_example,
|
|
371
|
-
// 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)
|
|
372
|
-
sort: ["cluster:asc","name:desc"],
|
|
373
|
-
// number | Page number for pagination (optional)
|
|
374
|
-
page: 56,
|
|
375
|
-
// number | Number of items per page (optional)
|
|
376
|
-
pageSize: 56,
|
|
377
|
-
} satisfies GetGroupRequest;
|
|
378
|
-
|
|
379
406
|
try {
|
|
380
|
-
const data = await api.
|
|
407
|
+
const data = await api.getAgentStatus();
|
|
381
408
|
console.log(data);
|
|
382
409
|
} catch (error) {
|
|
383
410
|
console.error(error);
|
|
@@ -390,17 +417,11 @@ example().catch(console.error);
|
|
|
390
417
|
|
|
391
418
|
### Parameters
|
|
392
419
|
|
|
393
|
-
|
|
394
|
-
| Name | Type | Description | Notes |
|
|
395
|
-
|------------- | ------------- | ------------- | -------------|
|
|
396
|
-
| **id** | `string` | Group ID | [Defaults to `undefined`] |
|
|
397
|
-
| **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] |
|
|
398
|
-
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
399
|
-
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
420
|
+
This endpoint does not need any parameter.
|
|
400
421
|
|
|
401
422
|
### Return type
|
|
402
423
|
|
|
403
|
-
[**
|
|
424
|
+
[**AgentStatus**](AgentStatus.md)
|
|
404
425
|
|
|
405
426
|
### Authorization
|
|
406
427
|
|
|
@@ -415,18 +436,17 @@ No authorization required
|
|
|
415
436
|
### HTTP response details
|
|
416
437
|
| Status code | Description | Response headers |
|
|
417
438
|
|-------------|-------------|------------------|
|
|
418
|
-
| **200** |
|
|
419
|
-
| **404** | Group not found | - |
|
|
439
|
+
| **200** | Agent status | - |
|
|
420
440
|
| **500** | Internal server error | - |
|
|
421
441
|
|
|
422
442
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
423
443
|
|
|
424
444
|
|
|
425
|
-
##
|
|
445
|
+
## getApplications
|
|
426
446
|
|
|
427
|
-
>
|
|
447
|
+
> ApplicationListResponse getApplications()
|
|
428
448
|
|
|
429
|
-
|
|
449
|
+
List detected applications running on VMs
|
|
430
450
|
|
|
431
451
|
### Example
|
|
432
452
|
|
|
@@ -435,14 +455,14 @@ import {
|
|
|
435
455
|
Configuration,
|
|
436
456
|
DefaultApi,
|
|
437
457
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
438
|
-
import type {
|
|
458
|
+
import type { GetApplicationsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
439
459
|
|
|
440
460
|
async function example() {
|
|
441
461
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
442
462
|
const api = new DefaultApi();
|
|
443
463
|
|
|
444
464
|
try {
|
|
445
|
-
const data = await api.
|
|
465
|
+
const data = await api.getApplications();
|
|
446
466
|
console.log(data);
|
|
447
467
|
} catch (error) {
|
|
448
468
|
console.error(error);
|
|
@@ -459,7 +479,7 @@ This endpoint does not need any parameter.
|
|
|
459
479
|
|
|
460
480
|
### Return type
|
|
461
481
|
|
|
462
|
-
[**
|
|
482
|
+
[**ApplicationListResponse**](ApplicationListResponse.md)
|
|
463
483
|
|
|
464
484
|
### Authorization
|
|
465
485
|
|
|
@@ -474,17 +494,17 @@ No authorization required
|
|
|
474
494
|
### HTTP response details
|
|
475
495
|
| Status code | Description | Response headers |
|
|
476
496
|
|-------------|-------------|------------------|
|
|
477
|
-
| **200** |
|
|
497
|
+
| **200** | List of applications with matching VMs | - |
|
|
478
498
|
| **500** | Internal server error | - |
|
|
479
499
|
|
|
480
500
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
481
501
|
|
|
482
502
|
|
|
483
|
-
##
|
|
503
|
+
## getClusterUtilization
|
|
484
504
|
|
|
485
|
-
>
|
|
505
|
+
> RightsizingClusterResponse getClusterUtilization(clusterId)
|
|
486
506
|
|
|
487
|
-
Get
|
|
507
|
+
Get latest cluster utilization by cluster ID
|
|
488
508
|
|
|
489
509
|
### Example
|
|
490
510
|
|
|
@@ -493,21 +513,19 @@ import {
|
|
|
493
513
|
Configuration,
|
|
494
514
|
DefaultApi,
|
|
495
515
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
496
|
-
import type {
|
|
516
|
+
import type { GetClusterUtilizationRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
497
517
|
|
|
498
518
|
async function example() {
|
|
499
519
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
500
520
|
const api = new DefaultApi();
|
|
501
521
|
|
|
502
522
|
const body = {
|
|
503
|
-
//
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
groupId: groupId_example,
|
|
507
|
-
} satisfies GetInventoryRequest;
|
|
523
|
+
// string | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\")
|
|
524
|
+
clusterId: clusterId_example,
|
|
525
|
+
} satisfies GetClusterUtilizationRequest;
|
|
508
526
|
|
|
509
527
|
try {
|
|
510
|
-
const data = await api.
|
|
528
|
+
const data = await api.getClusterUtilization(body);
|
|
511
529
|
console.log(data);
|
|
512
530
|
} catch (error) {
|
|
513
531
|
console.error(error);
|
|
@@ -523,12 +541,11 @@ example().catch(console.error);
|
|
|
523
541
|
|
|
524
542
|
| Name | Type | Description | Notes |
|
|
525
543
|
|------------- | ------------- | ------------- | -------------|
|
|
526
|
-
| **
|
|
527
|
-
| **groupId** | `string` | Filter inventory to VMs matching this group\'s filter expression | [Optional] [Defaults to `undefined`] |
|
|
544
|
+
| **clusterId** | `string` | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\") | [Defaults to `undefined`] |
|
|
528
545
|
|
|
529
546
|
### Return type
|
|
530
547
|
|
|
531
|
-
[**
|
|
548
|
+
[**RightsizingClusterResponse**](RightsizingClusterResponse.md)
|
|
532
549
|
|
|
533
550
|
### Authorization
|
|
534
551
|
|
|
@@ -543,18 +560,19 @@ No authorization required
|
|
|
543
560
|
### HTTP response details
|
|
544
561
|
| Status code | Description | Response headers |
|
|
545
562
|
|-------------|-------------|------------------|
|
|
546
|
-
| **200** |
|
|
547
|
-
| **
|
|
563
|
+
| **200** | Cluster utilization data from the latest completed rightsizing report | - |
|
|
564
|
+
| **400** | Invalid cluster_id format | - |
|
|
565
|
+
| **404** | No completed rightsizing report found, or cluster not found in report | - |
|
|
548
566
|
| **500** | Internal server error | - |
|
|
549
567
|
|
|
550
568
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
551
569
|
|
|
552
570
|
|
|
553
|
-
##
|
|
571
|
+
## getCollectorStatus
|
|
554
572
|
|
|
555
|
-
>
|
|
573
|
+
> CollectorStatus getCollectorStatus()
|
|
556
574
|
|
|
557
|
-
Get
|
|
575
|
+
Get collector status
|
|
558
576
|
|
|
559
577
|
### Example
|
|
560
578
|
|
|
@@ -563,19 +581,14 @@ import {
|
|
|
563
581
|
Configuration,
|
|
564
582
|
DefaultApi,
|
|
565
583
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
566
|
-
import type {
|
|
584
|
+
import type { GetCollectorStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
567
585
|
|
|
568
586
|
async function example() {
|
|
569
587
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
570
588
|
const api = new DefaultApi();
|
|
571
589
|
|
|
572
|
-
const body = {
|
|
573
|
-
// string | VirtualMachine id
|
|
574
|
-
id: id_example,
|
|
575
|
-
} satisfies GetVMRequest;
|
|
576
|
-
|
|
577
590
|
try {
|
|
578
|
-
const data = await api.
|
|
591
|
+
const data = await api.getCollectorStatus();
|
|
579
592
|
console.log(data);
|
|
580
593
|
} catch (error) {
|
|
581
594
|
console.error(error);
|
|
@@ -588,14 +601,11 @@ example().catch(console.error);
|
|
|
588
601
|
|
|
589
602
|
### Parameters
|
|
590
603
|
|
|
591
|
-
|
|
592
|
-
| Name | Type | Description | Notes |
|
|
593
|
-
|------------- | ------------- | ------------- | -------------|
|
|
594
|
-
| **id** | `string` | VirtualMachine id | [Defaults to `undefined`] |
|
|
604
|
+
This endpoint does not need any parameter.
|
|
595
605
|
|
|
596
606
|
### Return type
|
|
597
607
|
|
|
598
|
-
[**
|
|
608
|
+
[**CollectorStatus**](CollectorStatus.md)
|
|
599
609
|
|
|
600
610
|
### Authorization
|
|
601
611
|
|
|
@@ -610,18 +620,19 @@ No authorization required
|
|
|
610
620
|
### HTTP response details
|
|
611
621
|
| Status code | Description | Response headers |
|
|
612
622
|
|-------------|-------------|------------------|
|
|
613
|
-
| **200** |
|
|
614
|
-
| **404** | VirtualMachine not found | - |
|
|
623
|
+
| **200** | Collector status | - |
|
|
615
624
|
| **500** | Internal server error | - |
|
|
616
625
|
|
|
617
626
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
618
627
|
|
|
619
628
|
|
|
620
|
-
##
|
|
629
|
+
## getCredentials
|
|
630
|
+
|
|
631
|
+
> CredentialStatus getCredentials()
|
|
621
632
|
|
|
622
|
-
|
|
633
|
+
Get stored credential status
|
|
623
634
|
|
|
624
|
-
|
|
635
|
+
Returns stored credential metadata (URL only). Never exposes username or password. This endpoint does not revalidate credentials against vSphere.
|
|
625
636
|
|
|
626
637
|
### Example
|
|
627
638
|
|
|
@@ -630,19 +641,14 @@ import {
|
|
|
630
641
|
Configuration,
|
|
631
642
|
DefaultApi,
|
|
632
643
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
633
|
-
import type {
|
|
644
|
+
import type { GetCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
634
645
|
|
|
635
646
|
async function example() {
|
|
636
647
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
637
648
|
const api = new DefaultApi();
|
|
638
649
|
|
|
639
|
-
const body = {
|
|
640
|
-
// string | VirtualMachine ID
|
|
641
|
-
id: id_example,
|
|
642
|
-
} satisfies GetVMInspectionStatusRequest;
|
|
643
|
-
|
|
644
650
|
try {
|
|
645
|
-
const data = await api.
|
|
651
|
+
const data = await api.getCredentials();
|
|
646
652
|
console.log(data);
|
|
647
653
|
} catch (error) {
|
|
648
654
|
console.error(error);
|
|
@@ -655,14 +661,11 @@ example().catch(console.error);
|
|
|
655
661
|
|
|
656
662
|
### Parameters
|
|
657
663
|
|
|
658
|
-
|
|
659
|
-
| Name | Type | Description | Notes |
|
|
660
|
-
|------------- | ------------- | ------------- | -------------|
|
|
661
|
-
| **id** | `string` | VirtualMachine ID | [Defaults to `undefined`] |
|
|
664
|
+
This endpoint does not need any parameter.
|
|
662
665
|
|
|
663
666
|
### Return type
|
|
664
667
|
|
|
665
|
-
[**
|
|
668
|
+
[**CredentialStatus**](CredentialStatus.md)
|
|
666
669
|
|
|
667
670
|
### Authorization
|
|
668
671
|
|
|
@@ -677,18 +680,20 @@ No authorization required
|
|
|
677
680
|
### HTTP response details
|
|
678
681
|
| Status code | Description | Response headers |
|
|
679
682
|
|-------------|-------------|------------------|
|
|
680
|
-
| **200** |
|
|
681
|
-
| **404** |
|
|
683
|
+
| **200** | Credential status | - |
|
|
684
|
+
| **404** | No credentials stored | - |
|
|
682
685
|
| **500** | Internal server error | - |
|
|
683
686
|
|
|
684
687
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
685
688
|
|
|
686
689
|
|
|
687
|
-
##
|
|
690
|
+
## getForecasterDatastores
|
|
688
691
|
|
|
689
|
-
>
|
|
692
|
+
> Array<DatastoreDetail> getForecasterDatastores(forecasterDatastoresRequest)
|
|
690
693
|
|
|
691
|
-
|
|
694
|
+
List available datastores
|
|
695
|
+
|
|
696
|
+
Returns datastores from the forklift-collected inventory with storage vendor and capability information derived from NAA device identifiers. No vSphere credentials are required.
|
|
692
697
|
|
|
693
698
|
### Example
|
|
694
699
|
|
|
@@ -697,25 +702,19 @@ import {
|
|
|
697
702
|
Configuration,
|
|
698
703
|
DefaultApi,
|
|
699
704
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
700
|
-
import type {
|
|
705
|
+
import type { GetForecasterDatastoresRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
701
706
|
|
|
702
707
|
async function example() {
|
|
703
708
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
704
709
|
const api = new DefaultApi();
|
|
705
710
|
|
|
706
711
|
const body = {
|
|
707
|
-
//
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
sort: ["cluster:asc","name:desc"],
|
|
711
|
-
// number | Page number for pagination (optional)
|
|
712
|
-
page: 56,
|
|
713
|
-
// number | Number of items per page (optional)
|
|
714
|
-
pageSize: 56,
|
|
715
|
-
} satisfies GetVMsRequest;
|
|
712
|
+
// ForecasterDatastoresRequest (optional)
|
|
713
|
+
forecasterDatastoresRequest: ...,
|
|
714
|
+
} satisfies GetForecasterDatastoresRequest;
|
|
716
715
|
|
|
717
716
|
try {
|
|
718
|
-
const data = await api.
|
|
717
|
+
const data = await api.getForecasterDatastores(body);
|
|
719
718
|
console.log(data);
|
|
720
719
|
} catch (error) {
|
|
721
720
|
console.error(error);
|
|
@@ -731,14 +730,11 @@ example().catch(console.error);
|
|
|
731
730
|
|
|
732
731
|
| Name | Type | Description | Notes |
|
|
733
732
|
|------------- | ------------- | ------------- | -------------|
|
|
734
|
-
| **
|
|
735
|
-
| **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] |
|
|
736
|
-
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
737
|
-
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
733
|
+
| **forecasterDatastoresRequest** | [ForecasterDatastoresRequest](ForecasterDatastoresRequest.md) | | [Optional] |
|
|
738
734
|
|
|
739
735
|
### Return type
|
|
740
736
|
|
|
741
|
-
[**
|
|
737
|
+
[**Array<DatastoreDetail>**](DatastoreDetail.md)
|
|
742
738
|
|
|
743
739
|
### Authorization
|
|
744
740
|
|
|
@@ -746,25 +742,26 @@ No authorization required
|
|
|
746
742
|
|
|
747
743
|
### HTTP request headers
|
|
748
744
|
|
|
749
|
-
- **Content-Type**:
|
|
745
|
+
- **Content-Type**: `application/json`
|
|
750
746
|
- **Accept**: `application/json`
|
|
751
747
|
|
|
752
748
|
|
|
753
749
|
### HTTP response details
|
|
754
750
|
| Status code | Description | Response headers |
|
|
755
751
|
|-------------|-------------|------------------|
|
|
756
|
-
| **200** | List of
|
|
757
|
-
| **400** | Invalid request parameters | - |
|
|
752
|
+
| **200** | List of datastores | - |
|
|
758
753
|
| **500** | Internal server error | - |
|
|
759
754
|
|
|
760
755
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
761
756
|
|
|
762
757
|
|
|
763
|
-
##
|
|
758
|
+
## getForecasterRuns
|
|
764
759
|
|
|
765
|
-
>
|
|
760
|
+
> Array<BenchmarkRun> getForecasterRuns(pairName)
|
|
766
761
|
|
|
767
|
-
|
|
762
|
+
List benchmark runs
|
|
763
|
+
|
|
764
|
+
Returns individual benchmark iterations. Optionally filtered by pair name.
|
|
768
765
|
|
|
769
766
|
### Example
|
|
770
767
|
|
|
@@ -773,14 +770,19 @@ import {
|
|
|
773
770
|
Configuration,
|
|
774
771
|
DefaultApi,
|
|
775
772
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
776
|
-
import type {
|
|
773
|
+
import type { GetForecasterRunsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
777
774
|
|
|
778
775
|
async function example() {
|
|
779
776
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
780
777
|
const api = new DefaultApi();
|
|
781
778
|
|
|
779
|
+
const body = {
|
|
780
|
+
// string | Filter runs by pair name (optional)
|
|
781
|
+
pairName: pairName_example,
|
|
782
|
+
} satisfies GetForecasterRunsRequest;
|
|
783
|
+
|
|
782
784
|
try {
|
|
783
|
-
const data = await api.
|
|
785
|
+
const data = await api.getForecasterRuns(body);
|
|
784
786
|
console.log(data);
|
|
785
787
|
} catch (error) {
|
|
786
788
|
console.error(error);
|
|
@@ -793,11 +795,14 @@ example().catch(console.error);
|
|
|
793
795
|
|
|
794
796
|
### Parameters
|
|
795
797
|
|
|
796
|
-
|
|
798
|
+
|
|
799
|
+
| Name | Type | Description | Notes |
|
|
800
|
+
|------------- | ------------- | ------------- | -------------|
|
|
801
|
+
| **pairName** | `string` | Filter runs by pair name | [Optional] [Defaults to `undefined`] |
|
|
797
802
|
|
|
798
803
|
### Return type
|
|
799
804
|
|
|
800
|
-
[**
|
|
805
|
+
[**Array<BenchmarkRun>**](BenchmarkRun.md)
|
|
801
806
|
|
|
802
807
|
### Authorization
|
|
803
808
|
|
|
@@ -812,18 +817,19 @@ No authorization required
|
|
|
812
817
|
### HTTP response details
|
|
813
818
|
| Status code | Description | Response headers |
|
|
814
819
|
|-------------|-------------|------------------|
|
|
815
|
-
| **200** |
|
|
816
|
-
| **404** | Vddk not found | - |
|
|
820
|
+
| **200** | List of benchmark runs | - |
|
|
817
821
|
| **500** | Internal server error | - |
|
|
818
822
|
|
|
819
823
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
820
824
|
|
|
821
825
|
|
|
822
|
-
##
|
|
826
|
+
## getForecasterStats
|
|
823
827
|
|
|
824
|
-
>
|
|
828
|
+
> ForecastStats getForecasterStats(pairName)
|
|
825
829
|
|
|
826
|
-
Get
|
|
830
|
+
Get throughput statistics
|
|
831
|
+
|
|
832
|
+
Returns computed statistics for a datastore pair\'s benchmark results. Primary endpoint for the UI to display migration time estimates.
|
|
827
833
|
|
|
828
834
|
### Example
|
|
829
835
|
|
|
@@ -832,14 +838,19 @@ import {
|
|
|
832
838
|
Configuration,
|
|
833
839
|
DefaultApi,
|
|
834
840
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
835
|
-
import type {
|
|
841
|
+
import type { GetForecasterStatsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
836
842
|
|
|
837
843
|
async function example() {
|
|
838
844
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
839
845
|
const api = new DefaultApi();
|
|
840
846
|
|
|
847
|
+
const body = {
|
|
848
|
+
// string | Pair name to get statistics for
|
|
849
|
+
pairName: pairName_example,
|
|
850
|
+
} satisfies GetForecasterStatsRequest;
|
|
851
|
+
|
|
841
852
|
try {
|
|
842
|
-
const data = await api.
|
|
853
|
+
const data = await api.getForecasterStats(body);
|
|
843
854
|
console.log(data);
|
|
844
855
|
} catch (error) {
|
|
845
856
|
console.error(error);
|
|
@@ -852,11 +863,14 @@ example().catch(console.error);
|
|
|
852
863
|
|
|
853
864
|
### Parameters
|
|
854
865
|
|
|
855
|
-
|
|
866
|
+
|
|
867
|
+
| Name | Type | Description | Notes |
|
|
868
|
+
|------------- | ------------- | ------------- | -------------|
|
|
869
|
+
| **pairName** | `string` | Pair name to get statistics for | [Defaults to `undefined`] |
|
|
856
870
|
|
|
857
871
|
### Return type
|
|
858
872
|
|
|
859
|
-
[**
|
|
873
|
+
[**ForecastStats**](ForecastStats.md)
|
|
860
874
|
|
|
861
875
|
### Authorization
|
|
862
876
|
|
|
@@ -871,16 +885,20 @@ No authorization required
|
|
|
871
885
|
### HTTP response details
|
|
872
886
|
| Status code | Description | Response headers |
|
|
873
887
|
|-------------|-------------|------------------|
|
|
874
|
-
| **200** |
|
|
888
|
+
| **200** | Throughput statistics | - |
|
|
889
|
+
| **400** | Missing pairName parameter | - |
|
|
890
|
+
| **500** | Internal server error | - |
|
|
875
891
|
|
|
876
892
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
877
893
|
|
|
878
894
|
|
|
879
|
-
##
|
|
895
|
+
## getForecasterStatus
|
|
880
896
|
|
|
881
|
-
>
|
|
897
|
+
> ForecasterStatus getForecasterStatus()
|
|
882
898
|
|
|
883
|
-
|
|
899
|
+
Poll forecaster status
|
|
900
|
+
|
|
901
|
+
Returns current service state with per-pair progress details.
|
|
884
902
|
|
|
885
903
|
### Example
|
|
886
904
|
|
|
@@ -889,23 +907,14 @@ import {
|
|
|
889
907
|
Configuration,
|
|
890
908
|
DefaultApi,
|
|
891
909
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
892
|
-
import type {
|
|
910
|
+
import type { GetForecasterStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
893
911
|
|
|
894
912
|
async function example() {
|
|
895
913
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
896
914
|
const api = new DefaultApi();
|
|
897
915
|
|
|
898
|
-
const body = {
|
|
899
|
-
// string | Filter groups by name (case-insensitive substring match) (optional)
|
|
900
|
-
byName: byName_example,
|
|
901
|
-
// number | Page number (1-indexed) (optional)
|
|
902
|
-
page: 56,
|
|
903
|
-
// number | Number of groups per page (optional)
|
|
904
|
-
pageSize: 56,
|
|
905
|
-
} satisfies ListGroupsRequest;
|
|
906
|
-
|
|
907
916
|
try {
|
|
908
|
-
const data = await api.
|
|
917
|
+
const data = await api.getForecasterStatus();
|
|
909
918
|
console.log(data);
|
|
910
919
|
} catch (error) {
|
|
911
920
|
console.error(error);
|
|
@@ -918,16 +927,11 @@ example().catch(console.error);
|
|
|
918
927
|
|
|
919
928
|
### Parameters
|
|
920
929
|
|
|
921
|
-
|
|
922
|
-
| Name | Type | Description | Notes |
|
|
923
|
-
|------------- | ------------- | ------------- | -------------|
|
|
924
|
-
| **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
|
|
925
|
-
| **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
|
|
926
|
-
| **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
|
|
930
|
+
This endpoint does not need any parameter.
|
|
927
931
|
|
|
928
932
|
### Return type
|
|
929
933
|
|
|
930
|
-
[**
|
|
934
|
+
[**ForecasterStatus**](ForecasterStatus.md)
|
|
931
935
|
|
|
932
936
|
### Authorization
|
|
933
937
|
|
|
@@ -942,18 +946,16 @@ No authorization required
|
|
|
942
946
|
### HTTP response details
|
|
943
947
|
| Status code | Description | Response headers |
|
|
944
948
|
|-------------|-------------|------------------|
|
|
945
|
-
| **200** |
|
|
946
|
-
| **400** | Invalid filter expression | - |
|
|
947
|
-
| **500** | Internal server error | - |
|
|
949
|
+
| **200** | Current forecaster status | - |
|
|
948
950
|
|
|
949
951
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
950
952
|
|
|
951
953
|
|
|
952
|
-
##
|
|
954
|
+
## getGroup
|
|
953
955
|
|
|
954
|
-
>
|
|
956
|
+
> GroupResponse getGroup(id, sort, page, pageSize)
|
|
955
957
|
|
|
956
|
-
|
|
958
|
+
Get group by ID with its VMs
|
|
957
959
|
|
|
958
960
|
### Example
|
|
959
961
|
|
|
@@ -962,7 +964,1414 @@ import {
|
|
|
962
964
|
Configuration,
|
|
963
965
|
DefaultApi,
|
|
964
966
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
965
|
-
import type {
|
|
967
|
+
import type { GetGroupRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
968
|
+
|
|
969
|
+
async function example() {
|
|
970
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
971
|
+
const api = new DefaultApi();
|
|
972
|
+
|
|
973
|
+
const body = {
|
|
974
|
+
// string | Group ID
|
|
975
|
+
id: id_example,
|
|
976
|
+
// Array<string> | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues, cpuUsage, diskUsage, ramUsage, cpuAvg, memAvg. (optional)
|
|
977
|
+
sort: ["cluster:asc","name:desc"],
|
|
978
|
+
// number | Page number for pagination (optional)
|
|
979
|
+
page: 56,
|
|
980
|
+
// number | Number of items per page (optional)
|
|
981
|
+
pageSize: 56,
|
|
982
|
+
} satisfies GetGroupRequest;
|
|
983
|
+
|
|
984
|
+
try {
|
|
985
|
+
const data = await api.getGroup(body);
|
|
986
|
+
console.log(data);
|
|
987
|
+
} catch (error) {
|
|
988
|
+
console.error(error);
|
|
989
|
+
}
|
|
990
|
+
}
|
|
991
|
+
|
|
992
|
+
// Run the test
|
|
993
|
+
example().catch(console.error);
|
|
994
|
+
```
|
|
995
|
+
|
|
996
|
+
### Parameters
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
| Name | Type | Description | Notes |
|
|
1000
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1001
|
+
| **id** | `string` | Group ID | [Defaults to `undefined`] |
|
|
1002
|
+
| **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, cpuUsage, diskUsage, ramUsage, cpuAvg, memAvg. | [Optional] |
|
|
1003
|
+
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
1004
|
+
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
1005
|
+
|
|
1006
|
+
### Return type
|
|
1007
|
+
|
|
1008
|
+
[**GroupResponse**](GroupResponse.md)
|
|
1009
|
+
|
|
1010
|
+
### Authorization
|
|
1011
|
+
|
|
1012
|
+
No authorization required
|
|
1013
|
+
|
|
1014
|
+
### HTTP request headers
|
|
1015
|
+
|
|
1016
|
+
- **Content-Type**: Not defined
|
|
1017
|
+
- **Accept**: `application/json`
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
### HTTP response details
|
|
1021
|
+
| Status code | Description | Response headers |
|
|
1022
|
+
|-------------|-------------|------------------|
|
|
1023
|
+
| **200** | Group details with VMs | - |
|
|
1024
|
+
| **404** | Group not found | - |
|
|
1025
|
+
| **500** | Internal server error | - |
|
|
1026
|
+
|
|
1027
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
## getInspectorStatus
|
|
1031
|
+
|
|
1032
|
+
> InspectorStatus getInspectorStatus(includeVddk)
|
|
1033
|
+
|
|
1034
|
+
Get inspector status
|
|
1035
|
+
|
|
1036
|
+
### Example
|
|
1037
|
+
|
|
1038
|
+
```ts
|
|
1039
|
+
import {
|
|
1040
|
+
Configuration,
|
|
1041
|
+
DefaultApi,
|
|
1042
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1043
|
+
import type { GetInspectorStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1044
|
+
|
|
1045
|
+
async function example() {
|
|
1046
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1047
|
+
const api = new DefaultApi();
|
|
1048
|
+
|
|
1049
|
+
const body = {
|
|
1050
|
+
// boolean | If true, include uploaded VDDK metadata (`version`, `md5`) when present. omitted if VDDK was never uploaded. (optional)
|
|
1051
|
+
includeVddk: true,
|
|
1052
|
+
} satisfies GetInspectorStatusRequest;
|
|
1053
|
+
|
|
1054
|
+
try {
|
|
1055
|
+
const data = await api.getInspectorStatus(body);
|
|
1056
|
+
console.log(data);
|
|
1057
|
+
} catch (error) {
|
|
1058
|
+
console.error(error);
|
|
1059
|
+
}
|
|
1060
|
+
}
|
|
1061
|
+
|
|
1062
|
+
// Run the test
|
|
1063
|
+
example().catch(console.error);
|
|
1064
|
+
```
|
|
1065
|
+
|
|
1066
|
+
### Parameters
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
| Name | Type | Description | Notes |
|
|
1070
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1071
|
+
| **includeVddk** | `boolean` | If true, include uploaded VDDK metadata (`version`, `md5`) when present. omitted if VDDK was never uploaded. | [Optional] [Defaults to `false`] |
|
|
1072
|
+
|
|
1073
|
+
### Return type
|
|
1074
|
+
|
|
1075
|
+
[**InspectorStatus**](InspectorStatus.md)
|
|
1076
|
+
|
|
1077
|
+
### Authorization
|
|
1078
|
+
|
|
1079
|
+
No authorization required
|
|
1080
|
+
|
|
1081
|
+
### HTTP request headers
|
|
1082
|
+
|
|
1083
|
+
- **Content-Type**: Not defined
|
|
1084
|
+
- **Accept**: `application/json`
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
### HTTP response details
|
|
1088
|
+
| Status code | Description | Response headers |
|
|
1089
|
+
|-------------|-------------|------------------|
|
|
1090
|
+
| **200** | Inspector status | - |
|
|
1091
|
+
| **500** | Internal server error | - |
|
|
1092
|
+
|
|
1093
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
## getInspectorVddkStatus
|
|
1097
|
+
|
|
1098
|
+
> VddkProperties getInspectorVddkStatus()
|
|
1099
|
+
|
|
1100
|
+
Get VDDK status
|
|
1101
|
+
|
|
1102
|
+
### Example
|
|
1103
|
+
|
|
1104
|
+
```ts
|
|
1105
|
+
import {
|
|
1106
|
+
Configuration,
|
|
1107
|
+
DefaultApi,
|
|
1108
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1109
|
+
import type { GetInspectorVddkStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1110
|
+
|
|
1111
|
+
async function example() {
|
|
1112
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1113
|
+
const api = new DefaultApi();
|
|
1114
|
+
|
|
1115
|
+
try {
|
|
1116
|
+
const data = await api.getInspectorVddkStatus();
|
|
1117
|
+
console.log(data);
|
|
1118
|
+
} catch (error) {
|
|
1119
|
+
console.error(error);
|
|
1120
|
+
}
|
|
1121
|
+
}
|
|
1122
|
+
|
|
1123
|
+
// Run the test
|
|
1124
|
+
example().catch(console.error);
|
|
1125
|
+
```
|
|
1126
|
+
|
|
1127
|
+
### Parameters
|
|
1128
|
+
|
|
1129
|
+
This endpoint does not need any parameter.
|
|
1130
|
+
|
|
1131
|
+
### Return type
|
|
1132
|
+
|
|
1133
|
+
[**VddkProperties**](VddkProperties.md)
|
|
1134
|
+
|
|
1135
|
+
### Authorization
|
|
1136
|
+
|
|
1137
|
+
No authorization required
|
|
1138
|
+
|
|
1139
|
+
### HTTP request headers
|
|
1140
|
+
|
|
1141
|
+
- **Content-Type**: Not defined
|
|
1142
|
+
- **Accept**: `application/json`
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
### HTTP response details
|
|
1146
|
+
| Status code | Description | Response headers |
|
|
1147
|
+
|-------------|-------------|------------------|
|
|
1148
|
+
| **200** | Returns the current properties of the uploaded VMware VDDK tar. If the VDDK package has not been uploaded, a 404 response is returned. | - |
|
|
1149
|
+
| **404** | Vddk not found | - |
|
|
1150
|
+
| **500** | Internal server error | - |
|
|
1151
|
+
|
|
1152
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
## getInventory
|
|
1156
|
+
|
|
1157
|
+
> GetInventory200Response getInventory(withAgentId, groupId)
|
|
1158
|
+
|
|
1159
|
+
Get collected inventory
|
|
1160
|
+
|
|
1161
|
+
### Example
|
|
1162
|
+
|
|
1163
|
+
```ts
|
|
1164
|
+
import {
|
|
1165
|
+
Configuration,
|
|
1166
|
+
DefaultApi,
|
|
1167
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1168
|
+
import type { GetInventoryRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1169
|
+
|
|
1170
|
+
async function example() {
|
|
1171
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1172
|
+
const api = new DefaultApi();
|
|
1173
|
+
|
|
1174
|
+
const body = {
|
|
1175
|
+
// boolean | If true, include the agentId in the response (Compatible with manual inventory upload). (optional)
|
|
1176
|
+
withAgentId: true,
|
|
1177
|
+
// string | Filter inventory to VMs matching this group\'s filter expression (optional)
|
|
1178
|
+
groupId: groupId_example,
|
|
1179
|
+
} satisfies GetInventoryRequest;
|
|
1180
|
+
|
|
1181
|
+
try {
|
|
1182
|
+
const data = await api.getInventory(body);
|
|
1183
|
+
console.log(data);
|
|
1184
|
+
} catch (error) {
|
|
1185
|
+
console.error(error);
|
|
1186
|
+
}
|
|
1187
|
+
}
|
|
1188
|
+
|
|
1189
|
+
// Run the test
|
|
1190
|
+
example().catch(console.error);
|
|
1191
|
+
```
|
|
1192
|
+
|
|
1193
|
+
### Parameters
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
| Name | Type | Description | Notes |
|
|
1197
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1198
|
+
| **withAgentId** | `boolean` | If true, include the agentId in the response (Compatible with manual inventory upload). | [Optional] [Defaults to `false`] |
|
|
1199
|
+
| **groupId** | `string` | Filter inventory to VMs matching this group\'s filter expression | [Optional] [Defaults to `undefined`] |
|
|
1200
|
+
|
|
1201
|
+
### Return type
|
|
1202
|
+
|
|
1203
|
+
[**GetInventory200Response**](GetInventory200Response.md)
|
|
1204
|
+
|
|
1205
|
+
### Authorization
|
|
1206
|
+
|
|
1207
|
+
No authorization required
|
|
1208
|
+
|
|
1209
|
+
### HTTP request headers
|
|
1210
|
+
|
|
1211
|
+
- **Content-Type**: Not defined
|
|
1212
|
+
- **Accept**: `application/json`
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
### HTTP response details
|
|
1216
|
+
| Status code | Description | Response headers |
|
|
1217
|
+
|-------------|-------------|------------------|
|
|
1218
|
+
| **200** | Collected inventory | - |
|
|
1219
|
+
| **404** | Inventory not available | - |
|
|
1220
|
+
| **500** | Internal server error | - |
|
|
1221
|
+
|
|
1222
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
## getLatestRightsizingClusters
|
|
1226
|
+
|
|
1227
|
+
> RightsizingClusterListResponse getLatestRightsizingClusters(byExpression)
|
|
1228
|
+
|
|
1229
|
+
Get cluster-level utilization aggregates for the latest completed report
|
|
1230
|
+
|
|
1231
|
+
### Example
|
|
1232
|
+
|
|
1233
|
+
```ts
|
|
1234
|
+
import {
|
|
1235
|
+
Configuration,
|
|
1236
|
+
DefaultApi,
|
|
1237
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1238
|
+
import type { GetLatestRightsizingClustersRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1239
|
+
|
|
1240
|
+
async function example() {
|
|
1241
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1242
|
+
const api = new DefaultApi();
|
|
1243
|
+
|
|
1244
|
+
const body = {
|
|
1245
|
+
// string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
|
|
1246
|
+
byExpression: byExpression_example,
|
|
1247
|
+
} satisfies GetLatestRightsizingClustersRequest;
|
|
1248
|
+
|
|
1249
|
+
try {
|
|
1250
|
+
const data = await api.getLatestRightsizingClusters(body);
|
|
1251
|
+
console.log(data);
|
|
1252
|
+
} catch (error) {
|
|
1253
|
+
console.error(error);
|
|
1254
|
+
}
|
|
1255
|
+
}
|
|
1256
|
+
|
|
1257
|
+
// Run the test
|
|
1258
|
+
example().catch(console.error);
|
|
1259
|
+
```
|
|
1260
|
+
|
|
1261
|
+
### Parameters
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
| Name | Type | Description | Notes |
|
|
1265
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1266
|
+
| **byExpression** | `string` | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
|
|
1267
|
+
|
|
1268
|
+
### Return type
|
|
1269
|
+
|
|
1270
|
+
[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
|
|
1271
|
+
|
|
1272
|
+
### Authorization
|
|
1273
|
+
|
|
1274
|
+
No authorization required
|
|
1275
|
+
|
|
1276
|
+
### HTTP request headers
|
|
1277
|
+
|
|
1278
|
+
- **Content-Type**: Not defined
|
|
1279
|
+
- **Accept**: `application/json`
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
### HTTP response details
|
|
1283
|
+
| Status code | Description | Response headers |
|
|
1284
|
+
|-------------|-------------|------------------|
|
|
1285
|
+
| **200** | Cluster utilization aggregates | - |
|
|
1286
|
+
| **404** | No completed rightsizing report found | - |
|
|
1287
|
+
| **500** | Internal server error | - |
|
|
1288
|
+
|
|
1289
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
## getRightsizingReport
|
|
1293
|
+
|
|
1294
|
+
> RightsizingReport getRightsizingReport(reportId)
|
|
1295
|
+
|
|
1296
|
+
Get a specific rightsizing report with full VM metrics
|
|
1297
|
+
|
|
1298
|
+
### Example
|
|
1299
|
+
|
|
1300
|
+
```ts
|
|
1301
|
+
import {
|
|
1302
|
+
Configuration,
|
|
1303
|
+
DefaultApi,
|
|
1304
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1305
|
+
import type { GetRightsizingReportRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1306
|
+
|
|
1307
|
+
async function example() {
|
|
1308
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1309
|
+
const api = new DefaultApi();
|
|
1310
|
+
|
|
1311
|
+
const body = {
|
|
1312
|
+
// string | Report UUID
|
|
1313
|
+
reportId: reportId_example,
|
|
1314
|
+
} satisfies GetRightsizingReportRequest;
|
|
1315
|
+
|
|
1316
|
+
try {
|
|
1317
|
+
const data = await api.getRightsizingReport(body);
|
|
1318
|
+
console.log(data);
|
|
1319
|
+
} catch (error) {
|
|
1320
|
+
console.error(error);
|
|
1321
|
+
}
|
|
1322
|
+
}
|
|
1323
|
+
|
|
1324
|
+
// Run the test
|
|
1325
|
+
example().catch(console.error);
|
|
1326
|
+
```
|
|
1327
|
+
|
|
1328
|
+
### Parameters
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
| Name | Type | Description | Notes |
|
|
1332
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1333
|
+
| **reportId** | `string` | Report UUID | [Defaults to `undefined`] |
|
|
1334
|
+
|
|
1335
|
+
### Return type
|
|
1336
|
+
|
|
1337
|
+
[**RightsizingReport**](RightsizingReport.md)
|
|
1338
|
+
|
|
1339
|
+
### Authorization
|
|
1340
|
+
|
|
1341
|
+
No authorization required
|
|
1342
|
+
|
|
1343
|
+
### HTTP request headers
|
|
1344
|
+
|
|
1345
|
+
- **Content-Type**: Not defined
|
|
1346
|
+
- **Accept**: `application/json`
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
### HTTP response details
|
|
1350
|
+
| Status code | Description | Response headers |
|
|
1351
|
+
|-------------|-------------|------------------|
|
|
1352
|
+
| **200** | Rightsizing report | - |
|
|
1353
|
+
| **404** | Report not found | - |
|
|
1354
|
+
| **500** | Internal server error | - |
|
|
1355
|
+
|
|
1356
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
## getRightsizingReportCluster
|
|
1360
|
+
|
|
1361
|
+
> RightsizingClusterResponse getRightsizingReportCluster(reportId, clusterId)
|
|
1362
|
+
|
|
1363
|
+
Get utilization for a specific cluster from a specific report
|
|
1364
|
+
|
|
1365
|
+
### Example
|
|
1366
|
+
|
|
1367
|
+
```ts
|
|
1368
|
+
import {
|
|
1369
|
+
Configuration,
|
|
1370
|
+
DefaultApi,
|
|
1371
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1372
|
+
import type { GetRightsizingReportClusterRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1373
|
+
|
|
1374
|
+
async function example() {
|
|
1375
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1376
|
+
const api = new DefaultApi();
|
|
1377
|
+
|
|
1378
|
+
const body = {
|
|
1379
|
+
// string | Rightsizing report UUID
|
|
1380
|
+
reportId: reportId_example,
|
|
1381
|
+
// string | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\")
|
|
1382
|
+
clusterId: clusterId_example,
|
|
1383
|
+
} satisfies GetRightsizingReportClusterRequest;
|
|
1384
|
+
|
|
1385
|
+
try {
|
|
1386
|
+
const data = await api.getRightsizingReportCluster(body);
|
|
1387
|
+
console.log(data);
|
|
1388
|
+
} catch (error) {
|
|
1389
|
+
console.error(error);
|
|
1390
|
+
}
|
|
1391
|
+
}
|
|
1392
|
+
|
|
1393
|
+
// Run the test
|
|
1394
|
+
example().catch(console.error);
|
|
1395
|
+
```
|
|
1396
|
+
|
|
1397
|
+
### Parameters
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
| Name | Type | Description | Notes |
|
|
1401
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1402
|
+
| **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
|
|
1403
|
+
| **clusterId** | `string` | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\") | [Defaults to `undefined`] |
|
|
1404
|
+
|
|
1405
|
+
### Return type
|
|
1406
|
+
|
|
1407
|
+
[**RightsizingClusterResponse**](RightsizingClusterResponse.md)
|
|
1408
|
+
|
|
1409
|
+
### Authorization
|
|
1410
|
+
|
|
1411
|
+
No authorization required
|
|
1412
|
+
|
|
1413
|
+
### HTTP request headers
|
|
1414
|
+
|
|
1415
|
+
- **Content-Type**: Not defined
|
|
1416
|
+
- **Accept**: `application/json`
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
### HTTP response details
|
|
1420
|
+
| Status code | Description | Response headers |
|
|
1421
|
+
|-------------|-------------|------------------|
|
|
1422
|
+
| **200** | Cluster utilization data | - |
|
|
1423
|
+
| **404** | Report not found, or cluster not found in report | - |
|
|
1424
|
+
| **500** | Internal server error | - |
|
|
1425
|
+
|
|
1426
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
## getRightsizingReportClusters
|
|
1430
|
+
|
|
1431
|
+
> RightsizingClusterListResponse getRightsizingReportClusters(reportId, byExpression)
|
|
1432
|
+
|
|
1433
|
+
Get cluster-level utilization aggregates for a specific report
|
|
1434
|
+
|
|
1435
|
+
### Example
|
|
1436
|
+
|
|
1437
|
+
```ts
|
|
1438
|
+
import {
|
|
1439
|
+
Configuration,
|
|
1440
|
+
DefaultApi,
|
|
1441
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1442
|
+
import type { GetRightsizingReportClustersRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1443
|
+
|
|
1444
|
+
async function example() {
|
|
1445
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1446
|
+
const api = new DefaultApi();
|
|
1447
|
+
|
|
1448
|
+
const body = {
|
|
1449
|
+
// string | Rightsizing report UUID
|
|
1450
|
+
reportId: reportId_example,
|
|
1451
|
+
// string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
|
|
1452
|
+
byExpression: byExpression_example,
|
|
1453
|
+
} satisfies GetRightsizingReportClustersRequest;
|
|
1454
|
+
|
|
1455
|
+
try {
|
|
1456
|
+
const data = await api.getRightsizingReportClusters(body);
|
|
1457
|
+
console.log(data);
|
|
1458
|
+
} catch (error) {
|
|
1459
|
+
console.error(error);
|
|
1460
|
+
}
|
|
1461
|
+
}
|
|
1462
|
+
|
|
1463
|
+
// Run the test
|
|
1464
|
+
example().catch(console.error);
|
|
1465
|
+
```
|
|
1466
|
+
|
|
1467
|
+
### Parameters
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
| Name | Type | Description | Notes |
|
|
1471
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1472
|
+
| **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
|
|
1473
|
+
| **byExpression** | `string` | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
|
|
1474
|
+
|
|
1475
|
+
### Return type
|
|
1476
|
+
|
|
1477
|
+
[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
|
|
1478
|
+
|
|
1479
|
+
### Authorization
|
|
1480
|
+
|
|
1481
|
+
No authorization required
|
|
1482
|
+
|
|
1483
|
+
### HTTP request headers
|
|
1484
|
+
|
|
1485
|
+
- **Content-Type**: Not defined
|
|
1486
|
+
- **Accept**: `application/json`
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
### HTTP response details
|
|
1490
|
+
| Status code | Description | Response headers |
|
|
1491
|
+
|-------------|-------------|------------------|
|
|
1492
|
+
| **200** | Cluster utilization aggregates | - |
|
|
1493
|
+
| **404** | Report not found | - |
|
|
1494
|
+
| **500** | Internal server error | - |
|
|
1495
|
+
|
|
1496
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
## getVM
|
|
1500
|
+
|
|
1501
|
+
> VirtualMachineDetail getVM(id)
|
|
1502
|
+
|
|
1503
|
+
Get details about a vm
|
|
1504
|
+
|
|
1505
|
+
### Example
|
|
1506
|
+
|
|
1507
|
+
```ts
|
|
1508
|
+
import {
|
|
1509
|
+
Configuration,
|
|
1510
|
+
DefaultApi,
|
|
1511
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1512
|
+
import type { GetVMRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1513
|
+
|
|
1514
|
+
async function example() {
|
|
1515
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1516
|
+
const api = new DefaultApi();
|
|
1517
|
+
|
|
1518
|
+
const body = {
|
|
1519
|
+
// string | VirtualMachine id
|
|
1520
|
+
id: id_example,
|
|
1521
|
+
} satisfies GetVMRequest;
|
|
1522
|
+
|
|
1523
|
+
try {
|
|
1524
|
+
const data = await api.getVM(body);
|
|
1525
|
+
console.log(data);
|
|
1526
|
+
} catch (error) {
|
|
1527
|
+
console.error(error);
|
|
1528
|
+
}
|
|
1529
|
+
}
|
|
1530
|
+
|
|
1531
|
+
// Run the test
|
|
1532
|
+
example().catch(console.error);
|
|
1533
|
+
```
|
|
1534
|
+
|
|
1535
|
+
### Parameters
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
| Name | Type | Description | Notes |
|
|
1539
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1540
|
+
| **id** | `string` | VirtualMachine id | [Defaults to `undefined`] |
|
|
1541
|
+
|
|
1542
|
+
### Return type
|
|
1543
|
+
|
|
1544
|
+
[**VirtualMachineDetail**](VirtualMachineDetail.md)
|
|
1545
|
+
|
|
1546
|
+
### Authorization
|
|
1547
|
+
|
|
1548
|
+
No authorization required
|
|
1549
|
+
|
|
1550
|
+
### HTTP request headers
|
|
1551
|
+
|
|
1552
|
+
- **Content-Type**: Not defined
|
|
1553
|
+
- **Accept**: `application/json`
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
### HTTP response details
|
|
1557
|
+
| Status code | Description | Response headers |
|
|
1558
|
+
|-------------|-------------|------------------|
|
|
1559
|
+
| **200** | VirtualMachine details | - |
|
|
1560
|
+
| **404** | VirtualMachine not found | - |
|
|
1561
|
+
| **500** | Internal server error | - |
|
|
1562
|
+
|
|
1563
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
## getVMLabels
|
|
1567
|
+
|
|
1568
|
+
> VMLabelsResponse getVMLabels()
|
|
1569
|
+
|
|
1570
|
+
Get all distinct labels in use across VMs
|
|
1571
|
+
|
|
1572
|
+
### Example
|
|
1573
|
+
|
|
1574
|
+
```ts
|
|
1575
|
+
import {
|
|
1576
|
+
Configuration,
|
|
1577
|
+
DefaultApi,
|
|
1578
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1579
|
+
import type { GetVMLabelsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1580
|
+
|
|
1581
|
+
async function example() {
|
|
1582
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1583
|
+
const api = new DefaultApi();
|
|
1584
|
+
|
|
1585
|
+
try {
|
|
1586
|
+
const data = await api.getVMLabels();
|
|
1587
|
+
console.log(data);
|
|
1588
|
+
} catch (error) {
|
|
1589
|
+
console.error(error);
|
|
1590
|
+
}
|
|
1591
|
+
}
|
|
1592
|
+
|
|
1593
|
+
// Run the test
|
|
1594
|
+
example().catch(console.error);
|
|
1595
|
+
```
|
|
1596
|
+
|
|
1597
|
+
### Parameters
|
|
1598
|
+
|
|
1599
|
+
This endpoint does not need any parameter.
|
|
1600
|
+
|
|
1601
|
+
### Return type
|
|
1602
|
+
|
|
1603
|
+
[**VMLabelsResponse**](VMLabelsResponse.md)
|
|
1604
|
+
|
|
1605
|
+
### Authorization
|
|
1606
|
+
|
|
1607
|
+
No authorization required
|
|
1608
|
+
|
|
1609
|
+
### HTTP request headers
|
|
1610
|
+
|
|
1611
|
+
- **Content-Type**: Not defined
|
|
1612
|
+
- **Accept**: `application/json`
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
### HTTP response details
|
|
1616
|
+
| Status code | Description | Response headers |
|
|
1617
|
+
|-------------|-------------|------------------|
|
|
1618
|
+
| **200** | List of distinct labels | - |
|
|
1619
|
+
| **500** | Internal server error | - |
|
|
1620
|
+
|
|
1621
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
## getVMUtilization
|
|
1625
|
+
|
|
1626
|
+
> VmUtilizationDetails getVMUtilization(id)
|
|
1627
|
+
|
|
1628
|
+
Get utilization breakdown for a specific VM
|
|
1629
|
+
|
|
1630
|
+
### Example
|
|
1631
|
+
|
|
1632
|
+
```ts
|
|
1633
|
+
import {
|
|
1634
|
+
Configuration,
|
|
1635
|
+
DefaultApi,
|
|
1636
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1637
|
+
import type { GetVMUtilizationRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1638
|
+
|
|
1639
|
+
async function example() {
|
|
1640
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1641
|
+
const api = new DefaultApi();
|
|
1642
|
+
|
|
1643
|
+
const body = {
|
|
1644
|
+
// string | VirtualMachine MoRef ID
|
|
1645
|
+
id: id_example,
|
|
1646
|
+
} satisfies GetVMUtilizationRequest;
|
|
1647
|
+
|
|
1648
|
+
try {
|
|
1649
|
+
const data = await api.getVMUtilization(body);
|
|
1650
|
+
console.log(data);
|
|
1651
|
+
} catch (error) {
|
|
1652
|
+
console.error(error);
|
|
1653
|
+
}
|
|
1654
|
+
}
|
|
1655
|
+
|
|
1656
|
+
// Run the test
|
|
1657
|
+
example().catch(console.error);
|
|
1658
|
+
```
|
|
1659
|
+
|
|
1660
|
+
### Parameters
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
| Name | Type | Description | Notes |
|
|
1664
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1665
|
+
| **id** | `string` | VirtualMachine MoRef ID | [Defaults to `undefined`] |
|
|
1666
|
+
|
|
1667
|
+
### Return type
|
|
1668
|
+
|
|
1669
|
+
[**VmUtilizationDetails**](VmUtilizationDetails.md)
|
|
1670
|
+
|
|
1671
|
+
### Authorization
|
|
1672
|
+
|
|
1673
|
+
No authorization required
|
|
1674
|
+
|
|
1675
|
+
### HTTP request headers
|
|
1676
|
+
|
|
1677
|
+
- **Content-Type**: Not defined
|
|
1678
|
+
- **Accept**: `application/json`
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
### HTTP response details
|
|
1682
|
+
| Status code | Description | Response headers |
|
|
1683
|
+
|-------------|-------------|------------------|
|
|
1684
|
+
| **200** | VM utilization details | - |
|
|
1685
|
+
| **404** | No utilization data found for this VM | - |
|
|
1686
|
+
| **500** | Internal server error | - |
|
|
1687
|
+
|
|
1688
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
## getVMs
|
|
1692
|
+
|
|
1693
|
+
> VirtualMachineListResponse getVMs(byExpression, sort, page, pageSize)
|
|
1694
|
+
|
|
1695
|
+
Get list of VMs with filtering and pagination
|
|
1696
|
+
|
|
1697
|
+
### Example
|
|
1698
|
+
|
|
1699
|
+
```ts
|
|
1700
|
+
import {
|
|
1701
|
+
Configuration,
|
|
1702
|
+
DefaultApi,
|
|
1703
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1704
|
+
import type { GetVMsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1705
|
+
|
|
1706
|
+
async function example() {
|
|
1707
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1708
|
+
const api = new DefaultApi();
|
|
1709
|
+
|
|
1710
|
+
const body = {
|
|
1711
|
+
// string | Filter by expression (matches VMs with the provided expression) (optional)
|
|
1712
|
+
byExpression: exp1,
|
|
1713
|
+
// Array<string> | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues, cpuUsage, diskUsage, ramUsage, cpuAvg, memAvg. (optional)
|
|
1714
|
+
sort: ["cluster:asc","name:desc"],
|
|
1715
|
+
// number | Page number for pagination (optional)
|
|
1716
|
+
page: 56,
|
|
1717
|
+
// number | Number of items per page (optional)
|
|
1718
|
+
pageSize: 56,
|
|
1719
|
+
} satisfies GetVMsRequest;
|
|
1720
|
+
|
|
1721
|
+
try {
|
|
1722
|
+
const data = await api.getVMs(body);
|
|
1723
|
+
console.log(data);
|
|
1724
|
+
} catch (error) {
|
|
1725
|
+
console.error(error);
|
|
1726
|
+
}
|
|
1727
|
+
}
|
|
1728
|
+
|
|
1729
|
+
// Run the test
|
|
1730
|
+
example().catch(console.error);
|
|
1731
|
+
```
|
|
1732
|
+
|
|
1733
|
+
### Parameters
|
|
1734
|
+
|
|
1735
|
+
|
|
1736
|
+
| Name | Type | Description | Notes |
|
|
1737
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1738
|
+
| **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
|
|
1739
|
+
| **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, cpuUsage, diskUsage, ramUsage, cpuAvg, memAvg. | [Optional] |
|
|
1740
|
+
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
1741
|
+
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
1742
|
+
|
|
1743
|
+
### Return type
|
|
1744
|
+
|
|
1745
|
+
[**VirtualMachineListResponse**](VirtualMachineListResponse.md)
|
|
1746
|
+
|
|
1747
|
+
### Authorization
|
|
1748
|
+
|
|
1749
|
+
No authorization required
|
|
1750
|
+
|
|
1751
|
+
### HTTP request headers
|
|
1752
|
+
|
|
1753
|
+
- **Content-Type**: Not defined
|
|
1754
|
+
- **Accept**: `application/json`
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
### HTTP response details
|
|
1758
|
+
| Status code | Description | Response headers |
|
|
1759
|
+
|-------------|-------------|------------------|
|
|
1760
|
+
| **200** | List of VMs | - |
|
|
1761
|
+
| **400** | Invalid request parameters | - |
|
|
1762
|
+
| **500** | Internal server error | - |
|
|
1763
|
+
|
|
1764
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
## getVMsFilterOptions
|
|
1768
|
+
|
|
1769
|
+
> VMFilterOptionsResponse getVMsFilterOptions()
|
|
1770
|
+
|
|
1771
|
+
Get distinct filter option values for VMs
|
|
1772
|
+
|
|
1773
|
+
### Example
|
|
1774
|
+
|
|
1775
|
+
```ts
|
|
1776
|
+
import {
|
|
1777
|
+
Configuration,
|
|
1778
|
+
DefaultApi,
|
|
1779
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1780
|
+
import type { GetVMsFilterOptionsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1781
|
+
|
|
1782
|
+
async function example() {
|
|
1783
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1784
|
+
const api = new DefaultApi();
|
|
1785
|
+
|
|
1786
|
+
try {
|
|
1787
|
+
const data = await api.getVMsFilterOptions();
|
|
1788
|
+
console.log(data);
|
|
1789
|
+
} catch (error) {
|
|
1790
|
+
console.error(error);
|
|
1791
|
+
}
|
|
1792
|
+
}
|
|
1793
|
+
|
|
1794
|
+
// Run the test
|
|
1795
|
+
example().catch(console.error);
|
|
1796
|
+
```
|
|
1797
|
+
|
|
1798
|
+
### Parameters
|
|
1799
|
+
|
|
1800
|
+
This endpoint does not need any parameter.
|
|
1801
|
+
|
|
1802
|
+
### Return type
|
|
1803
|
+
|
|
1804
|
+
[**VMFilterOptionsResponse**](VMFilterOptionsResponse.md)
|
|
1805
|
+
|
|
1806
|
+
### Authorization
|
|
1807
|
+
|
|
1808
|
+
No authorization required
|
|
1809
|
+
|
|
1810
|
+
### HTTP request headers
|
|
1811
|
+
|
|
1812
|
+
- **Content-Type**: Not defined
|
|
1813
|
+
- **Accept**: `application/json`
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
### HTTP response details
|
|
1817
|
+
| Status code | Description | Response headers |
|
|
1818
|
+
|-------------|-------------|------------------|
|
|
1819
|
+
| **200** | Filter options | - |
|
|
1820
|
+
| **500** | Internal server error | - |
|
|
1821
|
+
|
|
1822
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
## getVersion
|
|
1826
|
+
|
|
1827
|
+
> VersionInfo getVersion()
|
|
1828
|
+
|
|
1829
|
+
Get agent version information
|
|
1830
|
+
|
|
1831
|
+
### Example
|
|
1832
|
+
|
|
1833
|
+
```ts
|
|
1834
|
+
import {
|
|
1835
|
+
Configuration,
|
|
1836
|
+
DefaultApi,
|
|
1837
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1838
|
+
import type { GetVersionRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1839
|
+
|
|
1840
|
+
async function example() {
|
|
1841
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1842
|
+
const api = new DefaultApi();
|
|
1843
|
+
|
|
1844
|
+
try {
|
|
1845
|
+
const data = await api.getVersion();
|
|
1846
|
+
console.log(data);
|
|
1847
|
+
} catch (error) {
|
|
1848
|
+
console.error(error);
|
|
1849
|
+
}
|
|
1850
|
+
}
|
|
1851
|
+
|
|
1852
|
+
// Run the test
|
|
1853
|
+
example().catch(console.error);
|
|
1854
|
+
```
|
|
1855
|
+
|
|
1856
|
+
### Parameters
|
|
1857
|
+
|
|
1858
|
+
This endpoint does not need any parameter.
|
|
1859
|
+
|
|
1860
|
+
### Return type
|
|
1861
|
+
|
|
1862
|
+
[**VersionInfo**](VersionInfo.md)
|
|
1863
|
+
|
|
1864
|
+
### Authorization
|
|
1865
|
+
|
|
1866
|
+
No authorization required
|
|
1867
|
+
|
|
1868
|
+
### HTTP request headers
|
|
1869
|
+
|
|
1870
|
+
- **Content-Type**: Not defined
|
|
1871
|
+
- **Accept**: `application/json`
|
|
1872
|
+
|
|
1873
|
+
|
|
1874
|
+
### HTTP response details
|
|
1875
|
+
| Status code | Description | Response headers |
|
|
1876
|
+
|-------------|-------------|------------------|
|
|
1877
|
+
| **200** | Version information | - |
|
|
1878
|
+
|
|
1879
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
## listGroups
|
|
1883
|
+
|
|
1884
|
+
> GroupListResponse listGroups(byName, page, pageSize)
|
|
1885
|
+
|
|
1886
|
+
List all groups
|
|
1887
|
+
|
|
1888
|
+
### Example
|
|
1889
|
+
|
|
1890
|
+
```ts
|
|
1891
|
+
import {
|
|
1892
|
+
Configuration,
|
|
1893
|
+
DefaultApi,
|
|
1894
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1895
|
+
import type { ListGroupsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1896
|
+
|
|
1897
|
+
async function example() {
|
|
1898
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1899
|
+
const api = new DefaultApi();
|
|
1900
|
+
|
|
1901
|
+
const body = {
|
|
1902
|
+
// string | Filter groups by name (case-insensitive substring match) (optional)
|
|
1903
|
+
byName: byName_example,
|
|
1904
|
+
// number | Page number (1-indexed) (optional)
|
|
1905
|
+
page: 56,
|
|
1906
|
+
// number | Number of groups per page (optional)
|
|
1907
|
+
pageSize: 56,
|
|
1908
|
+
} satisfies ListGroupsRequest;
|
|
1909
|
+
|
|
1910
|
+
try {
|
|
1911
|
+
const data = await api.listGroups(body);
|
|
1912
|
+
console.log(data);
|
|
1913
|
+
} catch (error) {
|
|
1914
|
+
console.error(error);
|
|
1915
|
+
}
|
|
1916
|
+
}
|
|
1917
|
+
|
|
1918
|
+
// Run the test
|
|
1919
|
+
example().catch(console.error);
|
|
1920
|
+
```
|
|
1921
|
+
|
|
1922
|
+
### Parameters
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
| Name | Type | Description | Notes |
|
|
1926
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1927
|
+
| **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
|
|
1928
|
+
| **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
|
|
1929
|
+
| **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
|
|
1930
|
+
|
|
1931
|
+
### Return type
|
|
1932
|
+
|
|
1933
|
+
[**GroupListResponse**](GroupListResponse.md)
|
|
1934
|
+
|
|
1935
|
+
### Authorization
|
|
1936
|
+
|
|
1937
|
+
No authorization required
|
|
1938
|
+
|
|
1939
|
+
### HTTP request headers
|
|
1940
|
+
|
|
1941
|
+
- **Content-Type**: Not defined
|
|
1942
|
+
- **Accept**: `application/json`
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
### HTTP response details
|
|
1946
|
+
| Status code | Description | Response headers |
|
|
1947
|
+
|-------------|-------------|------------------|
|
|
1948
|
+
| **200** | List of groups | - |
|
|
1949
|
+
| **400** | Invalid filter expression | - |
|
|
1950
|
+
| **500** | Internal server error | - |
|
|
1951
|
+
|
|
1952
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
## listRightsizingReportClusters
|
|
1956
|
+
|
|
1957
|
+
> RightsizingClusterListResponse listRightsizingReportClusters(reportId, byExpression)
|
|
1958
|
+
|
|
1959
|
+
Get cluster-level utilization aggregates for a specific report
|
|
1960
|
+
|
|
1961
|
+
### Example
|
|
1962
|
+
|
|
1963
|
+
```ts
|
|
1964
|
+
import {
|
|
1965
|
+
Configuration,
|
|
1966
|
+
DefaultApi,
|
|
1967
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
1968
|
+
import type { ListRightsizingReportClustersRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1969
|
+
|
|
1970
|
+
async function example() {
|
|
1971
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1972
|
+
const api = new DefaultApi();
|
|
1973
|
+
|
|
1974
|
+
const body = {
|
|
1975
|
+
// string | Rightsizing report UUID
|
|
1976
|
+
reportId: reportId_example,
|
|
1977
|
+
// string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
|
|
1978
|
+
byExpression: byExpression_example,
|
|
1979
|
+
} satisfies ListRightsizingReportClustersRequest;
|
|
1980
|
+
|
|
1981
|
+
try {
|
|
1982
|
+
const data = await api.listRightsizingReportClusters(body);
|
|
1983
|
+
console.log(data);
|
|
1984
|
+
} catch (error) {
|
|
1985
|
+
console.error(error);
|
|
1986
|
+
}
|
|
1987
|
+
}
|
|
1988
|
+
|
|
1989
|
+
// Run the test
|
|
1990
|
+
example().catch(console.error);
|
|
1991
|
+
```
|
|
1992
|
+
|
|
1993
|
+
### Parameters
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
| Name | Type | Description | Notes |
|
|
1997
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1998
|
+
| **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
|
|
1999
|
+
| **byExpression** | `string` | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
|
|
2000
|
+
|
|
2001
|
+
### Return type
|
|
2002
|
+
|
|
2003
|
+
[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
|
|
2004
|
+
|
|
2005
|
+
### Authorization
|
|
2006
|
+
|
|
2007
|
+
No authorization required
|
|
2008
|
+
|
|
2009
|
+
### HTTP request headers
|
|
2010
|
+
|
|
2011
|
+
- **Content-Type**: Not defined
|
|
2012
|
+
- **Accept**: `application/json`
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
### HTTP response details
|
|
2016
|
+
| Status code | Description | Response headers |
|
|
2017
|
+
|-------------|-------------|------------------|
|
|
2018
|
+
| **200** | Cluster utilization aggregates | - |
|
|
2019
|
+
| **404** | Report not found | - |
|
|
2020
|
+
| **500** | Internal server error | - |
|
|
2021
|
+
|
|
2022
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2023
|
+
|
|
2024
|
+
|
|
2025
|
+
## listRightsizingReports
|
|
2026
|
+
|
|
2027
|
+
> RightsizingReportListResponse listRightsizingReports()
|
|
2028
|
+
|
|
2029
|
+
List all rightsizing reports
|
|
2030
|
+
|
|
2031
|
+
### Example
|
|
2032
|
+
|
|
2033
|
+
```ts
|
|
2034
|
+
import {
|
|
2035
|
+
Configuration,
|
|
2036
|
+
DefaultApi,
|
|
2037
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2038
|
+
import type { ListRightsizingReportsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2039
|
+
|
|
2040
|
+
async function example() {
|
|
2041
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2042
|
+
const api = new DefaultApi();
|
|
2043
|
+
|
|
2044
|
+
try {
|
|
2045
|
+
const data = await api.listRightsizingReports();
|
|
2046
|
+
console.log(data);
|
|
2047
|
+
} catch (error) {
|
|
2048
|
+
console.error(error);
|
|
2049
|
+
}
|
|
2050
|
+
}
|
|
2051
|
+
|
|
2052
|
+
// Run the test
|
|
2053
|
+
example().catch(console.error);
|
|
2054
|
+
```
|
|
2055
|
+
|
|
2056
|
+
### Parameters
|
|
2057
|
+
|
|
2058
|
+
This endpoint does not need any parameter.
|
|
2059
|
+
|
|
2060
|
+
### Return type
|
|
2061
|
+
|
|
2062
|
+
[**RightsizingReportListResponse**](RightsizingReportListResponse.md)
|
|
2063
|
+
|
|
2064
|
+
### Authorization
|
|
2065
|
+
|
|
2066
|
+
No authorization required
|
|
2067
|
+
|
|
2068
|
+
### HTTP request headers
|
|
2069
|
+
|
|
2070
|
+
- **Content-Type**: Not defined
|
|
2071
|
+
- **Accept**: `application/json`
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
### HTTP response details
|
|
2075
|
+
| Status code | Description | Response headers |
|
|
2076
|
+
|-------------|-------------|------------------|
|
|
2077
|
+
| **200** | List of rightsizing reports | - |
|
|
2078
|
+
| **500** | Internal server error | - |
|
|
2079
|
+
|
|
2080
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
## postForecasterPairCapabilities
|
|
2084
|
+
|
|
2085
|
+
> Array<PairCapability> postForecasterPairCapabilities(pairCapabilityRequest)
|
|
2086
|
+
|
|
2087
|
+
Compute pair capabilities
|
|
2088
|
+
|
|
2089
|
+
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.
|
|
2090
|
+
|
|
2091
|
+
### Example
|
|
2092
|
+
|
|
2093
|
+
```ts
|
|
2094
|
+
import {
|
|
2095
|
+
Configuration,
|
|
2096
|
+
DefaultApi,
|
|
2097
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2098
|
+
import type { PostForecasterPairCapabilitiesRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2099
|
+
|
|
2100
|
+
async function example() {
|
|
2101
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2102
|
+
const api = new DefaultApi();
|
|
2103
|
+
|
|
2104
|
+
const body = {
|
|
2105
|
+
// PairCapabilityRequest
|
|
2106
|
+
pairCapabilityRequest: ...,
|
|
2107
|
+
} satisfies PostForecasterPairCapabilitiesRequest;
|
|
2108
|
+
|
|
2109
|
+
try {
|
|
2110
|
+
const data = await api.postForecasterPairCapabilities(body);
|
|
2111
|
+
console.log(data);
|
|
2112
|
+
} catch (error) {
|
|
2113
|
+
console.error(error);
|
|
2114
|
+
}
|
|
2115
|
+
}
|
|
2116
|
+
|
|
2117
|
+
// Run the test
|
|
2118
|
+
example().catch(console.error);
|
|
2119
|
+
```
|
|
2120
|
+
|
|
2121
|
+
### Parameters
|
|
2122
|
+
|
|
2123
|
+
|
|
2124
|
+
| Name | Type | Description | Notes |
|
|
2125
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2126
|
+
| **pairCapabilityRequest** | [PairCapabilityRequest](PairCapabilityRequest.md) | | |
|
|
2127
|
+
|
|
2128
|
+
### Return type
|
|
2129
|
+
|
|
2130
|
+
[**Array<PairCapability>**](PairCapability.md)
|
|
2131
|
+
|
|
2132
|
+
### Authorization
|
|
2133
|
+
|
|
2134
|
+
No authorization required
|
|
2135
|
+
|
|
2136
|
+
### HTTP request headers
|
|
2137
|
+
|
|
2138
|
+
- **Content-Type**: `application/json`
|
|
2139
|
+
- **Accept**: `application/json`
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
### HTTP response details
|
|
2143
|
+
| Status code | Description | Response headers |
|
|
2144
|
+
|-------------|-------------|------------------|
|
|
2145
|
+
| **200** | Capabilities per pair | - |
|
|
2146
|
+
| **400** | Datastore not found | - |
|
|
2147
|
+
| **500** | Internal server error | - |
|
|
2148
|
+
|
|
2149
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
## putCredentials
|
|
2153
|
+
|
|
2154
|
+
> CredentialStatus putCredentials(vcenterCredentials)
|
|
2155
|
+
|
|
2156
|
+
Store vCenter credentials
|
|
2157
|
+
|
|
2158
|
+
Validates credentials against vSphere, encrypts with disk-based key, and stores in the local database as the active credential set. A subsequent PUT overwrites the previously stored credentials.
|
|
2159
|
+
|
|
2160
|
+
### Example
|
|
2161
|
+
|
|
2162
|
+
```ts
|
|
2163
|
+
import {
|
|
2164
|
+
Configuration,
|
|
2165
|
+
DefaultApi,
|
|
2166
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2167
|
+
import type { PutCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2168
|
+
|
|
2169
|
+
async function example() {
|
|
2170
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2171
|
+
const api = new DefaultApi();
|
|
2172
|
+
|
|
2173
|
+
const body = {
|
|
2174
|
+
// VcenterCredentials
|
|
2175
|
+
vcenterCredentials: ...,
|
|
2176
|
+
} satisfies PutCredentialsRequest;
|
|
2177
|
+
|
|
2178
|
+
try {
|
|
2179
|
+
const data = await api.putCredentials(body);
|
|
2180
|
+
console.log(data);
|
|
2181
|
+
} catch (error) {
|
|
2182
|
+
console.error(error);
|
|
2183
|
+
}
|
|
2184
|
+
}
|
|
2185
|
+
|
|
2186
|
+
// Run the test
|
|
2187
|
+
example().catch(console.error);
|
|
2188
|
+
```
|
|
2189
|
+
|
|
2190
|
+
### Parameters
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
| Name | Type | Description | Notes |
|
|
2194
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2195
|
+
| **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
|
|
2196
|
+
|
|
2197
|
+
### Return type
|
|
2198
|
+
|
|
2199
|
+
[**CredentialStatus**](CredentialStatus.md)
|
|
2200
|
+
|
|
2201
|
+
### Authorization
|
|
2202
|
+
|
|
2203
|
+
No authorization required
|
|
2204
|
+
|
|
2205
|
+
### HTTP request headers
|
|
2206
|
+
|
|
2207
|
+
- **Content-Type**: `application/json`
|
|
2208
|
+
- **Accept**: `application/json`
|
|
2209
|
+
|
|
2210
|
+
|
|
2211
|
+
### HTTP response details
|
|
2212
|
+
| Status code | Description | Response headers |
|
|
2213
|
+
|-------------|-------------|------------------|
|
|
2214
|
+
| **201** | Credentials created and stored | - |
|
|
2215
|
+
| **200** | Credentials validated and stored | - |
|
|
2216
|
+
| **400** | Invalid credentials or unreachable vCenter | - |
|
|
2217
|
+
| **500** | Internal server error | - |
|
|
2218
|
+
|
|
2219
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2220
|
+
|
|
2221
|
+
|
|
2222
|
+
## putForecasterCredentials
|
|
2223
|
+
|
|
2224
|
+
> putForecasterCredentials(vcenterCredentials)
|
|
2225
|
+
|
|
2226
|
+
Verify vCenter credentials and permissions
|
|
2227
|
+
|
|
2228
|
+
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.
|
|
2229
|
+
|
|
2230
|
+
### Example
|
|
2231
|
+
|
|
2232
|
+
```ts
|
|
2233
|
+
import {
|
|
2234
|
+
Configuration,
|
|
2235
|
+
DefaultApi,
|
|
2236
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2237
|
+
import type { PutForecasterCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2238
|
+
|
|
2239
|
+
async function example() {
|
|
2240
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2241
|
+
const api = new DefaultApi();
|
|
2242
|
+
|
|
2243
|
+
const body = {
|
|
2244
|
+
// VcenterCredentials
|
|
2245
|
+
vcenterCredentials: ...,
|
|
2246
|
+
} satisfies PutForecasterCredentialsRequest;
|
|
2247
|
+
|
|
2248
|
+
try {
|
|
2249
|
+
const data = await api.putForecasterCredentials(body);
|
|
2250
|
+
console.log(data);
|
|
2251
|
+
} catch (error) {
|
|
2252
|
+
console.error(error);
|
|
2253
|
+
}
|
|
2254
|
+
}
|
|
2255
|
+
|
|
2256
|
+
// Run the test
|
|
2257
|
+
example().catch(console.error);
|
|
2258
|
+
```
|
|
2259
|
+
|
|
2260
|
+
### Parameters
|
|
2261
|
+
|
|
2262
|
+
|
|
2263
|
+
| Name | Type | Description | Notes |
|
|
2264
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2265
|
+
| **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
|
|
2266
|
+
|
|
2267
|
+
### Return type
|
|
2268
|
+
|
|
2269
|
+
`void` (Empty response body)
|
|
2270
|
+
|
|
2271
|
+
### Authorization
|
|
2272
|
+
|
|
2273
|
+
No authorization required
|
|
2274
|
+
|
|
2275
|
+
### HTTP request headers
|
|
2276
|
+
|
|
2277
|
+
- **Content-Type**: `application/json`
|
|
2278
|
+
- **Accept**: `application/json`
|
|
2279
|
+
|
|
2280
|
+
|
|
2281
|
+
### HTTP response details
|
|
2282
|
+
| Status code | Description | Response headers |
|
|
2283
|
+
|-------------|-------------|------------------|
|
|
2284
|
+
| **200** | Credentials valid and all required privileges are granted | - |
|
|
2285
|
+
| **400** | Invalid credentials or unreachable vCenter | - |
|
|
2286
|
+
| **403** | Authentication succeeded but user lacks required privileges | - |
|
|
2287
|
+
| **500** | Internal server error | - |
|
|
2288
|
+
|
|
2289
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
## putInspectorVddk
|
|
2293
|
+
|
|
2294
|
+
> VddkProperties putInspectorVddk(file)
|
|
2295
|
+
|
|
2296
|
+
Upload VDDK tarball
|
|
2297
|
+
|
|
2298
|
+
### Example
|
|
2299
|
+
|
|
2300
|
+
```ts
|
|
2301
|
+
import {
|
|
2302
|
+
Configuration,
|
|
2303
|
+
DefaultApi,
|
|
2304
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2305
|
+
import type { PutInspectorVddkRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2306
|
+
|
|
2307
|
+
async function example() {
|
|
2308
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2309
|
+
const api = new DefaultApi();
|
|
2310
|
+
|
|
2311
|
+
const body = {
|
|
2312
|
+
// Blob | VDDK tarball
|
|
2313
|
+
file: BINARY_DATA_HERE,
|
|
2314
|
+
} satisfies PutInspectorVddkRequest;
|
|
2315
|
+
|
|
2316
|
+
try {
|
|
2317
|
+
const data = await api.putInspectorVddk(body);
|
|
2318
|
+
console.log(data);
|
|
2319
|
+
} catch (error) {
|
|
2320
|
+
console.error(error);
|
|
2321
|
+
}
|
|
2322
|
+
}
|
|
2323
|
+
|
|
2324
|
+
// Run the test
|
|
2325
|
+
example().catch(console.error);
|
|
2326
|
+
```
|
|
2327
|
+
|
|
2328
|
+
### Parameters
|
|
2329
|
+
|
|
2330
|
+
|
|
2331
|
+
| Name | Type | Description | Notes |
|
|
2332
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2333
|
+
| **file** | `Blob` | VDDK tarball | [Defaults to `undefined`] |
|
|
2334
|
+
|
|
2335
|
+
### Return type
|
|
2336
|
+
|
|
2337
|
+
[**VddkProperties**](VddkProperties.md)
|
|
2338
|
+
|
|
2339
|
+
### Authorization
|
|
2340
|
+
|
|
2341
|
+
No authorization required
|
|
2342
|
+
|
|
2343
|
+
### HTTP request headers
|
|
2344
|
+
|
|
2345
|
+
- **Content-Type**: `multipart/form-data`
|
|
2346
|
+
- **Accept**: `application/json`
|
|
2347
|
+
|
|
2348
|
+
|
|
2349
|
+
### HTTP response details
|
|
2350
|
+
| Status code | Description | Response headers |
|
|
2351
|
+
|-------------|-------------|------------------|
|
|
2352
|
+
| **200** | Upload successful | - |
|
|
2353
|
+
| **409** | Conflict | - |
|
|
2354
|
+
| **413** | File exceeds 64MB limit | - |
|
|
2355
|
+
| **400** | Bad request | - |
|
|
2356
|
+
| **500** | Internal server error | - |
|
|
2357
|
+
|
|
2358
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2359
|
+
|
|
2360
|
+
|
|
2361
|
+
## removeVMFromInspection
|
|
2362
|
+
|
|
2363
|
+
> VmInspectionStatus removeVMFromInspection(id)
|
|
2364
|
+
|
|
2365
|
+
Remove VirtualMachine from inspection queue
|
|
2366
|
+
|
|
2367
|
+
### Example
|
|
2368
|
+
|
|
2369
|
+
```ts
|
|
2370
|
+
import {
|
|
2371
|
+
Configuration,
|
|
2372
|
+
DefaultApi,
|
|
2373
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2374
|
+
import type { RemoveVMFromInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
966
2375
|
|
|
967
2376
|
async function example() {
|
|
968
2377
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
@@ -974,7 +2383,281 @@ async function example() {
|
|
|
974
2383
|
} satisfies RemoveVMFromInspectionRequest;
|
|
975
2384
|
|
|
976
2385
|
try {
|
|
977
|
-
const data = await api.removeVMFromInspection(body);
|
|
2386
|
+
const data = await api.removeVMFromInspection(body);
|
|
2387
|
+
console.log(data);
|
|
2388
|
+
} catch (error) {
|
|
2389
|
+
console.error(error);
|
|
2390
|
+
}
|
|
2391
|
+
}
|
|
2392
|
+
|
|
2393
|
+
// Run the test
|
|
2394
|
+
example().catch(console.error);
|
|
2395
|
+
```
|
|
2396
|
+
|
|
2397
|
+
### Parameters
|
|
2398
|
+
|
|
2399
|
+
|
|
2400
|
+
| Name | Type | Description | Notes |
|
|
2401
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2402
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
2403
|
+
|
|
2404
|
+
### Return type
|
|
2405
|
+
|
|
2406
|
+
[**VmInspectionStatus**](VmInspectionStatus.md)
|
|
2407
|
+
|
|
2408
|
+
### Authorization
|
|
2409
|
+
|
|
2410
|
+
No authorization required
|
|
2411
|
+
|
|
2412
|
+
### HTTP request headers
|
|
2413
|
+
|
|
2414
|
+
- **Content-Type**: Not defined
|
|
2415
|
+
- **Accept**: `application/json`
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
### HTTP response details
|
|
2419
|
+
| Status code | Description | Response headers |
|
|
2420
|
+
|-------------|-------------|------------------|
|
|
2421
|
+
| **200** | VMs removed from queue | - |
|
|
2422
|
+
| **400** | Inspector not running or VirtualMachine cannot be canceled | - |
|
|
2423
|
+
| **404** | VirtualMachine not found or not in the queue | - |
|
|
2424
|
+
| **500** | Internal server error | - |
|
|
2425
|
+
|
|
2426
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2427
|
+
|
|
2428
|
+
|
|
2429
|
+
## setAgentMode
|
|
2430
|
+
|
|
2431
|
+
> AgentStatus setAgentMode(agentModeRequest)
|
|
2432
|
+
|
|
2433
|
+
Change agent mode
|
|
2434
|
+
|
|
2435
|
+
### Example
|
|
2436
|
+
|
|
2437
|
+
```ts
|
|
2438
|
+
import {
|
|
2439
|
+
Configuration,
|
|
2440
|
+
DefaultApi,
|
|
2441
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2442
|
+
import type { SetAgentModeRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2443
|
+
|
|
2444
|
+
async function example() {
|
|
2445
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2446
|
+
const api = new DefaultApi();
|
|
2447
|
+
|
|
2448
|
+
const body = {
|
|
2449
|
+
// AgentModeRequest
|
|
2450
|
+
agentModeRequest: ...,
|
|
2451
|
+
} satisfies SetAgentModeRequest;
|
|
2452
|
+
|
|
2453
|
+
try {
|
|
2454
|
+
const data = await api.setAgentMode(body);
|
|
2455
|
+
console.log(data);
|
|
2456
|
+
} catch (error) {
|
|
2457
|
+
console.error(error);
|
|
2458
|
+
}
|
|
2459
|
+
}
|
|
2460
|
+
|
|
2461
|
+
// Run the test
|
|
2462
|
+
example().catch(console.error);
|
|
2463
|
+
```
|
|
2464
|
+
|
|
2465
|
+
### Parameters
|
|
2466
|
+
|
|
2467
|
+
|
|
2468
|
+
| Name | Type | Description | Notes |
|
|
2469
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2470
|
+
| **agentModeRequest** | [AgentModeRequest](AgentModeRequest.md) | | |
|
|
2471
|
+
|
|
2472
|
+
### Return type
|
|
2473
|
+
|
|
2474
|
+
[**AgentStatus**](AgentStatus.md)
|
|
2475
|
+
|
|
2476
|
+
### Authorization
|
|
2477
|
+
|
|
2478
|
+
No authorization required
|
|
2479
|
+
|
|
2480
|
+
### HTTP request headers
|
|
2481
|
+
|
|
2482
|
+
- **Content-Type**: `application/json`
|
|
2483
|
+
- **Accept**: `application/json`
|
|
2484
|
+
|
|
2485
|
+
|
|
2486
|
+
### HTTP response details
|
|
2487
|
+
| Status code | Description | Response headers |
|
|
2488
|
+
|-------------|-------------|------------------|
|
|
2489
|
+
| **200** | Mode changed | - |
|
|
2490
|
+
| **400** | Invalid request | - |
|
|
2491
|
+
| **409** | Conflict | - |
|
|
2492
|
+
| **500** | Internal server error | - |
|
|
2493
|
+
|
|
2494
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
## startCollector
|
|
2498
|
+
|
|
2499
|
+
> CollectorStatus startCollector(collectorStartRequest)
|
|
2500
|
+
|
|
2501
|
+
Start inventory collection
|
|
2502
|
+
|
|
2503
|
+
### Example
|
|
2504
|
+
|
|
2505
|
+
```ts
|
|
2506
|
+
import {
|
|
2507
|
+
Configuration,
|
|
2508
|
+
DefaultApi,
|
|
2509
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2510
|
+
import type { StartCollectorRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2511
|
+
|
|
2512
|
+
async function example() {
|
|
2513
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2514
|
+
const api = new DefaultApi();
|
|
2515
|
+
|
|
2516
|
+
const body = {
|
|
2517
|
+
// CollectorStartRequest
|
|
2518
|
+
collectorStartRequest: ...,
|
|
2519
|
+
} satisfies StartCollectorRequest;
|
|
2520
|
+
|
|
2521
|
+
try {
|
|
2522
|
+
const data = await api.startCollector(body);
|
|
2523
|
+
console.log(data);
|
|
2524
|
+
} catch (error) {
|
|
2525
|
+
console.error(error);
|
|
2526
|
+
}
|
|
2527
|
+
}
|
|
2528
|
+
|
|
2529
|
+
// Run the test
|
|
2530
|
+
example().catch(console.error);
|
|
2531
|
+
```
|
|
2532
|
+
|
|
2533
|
+
### Parameters
|
|
2534
|
+
|
|
2535
|
+
|
|
2536
|
+
| Name | Type | Description | Notes |
|
|
2537
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2538
|
+
| **collectorStartRequest** | [CollectorStartRequest](CollectorStartRequest.md) | | |
|
|
2539
|
+
|
|
2540
|
+
### Return type
|
|
2541
|
+
|
|
2542
|
+
[**CollectorStatus**](CollectorStatus.md)
|
|
2543
|
+
|
|
2544
|
+
### Authorization
|
|
2545
|
+
|
|
2546
|
+
No authorization required
|
|
2547
|
+
|
|
2548
|
+
### HTTP request headers
|
|
2549
|
+
|
|
2550
|
+
- **Content-Type**: `application/json`
|
|
2551
|
+
- **Accept**: `application/json`
|
|
2552
|
+
|
|
2553
|
+
|
|
2554
|
+
### HTTP response details
|
|
2555
|
+
| Status code | Description | Response headers |
|
|
2556
|
+
|-------------|-------------|------------------|
|
|
2557
|
+
| **202** | Collection started | - |
|
|
2558
|
+
| **400** | Invalid request | - |
|
|
2559
|
+
| **409** | Collection already in progress | - |
|
|
2560
|
+
| **500** | Internal server error | - |
|
|
2561
|
+
|
|
2562
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2563
|
+
|
|
2564
|
+
|
|
2565
|
+
## startForecaster
|
|
2566
|
+
|
|
2567
|
+
> ForecasterStatus startForecaster(forecasterStartRequest)
|
|
2568
|
+
|
|
2569
|
+
Start benchmark
|
|
2570
|
+
|
|
2571
|
+
Starts async benchmarking for one or more datastore pairs. Credentials can be passed inline or omitted if previously provided in an earlier request.
|
|
2572
|
+
|
|
2573
|
+
### Example
|
|
2574
|
+
|
|
2575
|
+
```ts
|
|
2576
|
+
import {
|
|
2577
|
+
Configuration,
|
|
2578
|
+
DefaultApi,
|
|
2579
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2580
|
+
import type { StartForecasterRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2581
|
+
|
|
2582
|
+
async function example() {
|
|
2583
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2584
|
+
const api = new DefaultApi();
|
|
2585
|
+
|
|
2586
|
+
const body = {
|
|
2587
|
+
// ForecasterStartRequest
|
|
2588
|
+
forecasterStartRequest: ...,
|
|
2589
|
+
} satisfies StartForecasterRequest;
|
|
2590
|
+
|
|
2591
|
+
try {
|
|
2592
|
+
const data = await api.startForecaster(body);
|
|
2593
|
+
console.log(data);
|
|
2594
|
+
} catch (error) {
|
|
2595
|
+
console.error(error);
|
|
2596
|
+
}
|
|
2597
|
+
}
|
|
2598
|
+
|
|
2599
|
+
// Run the test
|
|
2600
|
+
example().catch(console.error);
|
|
2601
|
+
```
|
|
2602
|
+
|
|
2603
|
+
### Parameters
|
|
2604
|
+
|
|
2605
|
+
|
|
2606
|
+
| Name | Type | Description | Notes |
|
|
2607
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2608
|
+
| **forecasterStartRequest** | [ForecasterStartRequest](ForecasterStartRequest.md) | | |
|
|
2609
|
+
|
|
2610
|
+
### Return type
|
|
2611
|
+
|
|
2612
|
+
[**ForecasterStatus**](ForecasterStatus.md)
|
|
2613
|
+
|
|
2614
|
+
### Authorization
|
|
2615
|
+
|
|
2616
|
+
No authorization required
|
|
2617
|
+
|
|
2618
|
+
### HTTP request headers
|
|
2619
|
+
|
|
2620
|
+
- **Content-Type**: `application/json`
|
|
2621
|
+
- **Accept**: `application/json`
|
|
2622
|
+
|
|
2623
|
+
|
|
2624
|
+
### HTTP response details
|
|
2625
|
+
| Status code | Description | Response headers |
|
|
2626
|
+
|-------------|-------------|------------------|
|
|
2627
|
+
| **202** | Benchmark started | - |
|
|
2628
|
+
| **400** | Invalid credentials, validation error, or pair limit exceeded | - |
|
|
2629
|
+
| **409** | Another benchmark is already running | - |
|
|
2630
|
+
| **500** | Internal server error | - |
|
|
2631
|
+
|
|
2632
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2633
|
+
|
|
2634
|
+
|
|
2635
|
+
## startInspection
|
|
2636
|
+
|
|
2637
|
+
> InspectorStatus startInspection(startInspectionRequest)
|
|
2638
|
+
|
|
2639
|
+
Start inspection for VMs
|
|
2640
|
+
|
|
2641
|
+
### Example
|
|
2642
|
+
|
|
2643
|
+
```ts
|
|
2644
|
+
import {
|
|
2645
|
+
Configuration,
|
|
2646
|
+
DefaultApi,
|
|
2647
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
2648
|
+
import type { StartInspectionOperationRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
2649
|
+
|
|
2650
|
+
async function example() {
|
|
2651
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
2652
|
+
const api = new DefaultApi();
|
|
2653
|
+
|
|
2654
|
+
const body = {
|
|
2655
|
+
// StartInspectionRequest
|
|
2656
|
+
startInspectionRequest: ...,
|
|
2657
|
+
} satisfies StartInspectionOperationRequest;
|
|
2658
|
+
|
|
2659
|
+
try {
|
|
2660
|
+
const data = await api.startInspection(body);
|
|
978
2661
|
console.log(data);
|
|
979
2662
|
} catch (error) {
|
|
980
2663
|
console.error(error);
|
|
@@ -990,11 +2673,11 @@ example().catch(console.error);
|
|
|
990
2673
|
|
|
991
2674
|
| Name | Type | Description | Notes |
|
|
992
2675
|
|------------- | ------------- | ------------- | -------------|
|
|
993
|
-
| **
|
|
2676
|
+
| **startInspectionRequest** | [StartInspectionRequest](StartInspectionRequest.md) | | |
|
|
994
2677
|
|
|
995
2678
|
### Return type
|
|
996
2679
|
|
|
997
|
-
[**
|
|
2680
|
+
[**InspectorStatus**](InspectorStatus.md)
|
|
998
2681
|
|
|
999
2682
|
### Authorization
|
|
1000
2683
|
|
|
@@ -1002,26 +2685,26 @@ No authorization required
|
|
|
1002
2685
|
|
|
1003
2686
|
### HTTP request headers
|
|
1004
2687
|
|
|
1005
|
-
- **Content-Type**:
|
|
2688
|
+
- **Content-Type**: `application/json`
|
|
1006
2689
|
- **Accept**: `application/json`
|
|
1007
2690
|
|
|
1008
2691
|
|
|
1009
2692
|
### HTTP response details
|
|
1010
2693
|
| Status code | Description | Response headers |
|
|
1011
2694
|
|-------------|-------------|------------------|
|
|
1012
|
-
| **
|
|
2695
|
+
| **202** | Inspection started | - |
|
|
1013
2696
|
| **400** | Invalid request | - |
|
|
1014
|
-
| **
|
|
2697
|
+
| **409** | Inspector already running | - |
|
|
1015
2698
|
| **500** | Internal server error | - |
|
|
1016
2699
|
|
|
1017
2700
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1018
2701
|
|
|
1019
2702
|
|
|
1020
|
-
##
|
|
2703
|
+
## stopCollector
|
|
1021
2704
|
|
|
1022
|
-
>
|
|
2705
|
+
> stopCollector()
|
|
1023
2706
|
|
|
1024
|
-
|
|
2707
|
+
Stop collection
|
|
1025
2708
|
|
|
1026
2709
|
### Example
|
|
1027
2710
|
|
|
@@ -1030,19 +2713,14 @@ import {
|
|
|
1030
2713
|
Configuration,
|
|
1031
2714
|
DefaultApi,
|
|
1032
2715
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1033
|
-
import type {
|
|
2716
|
+
import type { StopCollectorRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1034
2717
|
|
|
1035
2718
|
async function example() {
|
|
1036
2719
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1037
2720
|
const api = new DefaultApi();
|
|
1038
2721
|
|
|
1039
|
-
const body = {
|
|
1040
|
-
// AgentModeRequest
|
|
1041
|
-
agentModeRequest: ...,
|
|
1042
|
-
} satisfies SetAgentModeRequest;
|
|
1043
|
-
|
|
1044
2722
|
try {
|
|
1045
|
-
const data = await api.
|
|
2723
|
+
const data = await api.stopCollector();
|
|
1046
2724
|
console.log(data);
|
|
1047
2725
|
} catch (error) {
|
|
1048
2726
|
console.error(error);
|
|
@@ -1055,14 +2733,11 @@ example().catch(console.error);
|
|
|
1055
2733
|
|
|
1056
2734
|
### Parameters
|
|
1057
2735
|
|
|
1058
|
-
|
|
1059
|
-
| Name | Type | Description | Notes |
|
|
1060
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1061
|
-
| **agentModeRequest** | [AgentModeRequest](AgentModeRequest.md) | | |
|
|
2736
|
+
This endpoint does not need any parameter.
|
|
1062
2737
|
|
|
1063
2738
|
### Return type
|
|
1064
2739
|
|
|
1065
|
-
|
|
2740
|
+
`void` (Empty response body)
|
|
1066
2741
|
|
|
1067
2742
|
### Authorization
|
|
1068
2743
|
|
|
@@ -1070,26 +2745,26 @@ No authorization required
|
|
|
1070
2745
|
|
|
1071
2746
|
### HTTP request headers
|
|
1072
2747
|
|
|
1073
|
-
- **Content-Type**:
|
|
1074
|
-
- **Accept**:
|
|
2748
|
+
- **Content-Type**: Not defined
|
|
2749
|
+
- **Accept**: Not defined
|
|
1075
2750
|
|
|
1076
2751
|
|
|
1077
2752
|
### HTTP response details
|
|
1078
2753
|
| Status code | Description | Response headers |
|
|
1079
2754
|
|-------------|-------------|------------------|
|
|
1080
|
-
| **
|
|
1081
|
-
| **400** | Invalid request | - |
|
|
1082
|
-
| **409** | Conflict | - |
|
|
2755
|
+
| **204** | Collection stopped | - |
|
|
1083
2756
|
| **500** | Internal server error | - |
|
|
1084
2757
|
|
|
1085
2758
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1086
2759
|
|
|
1087
2760
|
|
|
1088
|
-
##
|
|
2761
|
+
## stopForecaster
|
|
1089
2762
|
|
|
1090
|
-
>
|
|
2763
|
+
> ForecasterStatus stopForecaster()
|
|
1091
2764
|
|
|
1092
|
-
|
|
2765
|
+
Cancel benchmark
|
|
2766
|
+
|
|
2767
|
+
Stops the running benchmark. Already-completed runs are preserved in the database.
|
|
1093
2768
|
|
|
1094
2769
|
### Example
|
|
1095
2770
|
|
|
@@ -1098,19 +2773,14 @@ import {
|
|
|
1098
2773
|
Configuration,
|
|
1099
2774
|
DefaultApi,
|
|
1100
2775
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1101
|
-
import type {
|
|
2776
|
+
import type { StopForecasterRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1102
2777
|
|
|
1103
2778
|
async function example() {
|
|
1104
2779
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1105
2780
|
const api = new DefaultApi();
|
|
1106
2781
|
|
|
1107
|
-
const body = {
|
|
1108
|
-
// CollectorStartRequest
|
|
1109
|
-
collectorStartRequest: ...,
|
|
1110
|
-
} satisfies StartCollectorRequest;
|
|
1111
|
-
|
|
1112
2782
|
try {
|
|
1113
|
-
const data = await api.
|
|
2783
|
+
const data = await api.stopForecaster();
|
|
1114
2784
|
console.log(data);
|
|
1115
2785
|
} catch (error) {
|
|
1116
2786
|
console.error(error);
|
|
@@ -1123,14 +2793,11 @@ example().catch(console.error);
|
|
|
1123
2793
|
|
|
1124
2794
|
### Parameters
|
|
1125
2795
|
|
|
1126
|
-
|
|
1127
|
-
| Name | Type | Description | Notes |
|
|
1128
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1129
|
-
| **collectorStartRequest** | [CollectorStartRequest](CollectorStartRequest.md) | | |
|
|
2796
|
+
This endpoint does not need any parameter.
|
|
1130
2797
|
|
|
1131
2798
|
### Return type
|
|
1132
2799
|
|
|
1133
|
-
[**
|
|
2800
|
+
[**ForecasterStatus**](ForecasterStatus.md)
|
|
1134
2801
|
|
|
1135
2802
|
### Authorization
|
|
1136
2803
|
|
|
@@ -1138,26 +2805,27 @@ No authorization required
|
|
|
1138
2805
|
|
|
1139
2806
|
### HTTP request headers
|
|
1140
2807
|
|
|
1141
|
-
- **Content-Type**:
|
|
2808
|
+
- **Content-Type**: Not defined
|
|
1142
2809
|
- **Accept**: `application/json`
|
|
1143
2810
|
|
|
1144
2811
|
|
|
1145
2812
|
### HTTP response details
|
|
1146
2813
|
| Status code | Description | Response headers |
|
|
1147
2814
|
|-------------|-------------|------------------|
|
|
1148
|
-
| **202** |
|
|
1149
|
-
| **
|
|
1150
|
-
| **409** | Collection already in progress | - |
|
|
2815
|
+
| **202** | Benchmark canceled, service returned to ready | - |
|
|
2816
|
+
| **404** | No benchmark is running | - |
|
|
1151
2817
|
| **500** | Internal server error | - |
|
|
1152
2818
|
|
|
1153
2819
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1154
2820
|
|
|
1155
2821
|
|
|
1156
|
-
##
|
|
2822
|
+
## stopForecasterPair
|
|
1157
2823
|
|
|
1158
|
-
>
|
|
2824
|
+
> StopForecasterPair202Response stopForecasterPair(name)
|
|
1159
2825
|
|
|
1160
|
-
|
|
2826
|
+
Cancel a single pair
|
|
2827
|
+
|
|
2828
|
+
Cancels the benchmark for a specific pair by name. The forecaster continues running if other pairs are still active.
|
|
1161
2829
|
|
|
1162
2830
|
### Example
|
|
1163
2831
|
|
|
@@ -1166,19 +2834,19 @@ import {
|
|
|
1166
2834
|
Configuration,
|
|
1167
2835
|
DefaultApi,
|
|
1168
2836
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1169
|
-
import type {
|
|
2837
|
+
import type { StopForecasterPairRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1170
2838
|
|
|
1171
2839
|
async function example() {
|
|
1172
2840
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1173
2841
|
const api = new DefaultApi();
|
|
1174
2842
|
|
|
1175
2843
|
const body = {
|
|
1176
|
-
//
|
|
1177
|
-
|
|
1178
|
-
} satisfies
|
|
2844
|
+
// string | Pair name as specified in the start request
|
|
2845
|
+
name: name_example,
|
|
2846
|
+
} satisfies StopForecasterPairRequest;
|
|
1179
2847
|
|
|
1180
2848
|
try {
|
|
1181
|
-
const data = await api.
|
|
2849
|
+
const data = await api.stopForecasterPair(body);
|
|
1182
2850
|
console.log(data);
|
|
1183
2851
|
} catch (error) {
|
|
1184
2852
|
console.error(error);
|
|
@@ -1194,11 +2862,11 @@ example().catch(console.error);
|
|
|
1194
2862
|
|
|
1195
2863
|
| Name | Type | Description | Notes |
|
|
1196
2864
|
|------------- | ------------- | ------------- | -------------|
|
|
1197
|
-
| **
|
|
2865
|
+
| **name** | `string` | Pair name as specified in the start request | [Defaults to `undefined`] |
|
|
1198
2866
|
|
|
1199
2867
|
### Return type
|
|
1200
2868
|
|
|
1201
|
-
[**
|
|
2869
|
+
[**StopForecasterPair202Response**](StopForecasterPair202Response.md)
|
|
1202
2870
|
|
|
1203
2871
|
### Authorization
|
|
1204
2872
|
|
|
@@ -1206,26 +2874,25 @@ No authorization required
|
|
|
1206
2874
|
|
|
1207
2875
|
### HTTP request headers
|
|
1208
2876
|
|
|
1209
|
-
- **Content-Type**:
|
|
2877
|
+
- **Content-Type**: Not defined
|
|
1210
2878
|
- **Accept**: `application/json`
|
|
1211
2879
|
|
|
1212
2880
|
|
|
1213
2881
|
### HTTP response details
|
|
1214
2882
|
| Status code | Description | Response headers |
|
|
1215
2883
|
|-------------|-------------|------------------|
|
|
1216
|
-
| **202** |
|
|
1217
|
-
| **
|
|
1218
|
-
| **409** | Inspector already running | - |
|
|
2884
|
+
| **202** | Pair canceled | - |
|
|
2885
|
+
| **404** | No benchmark running, or pair not found / already finished | - |
|
|
1219
2886
|
| **500** | Internal server error | - |
|
|
1220
2887
|
|
|
1221
2888
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1222
2889
|
|
|
1223
2890
|
|
|
1224
|
-
##
|
|
2891
|
+
## stopInspection
|
|
1225
2892
|
|
|
1226
|
-
>
|
|
2893
|
+
> InspectorStatus stopInspection()
|
|
1227
2894
|
|
|
1228
|
-
Stop
|
|
2895
|
+
Stop inspector entirely
|
|
1229
2896
|
|
|
1230
2897
|
### Example
|
|
1231
2898
|
|
|
@@ -1234,14 +2901,14 @@ import {
|
|
|
1234
2901
|
Configuration,
|
|
1235
2902
|
DefaultApi,
|
|
1236
2903
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1237
|
-
import type {
|
|
2904
|
+
import type { StopInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1238
2905
|
|
|
1239
2906
|
async function example() {
|
|
1240
2907
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1241
2908
|
const api = new DefaultApi();
|
|
1242
2909
|
|
|
1243
2910
|
try {
|
|
1244
|
-
const data = await api.
|
|
2911
|
+
const data = await api.stopInspection();
|
|
1245
2912
|
console.log(data);
|
|
1246
2913
|
} catch (error) {
|
|
1247
2914
|
console.error(error);
|
|
@@ -1258,7 +2925,7 @@ This endpoint does not need any parameter.
|
|
|
1258
2925
|
|
|
1259
2926
|
### Return type
|
|
1260
2927
|
|
|
1261
|
-
|
|
2928
|
+
[**InspectorStatus**](InspectorStatus.md)
|
|
1262
2929
|
|
|
1263
2930
|
### Authorization
|
|
1264
2931
|
|
|
@@ -1267,23 +2934,25 @@ No authorization required
|
|
|
1267
2934
|
### HTTP request headers
|
|
1268
2935
|
|
|
1269
2936
|
- **Content-Type**: Not defined
|
|
1270
|
-
- **Accept**:
|
|
2937
|
+
- **Accept**: `application/json`
|
|
1271
2938
|
|
|
1272
2939
|
|
|
1273
2940
|
### HTTP response details
|
|
1274
2941
|
| Status code | Description | Response headers |
|
|
1275
2942
|
|-------------|-------------|------------------|
|
|
1276
|
-
| **
|
|
2943
|
+
| **200** | VMs removed from queue | - |
|
|
2944
|
+
| **400** | Already in canceling state | - |
|
|
2945
|
+
| **404** | Inspector not running | - |
|
|
1277
2946
|
| **500** | Internal server error | - |
|
|
1278
2947
|
|
|
1279
2948
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1280
2949
|
|
|
1281
2950
|
|
|
1282
|
-
##
|
|
2951
|
+
## triggerRightsizingCollection
|
|
1283
2952
|
|
|
1284
|
-
>
|
|
2953
|
+
> RightsizingReportSummary triggerRightsizingCollection(rightsizingCollectRequest)
|
|
1285
2954
|
|
|
1286
|
-
|
|
2955
|
+
Trigger rightsizing metrics collection
|
|
1287
2956
|
|
|
1288
2957
|
### Example
|
|
1289
2958
|
|
|
@@ -1292,14 +2961,19 @@ import {
|
|
|
1292
2961
|
Configuration,
|
|
1293
2962
|
DefaultApi,
|
|
1294
2963
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1295
|
-
import type {
|
|
2964
|
+
import type { TriggerRightsizingCollectionRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1296
2965
|
|
|
1297
2966
|
async function example() {
|
|
1298
2967
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1299
2968
|
const api = new DefaultApi();
|
|
1300
2969
|
|
|
2970
|
+
const body = {
|
|
2971
|
+
// RightsizingCollectRequest
|
|
2972
|
+
rightsizingCollectRequest: ...,
|
|
2973
|
+
} satisfies TriggerRightsizingCollectionRequest;
|
|
2974
|
+
|
|
1301
2975
|
try {
|
|
1302
|
-
const data = await api.
|
|
2976
|
+
const data = await api.triggerRightsizingCollection(body);
|
|
1303
2977
|
console.log(data);
|
|
1304
2978
|
} catch (error) {
|
|
1305
2979
|
console.error(error);
|
|
@@ -1312,11 +2986,14 @@ example().catch(console.error);
|
|
|
1312
2986
|
|
|
1313
2987
|
### Parameters
|
|
1314
2988
|
|
|
1315
|
-
|
|
2989
|
+
|
|
2990
|
+
| Name | Type | Description | Notes |
|
|
2991
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2992
|
+
| **rightsizingCollectRequest** | [RightsizingCollectRequest](RightsizingCollectRequest.md) | | |
|
|
1316
2993
|
|
|
1317
2994
|
### Return type
|
|
1318
2995
|
|
|
1319
|
-
[**
|
|
2996
|
+
[**RightsizingReportSummary**](RightsizingReportSummary.md)
|
|
1320
2997
|
|
|
1321
2998
|
### Authorization
|
|
1322
2999
|
|
|
@@ -1324,16 +3001,15 @@ No authorization required
|
|
|
1324
3001
|
|
|
1325
3002
|
### HTTP request headers
|
|
1326
3003
|
|
|
1327
|
-
- **Content-Type**:
|
|
3004
|
+
- **Content-Type**: `application/json`
|
|
1328
3005
|
- **Accept**: `application/json`
|
|
1329
3006
|
|
|
1330
3007
|
|
|
1331
3008
|
### HTTP response details
|
|
1332
3009
|
| Status code | Description | Response headers |
|
|
1333
3010
|
|-------------|-------------|------------------|
|
|
1334
|
-
| **
|
|
1335
|
-
| **400** |
|
|
1336
|
-
| **404** | Inspector not running | - |
|
|
3011
|
+
| **202** | Collection triggered; returns report | - |
|
|
3012
|
+
| **400** | Invalid request | - |
|
|
1337
3013
|
| **500** | Internal server error | - |
|
|
1338
3014
|
|
|
1339
3015
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -1410,11 +3086,11 @@ No authorization required
|
|
|
1410
3086
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1411
3087
|
|
|
1412
3088
|
|
|
1413
|
-
##
|
|
3089
|
+
## updateLabelVMs
|
|
1414
3090
|
|
|
1415
|
-
>
|
|
3091
|
+
> updateLabelVMs(label, updateLabelVMsRequest)
|
|
1416
3092
|
|
|
1417
|
-
|
|
3093
|
+
Modify label VM membership (add/remove label to/from VMs)
|
|
1418
3094
|
|
|
1419
3095
|
### Example
|
|
1420
3096
|
|
|
@@ -1423,19 +3099,21 @@ import {
|
|
|
1423
3099
|
Configuration,
|
|
1424
3100
|
DefaultApi,
|
|
1425
3101
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
1426
|
-
import type {
|
|
3102
|
+
import type { UpdateLabelVMsOperationRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
1427
3103
|
|
|
1428
3104
|
async function example() {
|
|
1429
3105
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
1430
3106
|
const api = new DefaultApi();
|
|
1431
3107
|
|
|
1432
3108
|
const body = {
|
|
1433
|
-
//
|
|
1434
|
-
|
|
1435
|
-
|
|
3109
|
+
// string | The label to modify
|
|
3110
|
+
label: label_example,
|
|
3111
|
+
// UpdateLabelVMsRequest
|
|
3112
|
+
updateLabelVMsRequest: ...,
|
|
3113
|
+
} satisfies UpdateLabelVMsOperationRequest;
|
|
1436
3114
|
|
|
1437
3115
|
try {
|
|
1438
|
-
const data = await api.
|
|
3116
|
+
const data = await api.updateLabelVMs(body);
|
|
1439
3117
|
console.log(data);
|
|
1440
3118
|
} catch (error) {
|
|
1441
3119
|
console.error(error);
|
|
@@ -1451,11 +3129,12 @@ example().catch(console.error);
|
|
|
1451
3129
|
|
|
1452
3130
|
| Name | Type | Description | Notes |
|
|
1453
3131
|
|------------- | ------------- | ------------- | -------------|
|
|
1454
|
-
| **
|
|
3132
|
+
| **label** | `string` | The label to modify | [Defaults to `undefined`] |
|
|
3133
|
+
| **updateLabelVMsRequest** | [UpdateLabelVMsRequest](UpdateLabelVMsRequest.md) | | |
|
|
1455
3134
|
|
|
1456
3135
|
### Return type
|
|
1457
3136
|
|
|
1458
|
-
|
|
3137
|
+
`void` (Empty response body)
|
|
1459
3138
|
|
|
1460
3139
|
### Authorization
|
|
1461
3140
|
|
|
@@ -1463,17 +3142,154 @@ No authorization required
|
|
|
1463
3142
|
|
|
1464
3143
|
### HTTP request headers
|
|
1465
3144
|
|
|
1466
|
-
- **Content-Type**: `
|
|
1467
|
-
- **Accept**:
|
|
3145
|
+
- **Content-Type**: `application/json`
|
|
3146
|
+
- **Accept**: Not defined
|
|
1468
3147
|
|
|
1469
3148
|
|
|
1470
3149
|
### HTTP response details
|
|
1471
3150
|
| Status code | Description | Response headers |
|
|
1472
3151
|
|-------------|-------------|------------------|
|
|
1473
|
-
| **200** |
|
|
1474
|
-
| **
|
|
1475
|
-
| **
|
|
1476
|
-
| **
|
|
3152
|
+
| **200** | Label operation completed successfully (all VMs updated atomically) | - |
|
|
3153
|
+
| **400** | Invalid request | - |
|
|
3154
|
+
| **404** | One or more VMs not found (no changes made) | - |
|
|
3155
|
+
| **500** | Internal server error | - |
|
|
3156
|
+
|
|
3157
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3158
|
+
|
|
3159
|
+
|
|
3160
|
+
## updateVM
|
|
3161
|
+
|
|
3162
|
+
> updateVM(id, virtualMachineUpdateRequest)
|
|
3163
|
+
|
|
3164
|
+
Update VM properties
|
|
3165
|
+
|
|
3166
|
+
### Example
|
|
3167
|
+
|
|
3168
|
+
```ts
|
|
3169
|
+
import {
|
|
3170
|
+
Configuration,
|
|
3171
|
+
DefaultApi,
|
|
3172
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
3173
|
+
import type { UpdateVMRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
3174
|
+
|
|
3175
|
+
async function example() {
|
|
3176
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
3177
|
+
const api = new DefaultApi();
|
|
3178
|
+
|
|
3179
|
+
const body = {
|
|
3180
|
+
// string | VirtualMachine id
|
|
3181
|
+
id: id_example,
|
|
3182
|
+
// VirtualMachineUpdateRequest
|
|
3183
|
+
virtualMachineUpdateRequest: ...,
|
|
3184
|
+
} satisfies UpdateVMRequest;
|
|
3185
|
+
|
|
3186
|
+
try {
|
|
3187
|
+
const data = await api.updateVM(body);
|
|
3188
|
+
console.log(data);
|
|
3189
|
+
} catch (error) {
|
|
3190
|
+
console.error(error);
|
|
3191
|
+
}
|
|
3192
|
+
}
|
|
3193
|
+
|
|
3194
|
+
// Run the test
|
|
3195
|
+
example().catch(console.error);
|
|
3196
|
+
```
|
|
3197
|
+
|
|
3198
|
+
### Parameters
|
|
3199
|
+
|
|
3200
|
+
|
|
3201
|
+
| Name | Type | Description | Notes |
|
|
3202
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3203
|
+
| **id** | `string` | VirtualMachine id | [Defaults to `undefined`] |
|
|
3204
|
+
| **virtualMachineUpdateRequest** | [VirtualMachineUpdateRequest](VirtualMachineUpdateRequest.md) | | |
|
|
3205
|
+
|
|
3206
|
+
### Return type
|
|
3207
|
+
|
|
3208
|
+
`void` (Empty response body)
|
|
3209
|
+
|
|
3210
|
+
### Authorization
|
|
3211
|
+
|
|
3212
|
+
No authorization required
|
|
3213
|
+
|
|
3214
|
+
### HTTP request headers
|
|
3215
|
+
|
|
3216
|
+
- **Content-Type**: `application/json`
|
|
3217
|
+
- **Accept**: Not defined
|
|
3218
|
+
|
|
3219
|
+
|
|
3220
|
+
### HTTP response details
|
|
3221
|
+
| Status code | Description | Response headers |
|
|
3222
|
+
|-------------|-------------|------------------|
|
|
3223
|
+
| **200** | VM updated successfully | - |
|
|
3224
|
+
| **400** | Invalid request | - |
|
|
3225
|
+
| **404** | VM not found | - |
|
|
3226
|
+
| **500** | Internal server error | - |
|
|
3227
|
+
|
|
3228
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3229
|
+
|
|
3230
|
+
|
|
3231
|
+
## validateInspectorCredentials
|
|
3232
|
+
|
|
3233
|
+
> validateInspectorCredentials(vcenterCredentials)
|
|
3234
|
+
|
|
3235
|
+
Validate vCenter credentials for inspector
|
|
3236
|
+
|
|
3237
|
+
### Example
|
|
3238
|
+
|
|
3239
|
+
```ts
|
|
3240
|
+
import {
|
|
3241
|
+
Configuration,
|
|
3242
|
+
DefaultApi,
|
|
3243
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
3244
|
+
import type { ValidateInspectorCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
3245
|
+
|
|
3246
|
+
async function example() {
|
|
3247
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
3248
|
+
const api = new DefaultApi();
|
|
3249
|
+
|
|
3250
|
+
const body = {
|
|
3251
|
+
// VcenterCredentials
|
|
3252
|
+
vcenterCredentials: ...,
|
|
3253
|
+
} satisfies ValidateInspectorCredentialsRequest;
|
|
3254
|
+
|
|
3255
|
+
try {
|
|
3256
|
+
const data = await api.validateInspectorCredentials(body);
|
|
3257
|
+
console.log(data);
|
|
3258
|
+
} catch (error) {
|
|
3259
|
+
console.error(error);
|
|
3260
|
+
}
|
|
3261
|
+
}
|
|
3262
|
+
|
|
3263
|
+
// Run the test
|
|
3264
|
+
example().catch(console.error);
|
|
3265
|
+
```
|
|
3266
|
+
|
|
3267
|
+
### Parameters
|
|
3268
|
+
|
|
3269
|
+
|
|
3270
|
+
| Name | Type | Description | Notes |
|
|
3271
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3272
|
+
| **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
|
|
3273
|
+
|
|
3274
|
+
### Return type
|
|
3275
|
+
|
|
3276
|
+
`void` (Empty response body)
|
|
3277
|
+
|
|
3278
|
+
### Authorization
|
|
3279
|
+
|
|
3280
|
+
No authorization required
|
|
3281
|
+
|
|
3282
|
+
### HTTP request headers
|
|
3283
|
+
|
|
3284
|
+
- **Content-Type**: `application/json`
|
|
3285
|
+
- **Accept**: Not defined
|
|
3286
|
+
|
|
3287
|
+
|
|
3288
|
+
### HTTP response details
|
|
3289
|
+
| Status code | Description | Response headers |
|
|
3290
|
+
|-------------|-------------|------------------|
|
|
3291
|
+
| **200** | Credentials updated successfully | - |
|
|
3292
|
+
| **400** | Bad Credentials | - |
|
|
1477
3293
|
| **500** | Internal server error | - |
|
|
1478
3294
|
|
|
1479
3295
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|