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