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