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