@openshift-migration-advisor/agent-sdk 0.8.0 → 0.12.0-914fe80385ee

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.
Files changed (202) hide show
  1. package/.openapi-generator/FILES +50 -2
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +56 -17
  4. package/dist/apis/DefaultApi.d.ts +706 -126
  5. package/dist/apis/DefaultApi.js +916 -285
  6. package/dist/esm/apis/DefaultApi.d.ts +706 -126
  7. package/dist/esm/apis/DefaultApi.js +898 -267
  8. package/dist/esm/models/BenchmarkRun.d.ts +104 -0
  9. package/dist/esm/models/BenchmarkRun.js +85 -0
  10. package/dist/esm/models/DatastoreDetail.d.ts +90 -0
  11. package/dist/esm/models/DatastoreDetail.js +74 -0
  12. package/dist/esm/models/DatastorePair.d.ts +50 -0
  13. package/dist/esm/models/DatastorePair.js +53 -0
  14. package/dist/esm/models/EstimateRange.d.ts +44 -0
  15. package/dist/esm/models/EstimateRange.js +45 -0
  16. package/dist/esm/models/ForecastStats.d.ts +87 -0
  17. package/dist/esm/models/ForecastStats.js +64 -0
  18. package/dist/esm/models/ForecasterDatastoresRequest.d.ts +33 -0
  19. package/dist/esm/models/ForecasterDatastoresRequest.js +42 -0
  20. package/dist/esm/models/ForecasterPairStatus.d.ts +98 -0
  21. package/dist/esm/models/ForecasterPairStatus.js +82 -0
  22. package/dist/esm/models/ForecasterStartRequest.d.ts +58 -0
  23. package/dist/esm/models/ForecasterStartRequest.js +53 -0
  24. package/dist/esm/models/ForecasterStatus.d.ts +47 -0
  25. package/dist/esm/models/ForecasterStatus.js +53 -0
  26. package/dist/esm/models/InspectorStatus.d.ts +20 -7
  27. package/dist/esm/models/InspectorStatus.js +12 -7
  28. package/dist/esm/models/PairCapability.d.ts +60 -0
  29. package/dist/esm/models/PairCapability.js +64 -0
  30. package/dist/esm/models/PairCapabilityRequest.d.ts +40 -0
  31. package/dist/esm/models/PairCapabilityRequest.js +47 -0
  32. package/dist/esm/models/PutForecasterCredentials403Response.d.ts +38 -0
  33. package/dist/esm/models/PutForecasterCredentials403Response.js +43 -0
  34. package/dist/esm/models/RightsizingClusterListResponse.d.ts +39 -0
  35. package/dist/esm/models/RightsizingClusterListResponse.js +48 -0
  36. package/dist/esm/models/RightsizingClusterUtilization.d.ts +112 -0
  37. package/dist/esm/models/RightsizingClusterUtilization.js +95 -0
  38. package/dist/esm/models/RightsizingCollectRequest.d.ts +70 -0
  39. package/dist/esm/models/RightsizingCollectRequest.js +56 -0
  40. package/dist/esm/models/RightsizingMetricStats.d.ts +62 -0
  41. package/dist/esm/models/RightsizingMetricStats.js +63 -0
  42. package/dist/esm/models/RightsizingReport.d.ts +81 -0
  43. package/dist/esm/models/RightsizingReport.js +76 -0
  44. package/dist/esm/models/RightsizingReportListResponse.d.ts +39 -0
  45. package/dist/esm/models/RightsizingReportListResponse.js +48 -0
  46. package/dist/esm/models/RightsizingReportSummary.d.ts +74 -0
  47. package/dist/esm/models/RightsizingReportSummary.js +71 -0
  48. package/dist/esm/models/RightsizingVMReport.d.ts +53 -0
  49. package/dist/esm/models/RightsizingVMReport.js +57 -0
  50. package/dist/esm/models/StartInspectionRequest.d.ts +32 -0
  51. package/dist/esm/models/StartInspectionRequest.js +43 -0
  52. package/dist/esm/models/StopForecasterPair202Response.d.ts +45 -0
  53. package/dist/esm/models/StopForecasterPair202Response.js +49 -0
  54. package/dist/esm/models/VMs.d.ts +18 -0
  55. package/dist/esm/models/VMs.js +4 -0
  56. package/dist/esm/models/VirtualMachine.d.ts +31 -1
  57. package/dist/esm/models/VirtualMachine.js +12 -4
  58. package/dist/esm/models/VirtualMachineDetail.d.ts +3 -3
  59. package/dist/esm/models/VirtualMachineDetail.js +3 -3
  60. package/dist/esm/models/VmInspectionConcern.d.ts +44 -0
  61. package/dist/esm/models/VmInspectionConcern.js +51 -0
  62. package/dist/esm/models/VmInspectionResults.d.ts +33 -0
  63. package/dist/esm/models/VmInspectionResults.js +42 -0
  64. package/dist/esm/models/VmInspectionStatus.d.ts +0 -1
  65. package/dist/esm/models/VmInspectionStatus.js +1 -2
  66. package/dist/esm/models/VmUtilizationDetails.d.ts +116 -0
  67. package/dist/esm/models/VmUtilizationDetails.js +99 -0
  68. package/dist/esm/models/index.d.ts +25 -1
  69. package/dist/esm/models/index.js +25 -1
  70. package/dist/esm/runtime.js +1 -1
  71. package/dist/models/BenchmarkRun.d.ts +104 -0
  72. package/dist/models/BenchmarkRun.js +92 -0
  73. package/dist/models/DatastoreDetail.d.ts +90 -0
  74. package/dist/models/DatastoreDetail.js +82 -0
  75. package/dist/models/DatastorePair.d.ts +50 -0
  76. package/dist/models/DatastorePair.js +60 -0
  77. package/dist/models/EstimateRange.d.ts +44 -0
  78. package/dist/models/EstimateRange.js +52 -0
  79. package/dist/models/ForecastStats.d.ts +87 -0
  80. package/dist/models/ForecastStats.js +71 -0
  81. package/dist/models/ForecasterDatastoresRequest.d.ts +33 -0
  82. package/dist/models/ForecasterDatastoresRequest.js +49 -0
  83. package/dist/models/ForecasterPairStatus.d.ts +98 -0
  84. package/dist/models/ForecasterPairStatus.js +90 -0
  85. package/dist/models/ForecasterStartRequest.d.ts +58 -0
  86. package/dist/models/ForecasterStartRequest.js +60 -0
  87. package/dist/models/ForecasterStatus.d.ts +47 -0
  88. package/dist/models/ForecasterStatus.js +61 -0
  89. package/dist/models/InspectorStatus.d.ts +20 -7
  90. package/dist/models/InspectorStatus.js +12 -7
  91. package/dist/models/PairCapability.d.ts +60 -0
  92. package/dist/models/PairCapability.js +72 -0
  93. package/dist/models/PairCapabilityRequest.d.ts +40 -0
  94. package/dist/models/PairCapabilityRequest.js +54 -0
  95. package/dist/models/PutForecasterCredentials403Response.d.ts +38 -0
  96. package/dist/models/PutForecasterCredentials403Response.js +50 -0
  97. package/dist/models/RightsizingClusterListResponse.d.ts +39 -0
  98. package/dist/models/RightsizingClusterListResponse.js +55 -0
  99. package/dist/models/RightsizingClusterUtilization.d.ts +112 -0
  100. package/dist/models/RightsizingClusterUtilization.js +102 -0
  101. package/dist/models/RightsizingCollectRequest.d.ts +70 -0
  102. package/dist/models/RightsizingCollectRequest.js +63 -0
  103. package/dist/models/RightsizingMetricStats.d.ts +62 -0
  104. package/dist/models/RightsizingMetricStats.js +70 -0
  105. package/dist/models/RightsizingReport.d.ts +81 -0
  106. package/dist/models/RightsizingReport.js +83 -0
  107. package/dist/models/RightsizingReportListResponse.d.ts +39 -0
  108. package/dist/models/RightsizingReportListResponse.js +55 -0
  109. package/dist/models/RightsizingReportSummary.d.ts +74 -0
  110. package/dist/models/RightsizingReportSummary.js +78 -0
  111. package/dist/models/RightsizingVMReport.d.ts +53 -0
  112. package/dist/models/RightsizingVMReport.js +64 -0
  113. package/dist/models/StartInspectionRequest.d.ts +32 -0
  114. package/dist/models/StartInspectionRequest.js +50 -0
  115. package/dist/models/StopForecasterPair202Response.d.ts +45 -0
  116. package/dist/models/StopForecasterPair202Response.js +57 -0
  117. package/dist/models/VMs.d.ts +18 -0
  118. package/dist/models/VMs.js +4 -0
  119. package/dist/models/VirtualMachine.d.ts +31 -1
  120. package/dist/models/VirtualMachine.js +12 -4
  121. package/dist/models/VirtualMachineDetail.d.ts +3 -3
  122. package/dist/models/VirtualMachineDetail.js +3 -3
  123. package/dist/models/VmInspectionConcern.d.ts +44 -0
  124. package/dist/models/VmInspectionConcern.js +58 -0
  125. package/dist/models/VmInspectionResults.d.ts +33 -0
  126. package/dist/models/VmInspectionResults.js +49 -0
  127. package/dist/models/VmInspectionStatus.d.ts +0 -1
  128. package/dist/models/VmInspectionStatus.js +1 -2
  129. package/dist/models/VmUtilizationDetails.d.ts +116 -0
  130. package/dist/models/VmUtilizationDetails.js +106 -0
  131. package/dist/models/index.d.ts +25 -1
  132. package/dist/models/index.js +25 -1
  133. package/dist/runtime.js +1 -1
  134. package/docs/BenchmarkRun.md +58 -0
  135. package/docs/DatastoreDetail.md +50 -0
  136. package/docs/DatastorePair.md +40 -0
  137. package/docs/DefaultApi.md +1265 -240
  138. package/docs/EstimateRange.md +39 -0
  139. package/docs/ForecastStats.md +52 -0
  140. package/docs/ForecasterDatastoresRequest.md +34 -0
  141. package/docs/ForecasterPairStatus.md +52 -0
  142. package/docs/ForecasterStartRequest.md +42 -0
  143. package/docs/ForecasterStatus.md +36 -0
  144. package/docs/InspectorStatus.md +4 -0
  145. package/docs/PairCapability.md +40 -0
  146. package/docs/PairCapabilityRequest.md +36 -0
  147. package/docs/PutForecasterCredentials403Response.md +36 -0
  148. package/docs/RightsizingClusterListResponse.md +36 -0
  149. package/docs/RightsizingClusterUtilization.md +60 -0
  150. package/docs/RightsizingCollectRequest.md +46 -0
  151. package/docs/RightsizingMetricStats.md +44 -0
  152. package/docs/RightsizingReport.md +50 -0
  153. package/docs/RightsizingReportListResponse.md +36 -0
  154. package/docs/RightsizingReportSummary.md +49 -0
  155. package/docs/RightsizingVMReport.md +40 -0
  156. package/docs/{InspectorStartRequest.md → StartInspectionRequest.md} +5 -6
  157. package/docs/StopForecasterPair202Response.md +36 -0
  158. package/docs/VMs.md +4 -0
  159. package/docs/VirtualMachine.md +12 -2
  160. package/docs/VirtualMachineDetail.md +1 -1
  161. package/docs/VmInspectionConcern.md +39 -0
  162. package/docs/VmInspectionResults.md +35 -0
  163. package/docs/VmUtilizationDetails.md +62 -0
  164. package/package.json +1 -1
  165. package/src/apis/DefaultApi.ts +1548 -350
  166. package/src/models/BenchmarkRun.ts +171 -0
  167. package/src/models/DatastoreDetail.ts +146 -0
  168. package/src/models/DatastorePair.ts +92 -0
  169. package/src/models/EstimateRange.ts +81 -0
  170. package/src/models/ForecastStats.ts +147 -0
  171. package/src/models/ForecasterDatastoresRequest.ts +73 -0
  172. package/src/models/ForecasterPairStatus.ts +158 -0
  173. package/src/models/ForecasterStartRequest.ts +113 -0
  174. package/src/models/ForecasterStatus.ts +93 -0
  175. package/src/models/InspectorStatus.ts +37 -7
  176. package/src/models/PairCapability.ts +106 -0
  177. package/src/models/PairCapabilityRequest.ts +89 -0
  178. package/src/models/PutForecasterCredentials403Response.ts +73 -0
  179. package/src/models/RightsizingClusterListResponse.ts +83 -0
  180. package/src/models/RightsizingClusterUtilization.ts +185 -0
  181. package/src/models/RightsizingCollectRequest.ts +123 -0
  182. package/src/models/RightsizingMetricStats.ts +111 -0
  183. package/src/models/RightsizingReport.ts +146 -0
  184. package/src/models/RightsizingReportListResponse.ts +83 -0
  185. package/src/models/RightsizingReportSummary.ts +129 -0
  186. package/src/models/RightsizingVMReport.ts +101 -0
  187. package/src/models/StartInspectionRequest.ts +66 -0
  188. package/src/models/StopForecasterPair202Response.ts +83 -0
  189. package/src/models/VMs.ts +18 -0
  190. package/src/models/VirtualMachine.ts +43 -4
  191. package/src/models/VirtualMachineDetail.ts +11 -11
  192. package/src/models/VmInspectionConcern.ts +84 -0
  193. package/src/models/VmInspectionResults.ts +73 -0
  194. package/src/models/VmInspectionStatus.ts +1 -2
  195. package/src/models/VmUtilizationDetails.ts +192 -0
  196. package/src/models/index.ts +25 -1
  197. package/src/runtime.ts +1 -2
  198. package/dist/esm/models/InspectorStartRequest.d.ts +0 -39
  199. package/dist/esm/models/InspectorStartRequest.js +0 -48
  200. package/dist/models/InspectorStartRequest.d.ts +0 -39
  201. package/dist/models/InspectorStartRequest.js +0 -55
  202. package/src/models/InspectorStartRequest.ts +0 -83
@@ -4,36 +4,51 @@ 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
10
  | [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
11
11
  | [**getCollectorStatus**](DefaultApi.md#getcollectorstatus) | **GET** /collector | Get collector status |
12
+ | [**getForecasterDatastores**](DefaultApi.md#getforecasterdatastores) | **POST** /forecaster/datastores | List available datastores |
13
+ | [**getForecasterRuns**](DefaultApi.md#getforecasterruns) | **GET** /forecaster/runs | List benchmark runs |
14
+ | [**getForecasterStats**](DefaultApi.md#getforecasterstats) | **GET** /forecaster/stats | Get throughput statistics |
15
+ | [**getForecasterStatus**](DefaultApi.md#getforecasterstatus) | **GET** /forecaster | Poll forecaster status |
12
16
  | [**getGroup**](DefaultApi.md#getgroup) | **GET** /groups/{id} | Get group by ID with its VMs |
13
- | [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /vms/inspector | Get inspector status |
17
+ | [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /inspector | Get inspector status |
18
+ | [**getInspectorVddkStatus**](DefaultApi.md#getinspectorvddkstatus) | **GET** /inspector/vddk | Get VDDK status |
14
19
  | [**getInventory**](DefaultApi.md#getinventory) | **GET** /inventory | Get collected inventory |
20
+ | [**getLatestRightsizingClusters**](DefaultApi.md#getlatestrightsizingclusters) | **GET** /cluster_rightsizing | Get cluster-level utilization aggregates for the latest completed report |
21
+ | [**getRightsizingReport**](DefaultApi.md#getrightsizingreport) | **GET** /rightsizing/{id} | Get a specific rightsizing report with full VM metrics |
22
+ | [**getRightsizingReportClusters**](DefaultApi.md#getrightsizingreportclusters) | **GET** /cluster_rightsizing/{report_id} | Get cluster-level utilization aggregates for a specific report |
15
23
  | [**getVM**](DefaultApi.md#getvm) | **GET** /vms/{id} | Get details about a vm |
16
- | [**getVMInspectionStatus**](DefaultApi.md#getvminspectionstatus) | **GET** /vms/{id}/inspector | Get inspection status for a specific VirtualMachine |
24
+ | [**getVMUtilization**](DefaultApi.md#getvmutilization) | **GET** /vms/{id}/utilization | Get utilization breakdown for a specific VM |
17
25
  | [**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
26
  | [**getVersion**](DefaultApi.md#getversion) | **GET** /version | Get agent version information |
20
27
  | [**listGroups**](DefaultApi.md#listgroups) | **GET** /groups | List all groups |
21
- | [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspector | Remove VirtualMachine from inspection queue |
28
+ | [**listRightsizingReports**](DefaultApi.md#listrightsizingreports) | **GET** /rightsizing | List all rightsizing reports |
29
+ | [**postForecasterPairCapabilities**](DefaultApi.md#postforecasterpaircapabilities) | **POST** /forecaster/capabilities | Compute pair capabilities |
30
+ | [**putForecasterCredentials**](DefaultApi.md#putforecastercredentials) | **PUT** /forecaster/credentials | Verify vCenter credentials and permissions |
31
+ | [**putInspectorCredentials**](DefaultApi.md#putinspectorcredentials) | **PUT** /inspector/credentials | Set or replace inspector credentials |
32
+ | [**putInspectorVddk**](DefaultApi.md#putinspectorvddk) | **PUT** /inspector/vddk | Upload VDDK tarball |
33
+ | [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspection | Remove VirtualMachine from inspection queue |
22
34
  | [**setAgentMode**](DefaultApi.md#setagentmode) | **POST** /agent | Change agent mode |
23
35
  | [**startCollector**](DefaultApi.md#startcollector) | **POST** /collector | Start inventory collection |
24
- | [**startInspection**](DefaultApi.md#startinspection) | **POST** /vms/inspector | Start inspection for VMs |
36
+ | [**startForecaster**](DefaultApi.md#startforecaster) | **POST** /forecaster | Start benchmark |
37
+ | [**startInspection**](DefaultApi.md#startinspectionoperation) | **POST** /inspector | Start inspection for VMs |
25
38
  | [**stopCollector**](DefaultApi.md#stopcollector) | **DELETE** /collector | Stop collection |
26
- | [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /vms/inspector | Stop inspector entirely |
39
+ | [**stopForecaster**](DefaultApi.md#stopforecaster) | **DELETE** /forecaster | Cancel benchmark |
40
+ | [**stopForecasterPair**](DefaultApi.md#stopforecasterpair) | **DELETE** /forecaster/pairs/{name} | Cancel a single pair |
41
+ | [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /inspector | Stop inspector entirely |
42
+ | [**triggerRightsizingCollection**](DefaultApi.md#triggerrightsizingcollection) | **POST** /rightsizing | Trigger rightsizing metrics collection |
27
43
  | [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /groups/{id} | Update group |
28
- | [**vddkPost**](DefaultApi.md#vddkpost) | **POST** /vddk | Upload VDDK tarball |
29
44
 
30
45
 
31
46
 
32
- ## addVMsToInspection
47
+ ## createGroup
33
48
 
34
- > InspectorStatus addVMsToInspection(requestBody)
49
+ > Group createGroup(createGroupRequest)
35
50
 
36
- Add more VMs to inspection queue
51
+ Create a new group
37
52
 
38
53
  ### Example
39
54
 
@@ -42,19 +57,19 @@ import {
42
57
  Configuration,
43
58
  DefaultApi,
44
59
  } from '@openshift-migration-advisor/agent-sdk';
45
- import type { AddVMsToInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
60
+ import type { CreateGroupOperationRequest } from '@openshift-migration-advisor/agent-sdk';
46
61
 
47
62
  async function example() {
48
63
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
49
64
  const api = new DefaultApi();
50
65
 
51
66
  const body = {
52
- // Array<string>
53
- requestBody: ["vm-1236","vm-1237"],
54
- } satisfies AddVMsToInspectionRequest;
67
+ // CreateGroupRequest
68
+ createGroupRequest: ...,
69
+ } satisfies CreateGroupOperationRequest;
55
70
 
56
71
  try {
57
- const data = await api.addVMsToInspection(body);
72
+ const data = await api.createGroup(body);
58
73
  console.log(data);
59
74
  } catch (error) {
60
75
  console.error(error);
@@ -70,11 +85,11 @@ example().catch(console.error);
70
85
 
71
86
  | Name | Type | Description | Notes |
72
87
  |------------- | ------------- | ------------- | -------------|
73
- | **requestBody** | `Array<string>` | | |
88
+ | **createGroupRequest** | [CreateGroupRequest](CreateGroupRequest.md) | | |
74
89
 
75
90
  ### Return type
76
91
 
77
- [**InspectorStatus**](InspectorStatus.md)
92
+ [**Group**](Group.md)
78
93
 
79
94
  ### Authorization
80
95
 
@@ -89,19 +104,18 @@ No authorization required
89
104
  ### HTTP response details
90
105
  | Status code | Description | Response headers |
91
106
  |-------------|-------------|------------------|
92
- | **202** | VMs added to inspection queue | - |
93
- | **400** | Invalid request | - |
94
- | **404** | Inspector not running | - |
107
+ | **201** | Group created | - |
108
+ | **400** | Invalid request (e.g., invalid filter syntax) | - |
95
109
  | **500** | Internal server error | - |
96
110
 
97
111
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
98
112
 
99
113
 
100
- ## createGroup
114
+ ## deleteForecasterRun
101
115
 
102
- > Group createGroup(createGroupRequest)
116
+ > deleteForecasterRun(id)
103
117
 
104
- Create a new group
118
+ Delete a benchmark run
105
119
 
106
120
  ### Example
107
121
 
@@ -110,19 +124,19 @@ import {
110
124
  Configuration,
111
125
  DefaultApi,
112
126
  } from '@openshift-migration-advisor/agent-sdk';
113
- import type { CreateGroupOperationRequest } from '@openshift-migration-advisor/agent-sdk';
127
+ import type { DeleteForecasterRunRequest } from '@openshift-migration-advisor/agent-sdk';
114
128
 
115
129
  async function example() {
116
130
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
117
131
  const api = new DefaultApi();
118
132
 
119
133
  const body = {
120
- // CreateGroupRequest
121
- createGroupRequest: ...,
122
- } satisfies CreateGroupOperationRequest;
134
+ // number | Run ID
135
+ id: 789,
136
+ } satisfies DeleteForecasterRunRequest;
123
137
 
124
138
  try {
125
- const data = await api.createGroup(body);
139
+ const data = await api.deleteForecasterRun(body);
126
140
  console.log(data);
127
141
  } catch (error) {
128
142
  console.error(error);
@@ -138,11 +152,11 @@ example().catch(console.error);
138
152
 
139
153
  | Name | Type | Description | Notes |
140
154
  |------------- | ------------- | ------------- | -------------|
141
- | **createGroupRequest** | [CreateGroupRequest](CreateGroupRequest.md) | | |
155
+ | **id** | `number` | Run ID | [Defaults to `undefined`] |
142
156
 
143
157
  ### Return type
144
158
 
145
- [**Group**](Group.md)
159
+ `void` (Empty response body)
146
160
 
147
161
  ### Authorization
148
162
 
@@ -150,15 +164,16 @@ No authorization required
150
164
 
151
165
  ### HTTP request headers
152
166
 
153
- - **Content-Type**: `application/json`
154
- - **Accept**: `application/json`
167
+ - **Content-Type**: Not defined
168
+ - **Accept**: Not defined
155
169
 
156
170
 
157
171
  ### HTTP response details
158
172
  | Status code | Description | Response headers |
159
173
  |-------------|-------------|------------------|
160
- | **201** | Group created | - |
161
- | **400** | Invalid request (e.g., invalid filter syntax) | - |
174
+ | **204** | Run deleted | - |
175
+ | **400** | Invalid run ID | - |
176
+ | **404** | Run not found | - |
162
177
  | **500** | Internal server error | - |
163
178
 
164
179
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -346,11 +361,13 @@ No authorization required
346
361
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
347
362
 
348
363
 
349
- ## getGroup
364
+ ## getForecasterDatastores
350
365
 
351
- > GroupResponse getGroup(id, sort, page, pageSize)
366
+ > Array&lt;DatastoreDetail&gt; getForecasterDatastores(forecasterDatastoresRequest)
352
367
 
353
- Get group by ID with its VMs
368
+ List available datastores
369
+
370
+ Returns datastores from the forklift-collected inventory with storage vendor and capability information derived from NAA device identifiers. No vSphere credentials are required.
354
371
 
355
372
  ### Example
356
373
 
@@ -359,25 +376,19 @@ import {
359
376
  Configuration,
360
377
  DefaultApi,
361
378
  } from '@openshift-migration-advisor/agent-sdk';
362
- import type { GetGroupRequest } from '@openshift-migration-advisor/agent-sdk';
379
+ import type { GetForecasterDatastoresRequest } from '@openshift-migration-advisor/agent-sdk';
363
380
 
364
381
  async function example() {
365
382
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
366
383
  const api = new DefaultApi();
367
384
 
368
385
  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;
386
+ // ForecasterDatastoresRequest (optional)
387
+ forecasterDatastoresRequest: ...,
388
+ } satisfies GetForecasterDatastoresRequest;
378
389
 
379
390
  try {
380
- const data = await api.getGroup(body);
391
+ const data = await api.getForecasterDatastores(body);
381
392
  console.log(data);
382
393
  } catch (error) {
383
394
  console.error(error);
@@ -393,14 +404,11 @@ example().catch(console.error);
393
404
 
394
405
  | Name | Type | Description | Notes |
395
406
  |------------- | ------------- | ------------- | -------------|
396
- | **id** | `string` | Group ID | [Defaults to `undefined`] |
397
- | **sort** | `Array<string>` | Sort fields with direction (e.g., \&quot;name:asc\&quot; or \&quot;cluster:desc,name:asc\&quot;). 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`] |
407
+ | **forecasterDatastoresRequest** | [ForecasterDatastoresRequest](ForecasterDatastoresRequest.md) | | [Optional] |
400
408
 
401
409
  ### Return type
402
410
 
403
- [**GroupResponse**](GroupResponse.md)
411
+ [**Array&lt;DatastoreDetail&gt;**](DatastoreDetail.md)
404
412
 
405
413
  ### Authorization
406
414
 
@@ -408,25 +416,26 @@ No authorization required
408
416
 
409
417
  ### HTTP request headers
410
418
 
411
- - **Content-Type**: Not defined
419
+ - **Content-Type**: `application/json`
412
420
  - **Accept**: `application/json`
413
421
 
414
422
 
415
423
  ### HTTP response details
416
424
  | Status code | Description | Response headers |
417
425
  |-------------|-------------|------------------|
418
- | **200** | Group details with VMs | - |
419
- | **404** | Group not found | - |
426
+ | **200** | List of datastores | - |
420
427
  | **500** | Internal server error | - |
421
428
 
422
429
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
423
430
 
424
431
 
425
- ## getInspectorStatus
432
+ ## getForecasterRuns
426
433
 
427
- > InspectorStatus getInspectorStatus()
434
+ > Array&lt;BenchmarkRun&gt; getForecasterRuns(pairName)
428
435
 
429
- Get inspector status
436
+ List benchmark runs
437
+
438
+ Returns individual benchmark iterations. Optionally filtered by pair name.
430
439
 
431
440
  ### Example
432
441
 
@@ -435,14 +444,19 @@ import {
435
444
  Configuration,
436
445
  DefaultApi,
437
446
  } from '@openshift-migration-advisor/agent-sdk';
438
- import type { GetInspectorStatusRequest } from '@openshift-migration-advisor/agent-sdk';
447
+ import type { GetForecasterRunsRequest } from '@openshift-migration-advisor/agent-sdk';
439
448
 
440
449
  async function example() {
441
450
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
442
451
  const api = new DefaultApi();
443
452
 
453
+ const body = {
454
+ // string | Filter runs by pair name (optional)
455
+ pairName: pairName_example,
456
+ } satisfies GetForecasterRunsRequest;
457
+
444
458
  try {
445
- const data = await api.getInspectorStatus();
459
+ const data = await api.getForecasterRuns(body);
446
460
  console.log(data);
447
461
  } catch (error) {
448
462
  console.error(error);
@@ -455,11 +469,14 @@ example().catch(console.error);
455
469
 
456
470
  ### Parameters
457
471
 
458
- This endpoint does not need any parameter.
472
+
473
+ | Name | Type | Description | Notes |
474
+ |------------- | ------------- | ------------- | -------------|
475
+ | **pairName** | `string` | Filter runs by pair name | [Optional] [Defaults to `undefined`] |
459
476
 
460
477
  ### Return type
461
478
 
462
- [**InspectorStatus**](InspectorStatus.md)
479
+ [**Array&lt;BenchmarkRun&gt;**](BenchmarkRun.md)
463
480
 
464
481
  ### Authorization
465
482
 
@@ -474,17 +491,19 @@ No authorization required
474
491
  ### HTTP response details
475
492
  | Status code | Description | Response headers |
476
493
  |-------------|-------------|------------------|
477
- | **200** | Inspector status | - |
494
+ | **200** | List of benchmark runs | - |
478
495
  | **500** | Internal server error | - |
479
496
 
480
497
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
481
498
 
482
499
 
483
- ## getInventory
500
+ ## getForecasterStats
484
501
 
485
- > GetInventory200Response getInventory(withAgentId, groupId)
502
+ > ForecastStats getForecasterStats(pairName)
486
503
 
487
- Get collected inventory
504
+ Get throughput statistics
505
+
506
+ Returns computed statistics for a datastore pair\&#39;s benchmark results. Primary endpoint for the UI to display migration time estimates.
488
507
 
489
508
  ### Example
490
509
 
@@ -493,21 +512,19 @@ import {
493
512
  Configuration,
494
513
  DefaultApi,
495
514
  } from '@openshift-migration-advisor/agent-sdk';
496
- import type { GetInventoryRequest } from '@openshift-migration-advisor/agent-sdk';
515
+ import type { GetForecasterStatsRequest } from '@openshift-migration-advisor/agent-sdk';
497
516
 
498
517
  async function example() {
499
518
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
500
519
  const api = new DefaultApi();
501
520
 
502
521
  const body = {
503
- // boolean | If true, include the agentId in the response (Compatible with manual inventory upload). (optional)
504
- withAgentId: true,
505
- // string | Filter inventory to VMs matching this group\'s filter expression (optional)
506
- groupId: groupId_example,
507
- } satisfies GetInventoryRequest;
522
+ // string | Pair name to get statistics for
523
+ pairName: pairName_example,
524
+ } satisfies GetForecasterStatsRequest;
508
525
 
509
526
  try {
510
- const data = await api.getInventory(body);
527
+ const data = await api.getForecasterStats(body);
511
528
  console.log(data);
512
529
  } catch (error) {
513
530
  console.error(error);
@@ -523,12 +540,11 @@ example().catch(console.error);
523
540
 
524
541
  | Name | Type | Description | Notes |
525
542
  |------------- | ------------- | ------------- | -------------|
526
- | **withAgentId** | `boolean` | If true, include the agentId in the response (Compatible with manual inventory upload). | [Optional] [Defaults to `false`] |
527
- | **groupId** | `string` | Filter inventory to VMs matching this group\&#39;s filter expression | [Optional] [Defaults to `undefined`] |
543
+ | **pairName** | `string` | Pair name to get statistics for | [Defaults to `undefined`] |
528
544
 
529
545
  ### Return type
530
546
 
531
- [**GetInventory200Response**](GetInventory200Response.md)
547
+ [**ForecastStats**](ForecastStats.md)
532
548
 
533
549
  ### Authorization
534
550
 
@@ -543,18 +559,20 @@ No authorization required
543
559
  ### HTTP response details
544
560
  | Status code | Description | Response headers |
545
561
  |-------------|-------------|------------------|
546
- | **200** | Collected inventory | - |
547
- | **404** | Inventory not available | - |
562
+ | **200** | Throughput statistics | - |
563
+ | **400** | Missing pairName parameter | - |
548
564
  | **500** | Internal server error | - |
549
565
 
550
566
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
551
567
 
552
568
 
553
- ## getVM
569
+ ## getForecasterStatus
554
570
 
555
- > VirtualMachineDetail getVM(id)
571
+ > ForecasterStatus getForecasterStatus()
556
572
 
557
- Get details about a vm
573
+ Poll forecaster status
574
+
575
+ Returns current service state with per-pair progress details.
558
576
 
559
577
  ### Example
560
578
 
@@ -563,19 +581,14 @@ import {
563
581
  Configuration,
564
582
  DefaultApi,
565
583
  } from '@openshift-migration-advisor/agent-sdk';
566
- import type { GetVMRequest } from '@openshift-migration-advisor/agent-sdk';
584
+ import type { GetForecasterStatusRequest } from '@openshift-migration-advisor/agent-sdk';
567
585
 
568
586
  async function example() {
569
587
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
570
588
  const api = new DefaultApi();
571
589
 
572
- const body = {
573
- // string | VirtualMachine id
574
- id: id_example,
575
- } satisfies GetVMRequest;
576
-
577
590
  try {
578
- const data = await api.getVM(body);
591
+ const data = await api.getForecasterStatus();
579
592
  console.log(data);
580
593
  } catch (error) {
581
594
  console.error(error);
@@ -588,14 +601,11 @@ example().catch(console.error);
588
601
 
589
602
  ### Parameters
590
603
 
591
-
592
- | Name | Type | Description | Notes |
593
- |------------- | ------------- | ------------- | -------------|
594
- | **id** | `string` | VirtualMachine id | [Defaults to `undefined`] |
604
+ This endpoint does not need any parameter.
595
605
 
596
606
  ### Return type
597
607
 
598
- [**VirtualMachineDetail**](VirtualMachineDetail.md)
608
+ [**ForecasterStatus**](ForecasterStatus.md)
599
609
 
600
610
  ### Authorization
601
611
 
@@ -610,18 +620,16 @@ No authorization required
610
620
  ### HTTP response details
611
621
  | Status code | Description | Response headers |
612
622
  |-------------|-------------|------------------|
613
- | **200** | VirtualMachine details | - |
614
- | **404** | VirtualMachine not found | - |
615
- | **500** | Internal server error | - |
623
+ | **200** | Current forecaster status | - |
616
624
 
617
625
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
618
626
 
619
627
 
620
- ## getVMInspectionStatus
628
+ ## getGroup
621
629
 
622
- > VmInspectionStatus getVMInspectionStatus(id)
630
+ > GroupResponse getGroup(id, sort, page, pageSize)
623
631
 
624
- Get inspection status for a specific VirtualMachine
632
+ Get group by ID with its VMs
625
633
 
626
634
  ### Example
627
635
 
@@ -630,19 +638,25 @@ import {
630
638
  Configuration,
631
639
  DefaultApi,
632
640
  } from '@openshift-migration-advisor/agent-sdk';
633
- import type { GetVMInspectionStatusRequest } from '@openshift-migration-advisor/agent-sdk';
641
+ import type { GetGroupRequest } from '@openshift-migration-advisor/agent-sdk';
634
642
 
635
643
  async function example() {
636
644
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
637
645
  const api = new DefaultApi();
638
646
 
639
647
  const body = {
640
- // string | VirtualMachine ID
648
+ // string | Group ID
641
649
  id: id_example,
642
- } satisfies GetVMInspectionStatusRequest;
650
+ // 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)
651
+ sort: ["cluster:asc","name:desc"],
652
+ // number | Page number for pagination (optional)
653
+ page: 56,
654
+ // number | Number of items per page (optional)
655
+ pageSize: 56,
656
+ } satisfies GetGroupRequest;
643
657
 
644
658
  try {
645
- const data = await api.getVMInspectionStatus(body);
659
+ const data = await api.getGroup(body);
646
660
  console.log(data);
647
661
  } catch (error) {
648
662
  console.error(error);
@@ -658,11 +672,14 @@ example().catch(console.error);
658
672
 
659
673
  | Name | Type | Description | Notes |
660
674
  |------------- | ------------- | ------------- | -------------|
661
- | **id** | `string` | VirtualMachine ID | [Defaults to `undefined`] |
675
+ | **id** | `string` | Group ID | [Defaults to `undefined`] |
676
+ | **sort** | `Array<string>` | Sort fields with direction (e.g., \&quot;name:asc\&quot; or \&quot;cluster:desc,name:asc\&quot;). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. | [Optional] |
677
+ | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
678
+ | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
662
679
 
663
680
  ### Return type
664
681
 
665
- [**VmInspectionStatus**](VmInspectionStatus.md)
682
+ [**GroupResponse**](GroupResponse.md)
666
683
 
667
684
  ### Authorization
668
685
 
@@ -677,18 +694,18 @@ No authorization required
677
694
  ### HTTP response details
678
695
  | Status code | Description | Response headers |
679
696
  |-------------|-------------|------------------|
680
- | **200** | VirtualMachine inspection status | - |
681
- | **404** | VirtualMachine not found | - |
697
+ | **200** | Group details with VMs | - |
698
+ | **404** | Group not found | - |
682
699
  | **500** | Internal server error | - |
683
700
 
684
701
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
685
702
 
686
703
 
687
- ## getVMs
704
+ ## getInspectorStatus
688
705
 
689
- > VirtualMachineListResponse getVMs(byExpression, sort, page, pageSize)
706
+ > InspectorStatus getInspectorStatus(includeVddk, includeCredentials)
690
707
 
691
- Get list of VMs with filtering and pagination
708
+ Get inspector status
692
709
 
693
710
  ### Example
694
711
 
@@ -697,25 +714,21 @@ import {
697
714
  Configuration,
698
715
  DefaultApi,
699
716
  } from '@openshift-migration-advisor/agent-sdk';
700
- import type { GetVMsRequest } from '@openshift-migration-advisor/agent-sdk';
717
+ import type { GetInspectorStatusRequest } from '@openshift-migration-advisor/agent-sdk';
701
718
 
702
719
  async function example() {
703
720
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
704
721
  const api = new DefaultApi();
705
722
 
706
723
  const body = {
707
- // string | Filter by expression (matches VMs with the provided expression) (optional)
708
- byExpression: exp1,
709
- // 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
- sort: ["cluster:asc","name:desc"],
711
- // number | Page number for pagination (optional)
712
- page: 56,
713
- // number | Number of items per page (optional)
714
- pageSize: 56,
715
- } satisfies GetVMsRequest;
724
+ // boolean | If true, include uploaded VDDK metadata (`version`, `md5`) when present. omitted if VDDK was never uploaded. (optional)
725
+ includeVddk: true,
726
+ // boolean | If true, include configured vCenter URL and username (password is never returned). omitted if was never set. (optional)
727
+ includeCredentials: true,
728
+ } satisfies GetInspectorStatusRequest;
716
729
 
717
730
  try {
718
- const data = await api.getVMs(body);
731
+ const data = await api.getInspectorStatus(body);
719
732
  console.log(data);
720
733
  } catch (error) {
721
734
  console.error(error);
@@ -731,14 +744,12 @@ example().catch(console.error);
731
744
 
732
745
  | Name | Type | Description | Notes |
733
746
  |------------- | ------------- | ------------- | -------------|
734
- | **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
735
- | **sort** | `Array<string>` | Sort fields with direction (e.g., \&quot;name:asc\&quot; or \&quot;cluster:desc,name:asc\&quot;). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. | [Optional] |
736
- | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
737
- | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
747
+ | **includeVddk** | `boolean` | If true, include uploaded VDDK metadata (&#x60;version&#x60;, &#x60;md5&#x60;) when present. omitted if VDDK was never uploaded. | [Optional] [Defaults to `false`] |
748
+ | **includeCredentials** | `boolean` | If true, include configured vCenter URL and username (password is never returned). omitted if was never set. | [Optional] [Defaults to `false`] |
738
749
 
739
750
  ### Return type
740
751
 
741
- [**VirtualMachineListResponse**](VirtualMachineListResponse.md)
752
+ [**InspectorStatus**](InspectorStatus.md)
742
753
 
743
754
  ### Authorization
744
755
 
@@ -753,16 +764,15 @@ No authorization required
753
764
  ### HTTP response details
754
765
  | Status code | Description | Response headers |
755
766
  |-------------|-------------|------------------|
756
- | **200** | List of VMs | - |
757
- | **400** | Invalid request parameters | - |
767
+ | **200** | Inspector status | - |
758
768
  | **500** | Internal server error | - |
759
769
 
760
770
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
761
771
 
762
772
 
763
- ## getVddkStatus
773
+ ## getInspectorVddkStatus
764
774
 
765
- > VddkProperties getVddkStatus()
775
+ > VddkProperties getInspectorVddkStatus()
766
776
 
767
777
  Get VDDK status
768
778
 
@@ -773,14 +783,14 @@ import {
773
783
  Configuration,
774
784
  DefaultApi,
775
785
  } from '@openshift-migration-advisor/agent-sdk';
776
- import type { GetVddkStatusRequest } from '@openshift-migration-advisor/agent-sdk';
786
+ import type { GetInspectorVddkStatusRequest } from '@openshift-migration-advisor/agent-sdk';
777
787
 
778
788
  async function example() {
779
789
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
780
790
  const api = new DefaultApi();
781
791
 
782
792
  try {
783
- const data = await api.getVddkStatus();
793
+ const data = await api.getInspectorVddkStatus();
784
794
  console.log(data);
785
795
  } catch (error) {
786
796
  console.error(error);
@@ -812,18 +822,18 @@ No authorization required
812
822
  ### HTTP response details
813
823
  | Status code | Description | Response headers |
814
824
  |-------------|-------------|------------------|
815
- | **200** | Returns the current properties of the uploaded VMware VDDK tar. If the VDDK package has not been uploaded, a 404 response is returned. | - |
825
+ | **200** | Returns the current properties of the uploaded VMware VDDK tar. If the VDDK package has not been uploaded, a 404 response is returned. | - |
816
826
  | **404** | Vddk not found | - |
817
827
  | **500** | Internal server error | - |
818
828
 
819
829
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
820
830
 
821
831
 
822
- ## getVersion
832
+ ## getInventory
823
833
 
824
- > VersionInfo getVersion()
834
+ > GetInventory200Response getInventory(withAgentId, groupId)
825
835
 
826
- Get agent version information
836
+ Get collected inventory
827
837
 
828
838
  ### Example
829
839
 
@@ -832,14 +842,21 @@ import {
832
842
  Configuration,
833
843
  DefaultApi,
834
844
  } from '@openshift-migration-advisor/agent-sdk';
835
- import type { GetVersionRequest } from '@openshift-migration-advisor/agent-sdk';
845
+ import type { GetInventoryRequest } from '@openshift-migration-advisor/agent-sdk';
836
846
 
837
847
  async function example() {
838
848
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
839
849
  const api = new DefaultApi();
840
850
 
851
+ const body = {
852
+ // boolean | If true, include the agentId in the response (Compatible with manual inventory upload). (optional)
853
+ withAgentId: true,
854
+ // string | Filter inventory to VMs matching this group\'s filter expression (optional)
855
+ groupId: groupId_example,
856
+ } satisfies GetInventoryRequest;
857
+
841
858
  try {
842
- const data = await api.getVersion();
859
+ const data = await api.getInventory(body);
843
860
  console.log(data);
844
861
  } catch (error) {
845
862
  console.error(error);
@@ -852,11 +869,15 @@ example().catch(console.error);
852
869
 
853
870
  ### Parameters
854
871
 
855
- This endpoint does not need any parameter.
872
+
873
+ | Name | Type | Description | Notes |
874
+ |------------- | ------------- | ------------- | -------------|
875
+ | **withAgentId** | `boolean` | If true, include the agentId in the response (Compatible with manual inventory upload). | [Optional] [Defaults to `false`] |
876
+ | **groupId** | `string` | Filter inventory to VMs matching this group\&#39;s filter expression | [Optional] [Defaults to `undefined`] |
856
877
 
857
878
  ### Return type
858
879
 
859
- [**VersionInfo**](VersionInfo.md)
880
+ [**GetInventory200Response**](GetInventory200Response.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** | Version information | - |
895
+ | **200** | Collected inventory | - |
896
+ | **404** | Inventory not available | - |
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
- ## listGroups
902
+ ## getLatestRightsizingClusters
880
903
 
881
- > GroupListResponse listGroups(byName, page, pageSize)
904
+ > RightsizingClusterListResponse getLatestRightsizingClusters(byExpression)
882
905
 
883
- List all groups
906
+ Get cluster-level utilization aggregates for the latest completed report
884
907
 
885
908
  ### Example
886
909
 
@@ -889,23 +912,19 @@ import {
889
912
  Configuration,
890
913
  DefaultApi,
891
914
  } from '@openshift-migration-advisor/agent-sdk';
892
- import type { ListGroupsRequest } from '@openshift-migration-advisor/agent-sdk';
915
+ import type { GetLatestRightsizingClustersRequest } 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
- // string | Filter groups by name (case-insensitive substring match) (optional)
900
- byName: byName_example,
901
- // number | Page number (1-indexed) (optional)
902
- page: 56,
903
- // number | Number of groups per page (optional)
904
- pageSize: 56,
905
- } satisfies ListGroupsRequest;
922
+ // string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
923
+ byExpression: byExpression_example,
924
+ } satisfies GetLatestRightsizingClustersRequest;
906
925
 
907
926
  try {
908
- const data = await api.listGroups(body);
927
+ const data = await api.getLatestRightsizingClusters(body);
909
928
  console.log(data);
910
929
  } catch (error) {
911
930
  console.error(error);
@@ -921,13 +940,11 @@ example().catch(console.error);
921
940
 
922
941
  | Name | Type | Description | Notes |
923
942
  |------------- | ------------- | ------------- | -------------|
924
- | **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
925
- | **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
926
- | **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
943
+ | **byExpression** | `string` | Filter DSL expression (e.g. \&quot;cluster_id &#x3D; \&#39;domain-c123\&#39;\&quot;). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
927
944
 
928
945
  ### Return type
929
946
 
930
- [**GroupListResponse**](GroupListResponse.md)
947
+ [**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
931
948
 
932
949
  ### Authorization
933
950
 
@@ -942,18 +959,18 @@ No authorization required
942
959
  ### HTTP response details
943
960
  | Status code | Description | Response headers |
944
961
  |-------------|-------------|------------------|
945
- | **200** | List of groups | - |
946
- | **400** | Invalid filter expression | - |
962
+ | **200** | Cluster utilization aggregates | - |
963
+ | **404** | No completed rightsizing report found | - |
947
964
  | **500** | Internal server error | - |
948
965
 
949
966
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
950
967
 
951
968
 
952
- ## removeVMFromInspection
969
+ ## getRightsizingReport
953
970
 
954
- > VmInspectionStatus removeVMFromInspection(id)
971
+ > RightsizingReport getRightsizingReport(id)
955
972
 
956
- Remove VirtualMachine from inspection queue
973
+ Get a specific rightsizing report with full VM metrics
957
974
 
958
975
  ### Example
959
976
 
@@ -962,19 +979,19 @@ import {
962
979
  Configuration,
963
980
  DefaultApi,
964
981
  } from '@openshift-migration-advisor/agent-sdk';
965
- import type { RemoveVMFromInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
982
+ import type { GetRightsizingReportRequest } from '@openshift-migration-advisor/agent-sdk';
966
983
 
967
984
  async function example() {
968
985
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
969
986
  const api = new DefaultApi();
970
987
 
971
988
  const body = {
972
- // string
989
+ // string | Report UUID
973
990
  id: id_example,
974
- } satisfies RemoveVMFromInspectionRequest;
991
+ } satisfies GetRightsizingReportRequest;
975
992
 
976
993
  try {
977
- const data = await api.removeVMFromInspection(body);
994
+ const data = await api.getRightsizingReport(body);
978
995
  console.log(data);
979
996
  } catch (error) {
980
997
  console.error(error);
@@ -990,11 +1007,11 @@ example().catch(console.error);
990
1007
 
991
1008
  | Name | Type | Description | Notes |
992
1009
  |------------- | ------------- | ------------- | -------------|
993
- | **id** | `string` | | [Defaults to `undefined`] |
1010
+ | **id** | `string` | Report UUID | [Defaults to `undefined`] |
994
1011
 
995
1012
  ### Return type
996
1013
 
997
- [**VmInspectionStatus**](VmInspectionStatus.md)
1014
+ [**RightsizingReport**](RightsizingReport.md)
998
1015
 
999
1016
  ### Authorization
1000
1017
 
@@ -1009,19 +1026,18 @@ No authorization required
1009
1026
  ### HTTP response details
1010
1027
  | Status code | Description | Response headers |
1011
1028
  |-------------|-------------|------------------|
1012
- | **200** | VMs removed from queue | - |
1013
- | **400** | Invalid request | - |
1014
- | **404** | Inspector not running | - |
1029
+ | **200** | Rightsizing report | - |
1030
+ | **404** | Report not found | - |
1015
1031
  | **500** | Internal server error | - |
1016
1032
 
1017
1033
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1018
1034
 
1019
1035
 
1020
- ## setAgentMode
1036
+ ## getRightsizingReportClusters
1021
1037
 
1022
- > AgentStatus setAgentMode(agentModeRequest)
1038
+ > RightsizingClusterListResponse getRightsizingReportClusters(reportId, byExpression)
1023
1039
 
1024
- Change agent mode
1040
+ Get cluster-level utilization aggregates for a specific report
1025
1041
 
1026
1042
  ### Example
1027
1043
 
@@ -1030,19 +1046,21 @@ import {
1030
1046
  Configuration,
1031
1047
  DefaultApi,
1032
1048
  } from '@openshift-migration-advisor/agent-sdk';
1033
- import type { SetAgentModeRequest } from '@openshift-migration-advisor/agent-sdk';
1049
+ import type { GetRightsizingReportClustersRequest } from '@openshift-migration-advisor/agent-sdk';
1034
1050
 
1035
1051
  async function example() {
1036
1052
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1037
1053
  const api = new DefaultApi();
1038
1054
 
1039
1055
  const body = {
1040
- // AgentModeRequest
1041
- agentModeRequest: ...,
1042
- } satisfies SetAgentModeRequest;
1056
+ // string | Rightsizing report UUID
1057
+ reportId: reportId_example,
1058
+ // string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
1059
+ byExpression: byExpression_example,
1060
+ } satisfies GetRightsizingReportClustersRequest;
1043
1061
 
1044
1062
  try {
1045
- const data = await api.setAgentMode(body);
1063
+ const data = await api.getRightsizingReportClusters(body);
1046
1064
  console.log(data);
1047
1065
  } catch (error) {
1048
1066
  console.error(error);
@@ -1058,11 +1076,12 @@ example().catch(console.error);
1058
1076
 
1059
1077
  | Name | Type | Description | Notes |
1060
1078
  |------------- | ------------- | ------------- | -------------|
1061
- | **agentModeRequest** | [AgentModeRequest](AgentModeRequest.md) | | |
1079
+ | **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
1080
+ | **byExpression** | `string` | Filter DSL expression (e.g. \&quot;cluster_id &#x3D; \&#39;domain-c123\&#39;\&quot;). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
1062
1081
 
1063
1082
  ### Return type
1064
1083
 
1065
- [**AgentStatus**](AgentStatus.md)
1084
+ [**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
1066
1085
 
1067
1086
  ### Authorization
1068
1087
 
@@ -1070,26 +1089,25 @@ No authorization required
1070
1089
 
1071
1090
  ### HTTP request headers
1072
1091
 
1073
- - **Content-Type**: `application/json`
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** | Mode changed | - |
1081
- | **400** | Invalid request | - |
1082
- | **409** | Conflict | - |
1099
+ | **200** | Cluster utilization aggregates | - |
1100
+ | **404** | Report not found | - |
1083
1101
  | **500** | Internal server error | - |
1084
1102
 
1085
1103
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1086
1104
 
1087
1105
 
1088
- ## startCollector
1106
+ ## getVM
1089
1107
 
1090
- > CollectorStatus startCollector(collectorStartRequest)
1108
+ > VirtualMachineDetail getVM(id)
1091
1109
 
1092
- Start inventory collection
1110
+ Get details about a vm
1093
1111
 
1094
1112
  ### Example
1095
1113
 
@@ -1098,19 +1116,19 @@ import {
1098
1116
  Configuration,
1099
1117
  DefaultApi,
1100
1118
  } from '@openshift-migration-advisor/agent-sdk';
1101
- import type { StartCollectorRequest } from '@openshift-migration-advisor/agent-sdk';
1119
+ import type { GetVMRequest } from '@openshift-migration-advisor/agent-sdk';
1102
1120
 
1103
1121
  async function example() {
1104
1122
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1105
1123
  const api = new DefaultApi();
1106
1124
 
1107
1125
  const body = {
1108
- // CollectorStartRequest
1109
- collectorStartRequest: ...,
1110
- } satisfies StartCollectorRequest;
1126
+ // string | VirtualMachine id
1127
+ id: id_example,
1128
+ } satisfies GetVMRequest;
1111
1129
 
1112
1130
  try {
1113
- const data = await api.startCollector(body);
1131
+ const data = await api.getVM(body);
1114
1132
  console.log(data);
1115
1133
  } catch (error) {
1116
1134
  console.error(error);
@@ -1126,11 +1144,11 @@ example().catch(console.error);
1126
1144
 
1127
1145
  | Name | Type | Description | Notes |
1128
1146
  |------------- | ------------- | ------------- | -------------|
1129
- | **collectorStartRequest** | [CollectorStartRequest](CollectorStartRequest.md) | | |
1147
+ | **id** | `string` | VirtualMachine id | [Defaults to `undefined`] |
1130
1148
 
1131
1149
  ### Return type
1132
1150
 
1133
- [**CollectorStatus**](CollectorStatus.md)
1151
+ [**VirtualMachineDetail**](VirtualMachineDetail.md)
1134
1152
 
1135
1153
  ### Authorization
1136
1154
 
@@ -1138,26 +1156,25 @@ No authorization required
1138
1156
 
1139
1157
  ### HTTP request headers
1140
1158
 
1141
- - **Content-Type**: `application/json`
1159
+ - **Content-Type**: Not defined
1142
1160
  - **Accept**: `application/json`
1143
1161
 
1144
1162
 
1145
1163
  ### HTTP response details
1146
1164
  | Status code | Description | Response headers |
1147
1165
  |-------------|-------------|------------------|
1148
- | **202** | Collection started | - |
1149
- | **400** | Invalid request | - |
1150
- | **409** | Collection already in progress | - |
1166
+ | **200** | VirtualMachine details | - |
1167
+ | **404** | VirtualMachine not found | - |
1151
1168
  | **500** | Internal server error | - |
1152
1169
 
1153
1170
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1154
1171
 
1155
1172
 
1156
- ## startInspection
1173
+ ## getVMUtilization
1157
1174
 
1158
- > InspectorStatus startInspection(inspectorStartRequest)
1175
+ > VmUtilizationDetails getVMUtilization(id)
1159
1176
 
1160
- Start inspection for VMs
1177
+ Get utilization breakdown for a specific VM
1161
1178
 
1162
1179
  ### Example
1163
1180
 
@@ -1166,16 +1183,896 @@ import {
1166
1183
  Configuration,
1167
1184
  DefaultApi,
1168
1185
  } from '@openshift-migration-advisor/agent-sdk';
1169
- import type { StartInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
1186
+ import type { GetVMUtilizationRequest } from '@openshift-migration-advisor/agent-sdk';
1170
1187
 
1171
1188
  async function example() {
1172
1189
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1173
1190
  const api = new DefaultApi();
1174
1191
 
1175
1192
  const body = {
1176
- // InspectorStartRequest
1177
- inspectorStartRequest: ...,
1178
- } satisfies StartInspectionRequest;
1193
+ // string | VirtualMachine MoRef ID
1194
+ id: id_example,
1195
+ } satisfies GetVMUtilizationRequest;
1196
+
1197
+ try {
1198
+ const data = await api.getVMUtilization(body);
1199
+ console.log(data);
1200
+ } catch (error) {
1201
+ console.error(error);
1202
+ }
1203
+ }
1204
+
1205
+ // Run the test
1206
+ example().catch(console.error);
1207
+ ```
1208
+
1209
+ ### Parameters
1210
+
1211
+
1212
+ | Name | Type | Description | Notes |
1213
+ |------------- | ------------- | ------------- | -------------|
1214
+ | **id** | `string` | VirtualMachine MoRef ID | [Defaults to `undefined`] |
1215
+
1216
+ ### Return type
1217
+
1218
+ [**VmUtilizationDetails**](VmUtilizationDetails.md)
1219
+
1220
+ ### Authorization
1221
+
1222
+ No authorization required
1223
+
1224
+ ### HTTP request headers
1225
+
1226
+ - **Content-Type**: Not defined
1227
+ - **Accept**: `application/json`
1228
+
1229
+
1230
+ ### HTTP response details
1231
+ | Status code | Description | Response headers |
1232
+ |-------------|-------------|------------------|
1233
+ | **200** | VM utilization details | - |
1234
+ | **404** | No utilization data found for this VM | - |
1235
+ | **500** | Internal server error | - |
1236
+
1237
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1238
+
1239
+
1240
+ ## getVMs
1241
+
1242
+ > VirtualMachineListResponse getVMs(byExpression, sort, page, pageSize)
1243
+
1244
+ Get list of VMs with filtering and pagination
1245
+
1246
+ ### Example
1247
+
1248
+ ```ts
1249
+ import {
1250
+ Configuration,
1251
+ DefaultApi,
1252
+ } from '@openshift-migration-advisor/agent-sdk';
1253
+ import type { GetVMsRequest } from '@openshift-migration-advisor/agent-sdk';
1254
+
1255
+ async function example() {
1256
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1257
+ const api = new DefaultApi();
1258
+
1259
+ const body = {
1260
+ // string | Filter by expression (matches VMs with the provided expression) (optional)
1261
+ byExpression: exp1,
1262
+ // 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)
1263
+ sort: ["cluster:asc","name:desc"],
1264
+ // number | Page number for pagination (optional)
1265
+ page: 56,
1266
+ // number | Number of items per page (optional)
1267
+ pageSize: 56,
1268
+ } satisfies GetVMsRequest;
1269
+
1270
+ try {
1271
+ const data = await api.getVMs(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
+ | **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
1288
+ | **sort** | `Array<string>` | Sort fields with direction (e.g., \&quot;name:asc\&quot; or \&quot;cluster:desc,name:asc\&quot;). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. | [Optional] |
1289
+ | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
1290
+ | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
1291
+
1292
+ ### Return type
1293
+
1294
+ [**VirtualMachineListResponse**](VirtualMachineListResponse.md)
1295
+
1296
+ ### Authorization
1297
+
1298
+ No authorization required
1299
+
1300
+ ### HTTP request headers
1301
+
1302
+ - **Content-Type**: Not defined
1303
+ - **Accept**: `application/json`
1304
+
1305
+
1306
+ ### HTTP response details
1307
+ | Status code | Description | Response headers |
1308
+ |-------------|-------------|------------------|
1309
+ | **200** | List of VMs | - |
1310
+ | **400** | Invalid request parameters | - |
1311
+ | **500** | Internal server error | - |
1312
+
1313
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1314
+
1315
+
1316
+ ## getVersion
1317
+
1318
+ > VersionInfo getVersion()
1319
+
1320
+ Get agent version information
1321
+
1322
+ ### Example
1323
+
1324
+ ```ts
1325
+ import {
1326
+ Configuration,
1327
+ DefaultApi,
1328
+ } from '@openshift-migration-advisor/agent-sdk';
1329
+ import type { GetVersionRequest } from '@openshift-migration-advisor/agent-sdk';
1330
+
1331
+ async function example() {
1332
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1333
+ const api = new DefaultApi();
1334
+
1335
+ try {
1336
+ const data = await api.getVersion();
1337
+ console.log(data);
1338
+ } catch (error) {
1339
+ console.error(error);
1340
+ }
1341
+ }
1342
+
1343
+ // Run the test
1344
+ example().catch(console.error);
1345
+ ```
1346
+
1347
+ ### Parameters
1348
+
1349
+ This endpoint does not need any parameter.
1350
+
1351
+ ### Return type
1352
+
1353
+ [**VersionInfo**](VersionInfo.md)
1354
+
1355
+ ### Authorization
1356
+
1357
+ No authorization required
1358
+
1359
+ ### HTTP request headers
1360
+
1361
+ - **Content-Type**: Not defined
1362
+ - **Accept**: `application/json`
1363
+
1364
+
1365
+ ### HTTP response details
1366
+ | Status code | Description | Response headers |
1367
+ |-------------|-------------|------------------|
1368
+ | **200** | Version information | - |
1369
+
1370
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1371
+
1372
+
1373
+ ## listGroups
1374
+
1375
+ > GroupListResponse listGroups(byName, page, pageSize)
1376
+
1377
+ List all groups
1378
+
1379
+ ### Example
1380
+
1381
+ ```ts
1382
+ import {
1383
+ Configuration,
1384
+ DefaultApi,
1385
+ } from '@openshift-migration-advisor/agent-sdk';
1386
+ import type { ListGroupsRequest } from '@openshift-migration-advisor/agent-sdk';
1387
+
1388
+ async function example() {
1389
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1390
+ const api = new DefaultApi();
1391
+
1392
+ const body = {
1393
+ // string | Filter groups by name (case-insensitive substring match) (optional)
1394
+ byName: byName_example,
1395
+ // number | Page number (1-indexed) (optional)
1396
+ page: 56,
1397
+ // number | Number of groups per page (optional)
1398
+ pageSize: 56,
1399
+ } satisfies ListGroupsRequest;
1400
+
1401
+ try {
1402
+ const data = await api.listGroups(body);
1403
+ console.log(data);
1404
+ } catch (error) {
1405
+ console.error(error);
1406
+ }
1407
+ }
1408
+
1409
+ // Run the test
1410
+ example().catch(console.error);
1411
+ ```
1412
+
1413
+ ### Parameters
1414
+
1415
+
1416
+ | Name | Type | Description | Notes |
1417
+ |------------- | ------------- | ------------- | -------------|
1418
+ | **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
1419
+ | **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
1420
+ | **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
1421
+
1422
+ ### Return type
1423
+
1424
+ [**GroupListResponse**](GroupListResponse.md)
1425
+
1426
+ ### Authorization
1427
+
1428
+ No authorization required
1429
+
1430
+ ### HTTP request headers
1431
+
1432
+ - **Content-Type**: Not defined
1433
+ - **Accept**: `application/json`
1434
+
1435
+
1436
+ ### HTTP response details
1437
+ | Status code | Description | Response headers |
1438
+ |-------------|-------------|------------------|
1439
+ | **200** | List of groups | - |
1440
+ | **400** | Invalid filter expression | - |
1441
+ | **500** | Internal server error | - |
1442
+
1443
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1444
+
1445
+
1446
+ ## listRightsizingReports
1447
+
1448
+ > RightsizingReportListResponse listRightsizingReports()
1449
+
1450
+ List all rightsizing reports
1451
+
1452
+ ### Example
1453
+
1454
+ ```ts
1455
+ import {
1456
+ Configuration,
1457
+ DefaultApi,
1458
+ } from '@openshift-migration-advisor/agent-sdk';
1459
+ import type { ListRightsizingReportsRequest } from '@openshift-migration-advisor/agent-sdk';
1460
+
1461
+ async function example() {
1462
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1463
+ const api = new DefaultApi();
1464
+
1465
+ try {
1466
+ const data = await api.listRightsizingReports();
1467
+ console.log(data);
1468
+ } catch (error) {
1469
+ console.error(error);
1470
+ }
1471
+ }
1472
+
1473
+ // Run the test
1474
+ example().catch(console.error);
1475
+ ```
1476
+
1477
+ ### Parameters
1478
+
1479
+ This endpoint does not need any parameter.
1480
+
1481
+ ### Return type
1482
+
1483
+ [**RightsizingReportListResponse**](RightsizingReportListResponse.md)
1484
+
1485
+ ### Authorization
1486
+
1487
+ No authorization required
1488
+
1489
+ ### HTTP request headers
1490
+
1491
+ - **Content-Type**: Not defined
1492
+ - **Accept**: `application/json`
1493
+
1494
+
1495
+ ### HTTP response details
1496
+ | Status code | Description | Response headers |
1497
+ |-------------|-------------|------------------|
1498
+ | **200** | List of rightsizing reports | - |
1499
+ | **500** | Internal server error | - |
1500
+
1501
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1502
+
1503
+
1504
+ ## postForecasterPairCapabilities
1505
+
1506
+ > Array&lt;PairCapability&gt; postForecasterPairCapabilities(pairCapabilityRequest)
1507
+
1508
+ Compute pair capabilities
1509
+
1510
+ 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.
1511
+
1512
+ ### Example
1513
+
1514
+ ```ts
1515
+ import {
1516
+ Configuration,
1517
+ DefaultApi,
1518
+ } from '@openshift-migration-advisor/agent-sdk';
1519
+ import type { PostForecasterPairCapabilitiesRequest } from '@openshift-migration-advisor/agent-sdk';
1520
+
1521
+ async function example() {
1522
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1523
+ const api = new DefaultApi();
1524
+
1525
+ const body = {
1526
+ // PairCapabilityRequest
1527
+ pairCapabilityRequest: ...,
1528
+ } satisfies PostForecasterPairCapabilitiesRequest;
1529
+
1530
+ try {
1531
+ const data = await api.postForecasterPairCapabilities(body);
1532
+ console.log(data);
1533
+ } catch (error) {
1534
+ console.error(error);
1535
+ }
1536
+ }
1537
+
1538
+ // Run the test
1539
+ example().catch(console.error);
1540
+ ```
1541
+
1542
+ ### Parameters
1543
+
1544
+
1545
+ | Name | Type | Description | Notes |
1546
+ |------------- | ------------- | ------------- | -------------|
1547
+ | **pairCapabilityRequest** | [PairCapabilityRequest](PairCapabilityRequest.md) | | |
1548
+
1549
+ ### Return type
1550
+
1551
+ [**Array&lt;PairCapability&gt;**](PairCapability.md)
1552
+
1553
+ ### Authorization
1554
+
1555
+ No authorization required
1556
+
1557
+ ### HTTP request headers
1558
+
1559
+ - **Content-Type**: `application/json`
1560
+ - **Accept**: `application/json`
1561
+
1562
+
1563
+ ### HTTP response details
1564
+ | Status code | Description | Response headers |
1565
+ |-------------|-------------|------------------|
1566
+ | **200** | Capabilities per pair | - |
1567
+ | **400** | Datastore not found | - |
1568
+ | **500** | Internal server error | - |
1569
+
1570
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1571
+
1572
+
1573
+ ## putForecasterCredentials
1574
+
1575
+ > putForecasterCredentials(vcenterCredentials)
1576
+
1577
+ Verify vCenter credentials and permissions
1578
+
1579
+ 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.
1580
+
1581
+ ### Example
1582
+
1583
+ ```ts
1584
+ import {
1585
+ Configuration,
1586
+ DefaultApi,
1587
+ } from '@openshift-migration-advisor/agent-sdk';
1588
+ import type { PutForecasterCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
1589
+
1590
+ async function example() {
1591
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1592
+ const api = new DefaultApi();
1593
+
1594
+ const body = {
1595
+ // VcenterCredentials
1596
+ vcenterCredentials: ...,
1597
+ } satisfies PutForecasterCredentialsRequest;
1598
+
1599
+ try {
1600
+ const data = await api.putForecasterCredentials(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
+ | **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
1617
+
1618
+ ### Return type
1619
+
1620
+ `void` (Empty response body)
1621
+
1622
+ ### Authorization
1623
+
1624
+ No authorization required
1625
+
1626
+ ### HTTP request headers
1627
+
1628
+ - **Content-Type**: `application/json`
1629
+ - **Accept**: `application/json`
1630
+
1631
+
1632
+ ### HTTP response details
1633
+ | Status code | Description | Response headers |
1634
+ |-------------|-------------|------------------|
1635
+ | **200** | Credentials valid and all required privileges are granted | - |
1636
+ | **400** | Invalid credentials or unreachable vCenter | - |
1637
+ | **403** | Authentication succeeded but user lacks required privileges | - |
1638
+ | **500** | Internal server error | - |
1639
+
1640
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1641
+
1642
+
1643
+ ## putInspectorCredentials
1644
+
1645
+ > putInspectorCredentials(vcenterCredentials)
1646
+
1647
+ Set or replace inspector credentials
1648
+
1649
+ ### Example
1650
+
1651
+ ```ts
1652
+ import {
1653
+ Configuration,
1654
+ DefaultApi,
1655
+ } from '@openshift-migration-advisor/agent-sdk';
1656
+ import type { PutInspectorCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
1657
+
1658
+ async function example() {
1659
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1660
+ const api = new DefaultApi();
1661
+
1662
+ const body = {
1663
+ // VcenterCredentials
1664
+ vcenterCredentials: ...,
1665
+ } satisfies PutInspectorCredentialsRequest;
1666
+
1667
+ try {
1668
+ const data = await api.putInspectorCredentials(body);
1669
+ console.log(data);
1670
+ } catch (error) {
1671
+ console.error(error);
1672
+ }
1673
+ }
1674
+
1675
+ // Run the test
1676
+ example().catch(console.error);
1677
+ ```
1678
+
1679
+ ### Parameters
1680
+
1681
+
1682
+ | Name | Type | Description | Notes |
1683
+ |------------- | ------------- | ------------- | -------------|
1684
+ | **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
1685
+
1686
+ ### Return type
1687
+
1688
+ `void` (Empty response body)
1689
+
1690
+ ### Authorization
1691
+
1692
+ No authorization required
1693
+
1694
+ ### HTTP request headers
1695
+
1696
+ - **Content-Type**: `application/json`
1697
+ - **Accept**: Not defined
1698
+
1699
+
1700
+ ### HTTP response details
1701
+ | Status code | Description | Response headers |
1702
+ |-------------|-------------|------------------|
1703
+ | **200** | Credentials updated successfully | - |
1704
+ | **400** | Bad Credentials | - |
1705
+ | **500** | Internal server error | - |
1706
+
1707
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1708
+
1709
+
1710
+ ## putInspectorVddk
1711
+
1712
+ > VddkProperties putInspectorVddk(file)
1713
+
1714
+ Upload VDDK tarball
1715
+
1716
+ ### Example
1717
+
1718
+ ```ts
1719
+ import {
1720
+ Configuration,
1721
+ DefaultApi,
1722
+ } from '@openshift-migration-advisor/agent-sdk';
1723
+ import type { PutInspectorVddkRequest } from '@openshift-migration-advisor/agent-sdk';
1724
+
1725
+ async function example() {
1726
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1727
+ const api = new DefaultApi();
1728
+
1729
+ const body = {
1730
+ // Blob | VDDK tarball
1731
+ file: BINARY_DATA_HERE,
1732
+ } satisfies PutInspectorVddkRequest;
1733
+
1734
+ try {
1735
+ const data = await api.putInspectorVddk(body);
1736
+ console.log(data);
1737
+ } catch (error) {
1738
+ console.error(error);
1739
+ }
1740
+ }
1741
+
1742
+ // Run the test
1743
+ example().catch(console.error);
1744
+ ```
1745
+
1746
+ ### Parameters
1747
+
1748
+
1749
+ | Name | Type | Description | Notes |
1750
+ |------------- | ------------- | ------------- | -------------|
1751
+ | **file** | `Blob` | VDDK tarball | [Defaults to `undefined`] |
1752
+
1753
+ ### Return type
1754
+
1755
+ [**VddkProperties**](VddkProperties.md)
1756
+
1757
+ ### Authorization
1758
+
1759
+ No authorization required
1760
+
1761
+ ### HTTP request headers
1762
+
1763
+ - **Content-Type**: `multipart/form-data`
1764
+ - **Accept**: `application/json`
1765
+
1766
+
1767
+ ### HTTP response details
1768
+ | Status code | Description | Response headers |
1769
+ |-------------|-------------|------------------|
1770
+ | **200** | Upload successful | - |
1771
+ | **409** | Conflict | - |
1772
+ | **413** | File exceeds 64MB limit | - |
1773
+ | **400** | Bad request | - |
1774
+ | **500** | Internal server error | - |
1775
+
1776
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1777
+
1778
+
1779
+ ## removeVMFromInspection
1780
+
1781
+ > VmInspectionStatus removeVMFromInspection(id)
1782
+
1783
+ Remove VirtualMachine from inspection queue
1784
+
1785
+ ### Example
1786
+
1787
+ ```ts
1788
+ import {
1789
+ Configuration,
1790
+ DefaultApi,
1791
+ } from '@openshift-migration-advisor/agent-sdk';
1792
+ import type { RemoveVMFromInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
1793
+
1794
+ async function example() {
1795
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1796
+ const api = new DefaultApi();
1797
+
1798
+ const body = {
1799
+ // string
1800
+ id: id_example,
1801
+ } satisfies RemoveVMFromInspectionRequest;
1802
+
1803
+ try {
1804
+ const data = await api.removeVMFromInspection(body);
1805
+ console.log(data);
1806
+ } catch (error) {
1807
+ console.error(error);
1808
+ }
1809
+ }
1810
+
1811
+ // Run the test
1812
+ example().catch(console.error);
1813
+ ```
1814
+
1815
+ ### Parameters
1816
+
1817
+
1818
+ | Name | Type | Description | Notes |
1819
+ |------------- | ------------- | ------------- | -------------|
1820
+ | **id** | `string` | | [Defaults to `undefined`] |
1821
+
1822
+ ### Return type
1823
+
1824
+ [**VmInspectionStatus**](VmInspectionStatus.md)
1825
+
1826
+ ### Authorization
1827
+
1828
+ No authorization required
1829
+
1830
+ ### HTTP request headers
1831
+
1832
+ - **Content-Type**: Not defined
1833
+ - **Accept**: `application/json`
1834
+
1835
+
1836
+ ### HTTP response details
1837
+ | Status code | Description | Response headers |
1838
+ |-------------|-------------|------------------|
1839
+ | **200** | VMs removed from queue | - |
1840
+ | **400** | Inspector not running or VirtualMachine cannot be canceled | - |
1841
+ | **404** | VirtualMachine not found or not in the queue | - |
1842
+ | **500** | Internal server error | - |
1843
+
1844
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1845
+
1846
+
1847
+ ## setAgentMode
1848
+
1849
+ > AgentStatus setAgentMode(agentModeRequest)
1850
+
1851
+ Change agent mode
1852
+
1853
+ ### Example
1854
+
1855
+ ```ts
1856
+ import {
1857
+ Configuration,
1858
+ DefaultApi,
1859
+ } from '@openshift-migration-advisor/agent-sdk';
1860
+ import type { SetAgentModeRequest } from '@openshift-migration-advisor/agent-sdk';
1861
+
1862
+ async function example() {
1863
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1864
+ const api = new DefaultApi();
1865
+
1866
+ const body = {
1867
+ // AgentModeRequest
1868
+ agentModeRequest: ...,
1869
+ } satisfies SetAgentModeRequest;
1870
+
1871
+ try {
1872
+ const data = await api.setAgentMode(body);
1873
+ console.log(data);
1874
+ } catch (error) {
1875
+ console.error(error);
1876
+ }
1877
+ }
1878
+
1879
+ // Run the test
1880
+ example().catch(console.error);
1881
+ ```
1882
+
1883
+ ### Parameters
1884
+
1885
+
1886
+ | Name | Type | Description | Notes |
1887
+ |------------- | ------------- | ------------- | -------------|
1888
+ | **agentModeRequest** | [AgentModeRequest](AgentModeRequest.md) | | |
1889
+
1890
+ ### Return type
1891
+
1892
+ [**AgentStatus**](AgentStatus.md)
1893
+
1894
+ ### Authorization
1895
+
1896
+ No authorization required
1897
+
1898
+ ### HTTP request headers
1899
+
1900
+ - **Content-Type**: `application/json`
1901
+ - **Accept**: `application/json`
1902
+
1903
+
1904
+ ### HTTP response details
1905
+ | Status code | Description | Response headers |
1906
+ |-------------|-------------|------------------|
1907
+ | **200** | Mode changed | - |
1908
+ | **400** | Invalid request | - |
1909
+ | **409** | Conflict | - |
1910
+ | **500** | Internal server error | - |
1911
+
1912
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1913
+
1914
+
1915
+ ## startCollector
1916
+
1917
+ > CollectorStatus startCollector(collectorStartRequest)
1918
+
1919
+ Start inventory collection
1920
+
1921
+ ### Example
1922
+
1923
+ ```ts
1924
+ import {
1925
+ Configuration,
1926
+ DefaultApi,
1927
+ } from '@openshift-migration-advisor/agent-sdk';
1928
+ import type { StartCollectorRequest } from '@openshift-migration-advisor/agent-sdk';
1929
+
1930
+ async function example() {
1931
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1932
+ const api = new DefaultApi();
1933
+
1934
+ const body = {
1935
+ // CollectorStartRequest
1936
+ collectorStartRequest: ...,
1937
+ } satisfies StartCollectorRequest;
1938
+
1939
+ try {
1940
+ const data = await api.startCollector(body);
1941
+ console.log(data);
1942
+ } catch (error) {
1943
+ console.error(error);
1944
+ }
1945
+ }
1946
+
1947
+ // Run the test
1948
+ example().catch(console.error);
1949
+ ```
1950
+
1951
+ ### Parameters
1952
+
1953
+
1954
+ | Name | Type | Description | Notes |
1955
+ |------------- | ------------- | ------------- | -------------|
1956
+ | **collectorStartRequest** | [CollectorStartRequest](CollectorStartRequest.md) | | |
1957
+
1958
+ ### Return type
1959
+
1960
+ [**CollectorStatus**](CollectorStatus.md)
1961
+
1962
+ ### Authorization
1963
+
1964
+ No authorization required
1965
+
1966
+ ### HTTP request headers
1967
+
1968
+ - **Content-Type**: `application/json`
1969
+ - **Accept**: `application/json`
1970
+
1971
+
1972
+ ### HTTP response details
1973
+ | Status code | Description | Response headers |
1974
+ |-------------|-------------|------------------|
1975
+ | **202** | Collection started | - |
1976
+ | **400** | Invalid request | - |
1977
+ | **409** | Collection already in progress | - |
1978
+ | **500** | Internal server error | - |
1979
+
1980
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1981
+
1982
+
1983
+ ## startForecaster
1984
+
1985
+ > ForecasterStatus startForecaster(forecasterStartRequest)
1986
+
1987
+ Start benchmark
1988
+
1989
+ Starts async benchmarking for one or more datastore pairs. Credentials can be passed inline or omitted if previously provided in an earlier request.
1990
+
1991
+ ### Example
1992
+
1993
+ ```ts
1994
+ import {
1995
+ Configuration,
1996
+ DefaultApi,
1997
+ } from '@openshift-migration-advisor/agent-sdk';
1998
+ import type { StartForecasterRequest } from '@openshift-migration-advisor/agent-sdk';
1999
+
2000
+ async function example() {
2001
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
2002
+ const api = new DefaultApi();
2003
+
2004
+ const body = {
2005
+ // ForecasterStartRequest
2006
+ forecasterStartRequest: ...,
2007
+ } satisfies StartForecasterRequest;
2008
+
2009
+ try {
2010
+ const data = await api.startForecaster(body);
2011
+ console.log(data);
2012
+ } catch (error) {
2013
+ console.error(error);
2014
+ }
2015
+ }
2016
+
2017
+ // Run the test
2018
+ example().catch(console.error);
2019
+ ```
2020
+
2021
+ ### Parameters
2022
+
2023
+
2024
+ | Name | Type | Description | Notes |
2025
+ |------------- | ------------- | ------------- | -------------|
2026
+ | **forecasterStartRequest** | [ForecasterStartRequest](ForecasterStartRequest.md) | | |
2027
+
2028
+ ### Return type
2029
+
2030
+ [**ForecasterStatus**](ForecasterStatus.md)
2031
+
2032
+ ### Authorization
2033
+
2034
+ No authorization required
2035
+
2036
+ ### HTTP request headers
2037
+
2038
+ - **Content-Type**: `application/json`
2039
+ - **Accept**: `application/json`
2040
+
2041
+
2042
+ ### HTTP response details
2043
+ | Status code | Description | Response headers |
2044
+ |-------------|-------------|------------------|
2045
+ | **202** | Benchmark started | - |
2046
+ | **400** | Invalid credentials, validation error, or pair limit exceeded | - |
2047
+ | **409** | Another benchmark is already running | - |
2048
+ | **500** | Internal server error | - |
2049
+
2050
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2051
+
2052
+
2053
+ ## startInspection
2054
+
2055
+ > InspectorStatus startInspection(startInspectionRequest)
2056
+
2057
+ Start inspection for VMs
2058
+
2059
+ ### Example
2060
+
2061
+ ```ts
2062
+ import {
2063
+ Configuration,
2064
+ DefaultApi,
2065
+ } from '@openshift-migration-advisor/agent-sdk';
2066
+ import type { StartInspectionOperationRequest } from '@openshift-migration-advisor/agent-sdk';
2067
+
2068
+ async function example() {
2069
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
2070
+ const api = new DefaultApi();
2071
+
2072
+ const body = {
2073
+ // StartInspectionRequest
2074
+ startInspectionRequest: ...,
2075
+ } satisfies StartInspectionOperationRequest;
1179
2076
 
1180
2077
  try {
1181
2078
  const data = await api.startInspection(body);
@@ -1194,7 +2091,7 @@ example().catch(console.error);
1194
2091
 
1195
2092
  | Name | Type | Description | Notes |
1196
2093
  |------------- | ------------- | ------------- | -------------|
1197
- | **inspectorStartRequest** | [InspectorStartRequest](InspectorStartRequest.md) | | |
2094
+ | **startInspectionRequest** | [StartInspectionRequest](StartInspectionRequest.md) | | |
1198
2095
 
1199
2096
  ### Return type
1200
2097
 
@@ -1279,6 +2176,136 @@ No authorization required
1279
2176
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1280
2177
 
1281
2178
 
2179
+ ## stopForecaster
2180
+
2181
+ > ForecasterStatus stopForecaster()
2182
+
2183
+ Cancel benchmark
2184
+
2185
+ Stops the running benchmark. Already-completed runs are preserved in the database.
2186
+
2187
+ ### Example
2188
+
2189
+ ```ts
2190
+ import {
2191
+ Configuration,
2192
+ DefaultApi,
2193
+ } from '@openshift-migration-advisor/agent-sdk';
2194
+ import type { StopForecasterRequest } from '@openshift-migration-advisor/agent-sdk';
2195
+
2196
+ async function example() {
2197
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
2198
+ const api = new DefaultApi();
2199
+
2200
+ try {
2201
+ const data = await api.stopForecaster();
2202
+ console.log(data);
2203
+ } catch (error) {
2204
+ console.error(error);
2205
+ }
2206
+ }
2207
+
2208
+ // Run the test
2209
+ example().catch(console.error);
2210
+ ```
2211
+
2212
+ ### Parameters
2213
+
2214
+ This endpoint does not need any parameter.
2215
+
2216
+ ### Return type
2217
+
2218
+ [**ForecasterStatus**](ForecasterStatus.md)
2219
+
2220
+ ### Authorization
2221
+
2222
+ No authorization required
2223
+
2224
+ ### HTTP request headers
2225
+
2226
+ - **Content-Type**: Not defined
2227
+ - **Accept**: `application/json`
2228
+
2229
+
2230
+ ### HTTP response details
2231
+ | Status code | Description | Response headers |
2232
+ |-------------|-------------|------------------|
2233
+ | **202** | Benchmark canceled, service returned to ready | - |
2234
+ | **404** | No benchmark is running | - |
2235
+ | **500** | Internal server error | - |
2236
+
2237
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2238
+
2239
+
2240
+ ## stopForecasterPair
2241
+
2242
+ > StopForecasterPair202Response stopForecasterPair(name)
2243
+
2244
+ Cancel a single pair
2245
+
2246
+ Cancels the benchmark for a specific pair by name. The forecaster continues running if other pairs are still active.
2247
+
2248
+ ### Example
2249
+
2250
+ ```ts
2251
+ import {
2252
+ Configuration,
2253
+ DefaultApi,
2254
+ } from '@openshift-migration-advisor/agent-sdk';
2255
+ import type { StopForecasterPairRequest } from '@openshift-migration-advisor/agent-sdk';
2256
+
2257
+ async function example() {
2258
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
2259
+ const api = new DefaultApi();
2260
+
2261
+ const body = {
2262
+ // string | Pair name as specified in the start request
2263
+ name: name_example,
2264
+ } satisfies StopForecasterPairRequest;
2265
+
2266
+ try {
2267
+ const data = await api.stopForecasterPair(body);
2268
+ console.log(data);
2269
+ } catch (error) {
2270
+ console.error(error);
2271
+ }
2272
+ }
2273
+
2274
+ // Run the test
2275
+ example().catch(console.error);
2276
+ ```
2277
+
2278
+ ### Parameters
2279
+
2280
+
2281
+ | Name | Type | Description | Notes |
2282
+ |------------- | ------------- | ------------- | -------------|
2283
+ | **name** | `string` | Pair name as specified in the start request | [Defaults to `undefined`] |
2284
+
2285
+ ### Return type
2286
+
2287
+ [**StopForecasterPair202Response**](StopForecasterPair202Response.md)
2288
+
2289
+ ### Authorization
2290
+
2291
+ No authorization required
2292
+
2293
+ ### HTTP request headers
2294
+
2295
+ - **Content-Type**: Not defined
2296
+ - **Accept**: `application/json`
2297
+
2298
+
2299
+ ### HTTP response details
2300
+ | Status code | Description | Response headers |
2301
+ |-------------|-------------|------------------|
2302
+ | **202** | Pair canceled | - |
2303
+ | **404** | No benchmark running, or pair not found / already finished | - |
2304
+ | **500** | Internal server error | - |
2305
+
2306
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2307
+
2308
+
1282
2309
  ## stopInspection
1283
2310
 
1284
2311
  > InspectorStatus stopInspection()
@@ -1339,11 +2366,11 @@ No authorization required
1339
2366
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1340
2367
 
1341
2368
 
1342
- ## updateGroup
2369
+ ## triggerRightsizingCollection
1343
2370
 
1344
- > Group updateGroup(id, updateGroupRequest)
2371
+ > RightsizingReportSummary triggerRightsizingCollection(rightsizingCollectRequest)
1345
2372
 
1346
- Update group
2373
+ Trigger rightsizing metrics collection
1347
2374
 
1348
2375
  ### Example
1349
2376
 
@@ -1352,21 +2379,19 @@ import {
1352
2379
  Configuration,
1353
2380
  DefaultApi,
1354
2381
  } from '@openshift-migration-advisor/agent-sdk';
1355
- import type { UpdateGroupOperationRequest } from '@openshift-migration-advisor/agent-sdk';
2382
+ import type { TriggerRightsizingCollectionRequest } from '@openshift-migration-advisor/agent-sdk';
1356
2383
 
1357
2384
  async function example() {
1358
2385
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1359
2386
  const api = new DefaultApi();
1360
2387
 
1361
2388
  const body = {
1362
- // string | Group ID
1363
- id: id_example,
1364
- // UpdateGroupRequest
1365
- updateGroupRequest: ...,
1366
- } satisfies UpdateGroupOperationRequest;
2389
+ // RightsizingCollectRequest
2390
+ rightsizingCollectRequest: ...,
2391
+ } satisfies TriggerRightsizingCollectionRequest;
1367
2392
 
1368
2393
  try {
1369
- const data = await api.updateGroup(body);
2394
+ const data = await api.triggerRightsizingCollection(body);
1370
2395
  console.log(data);
1371
2396
  } catch (error) {
1372
2397
  console.error(error);
@@ -1382,12 +2407,11 @@ example().catch(console.error);
1382
2407
 
1383
2408
  | Name | Type | Description | Notes |
1384
2409
  |------------- | ------------- | ------------- | -------------|
1385
- | **id** | `string` | Group ID | [Defaults to `undefined`] |
1386
- | **updateGroupRequest** | [UpdateGroupRequest](UpdateGroupRequest.md) | | |
2410
+ | **rightsizingCollectRequest** | [RightsizingCollectRequest](RightsizingCollectRequest.md) | | |
1387
2411
 
1388
2412
  ### Return type
1389
2413
 
1390
- [**Group**](Group.md)
2414
+ [**RightsizingReportSummary**](RightsizingReportSummary.md)
1391
2415
 
1392
2416
  ### Authorization
1393
2417
 
@@ -1402,19 +2426,18 @@ No authorization required
1402
2426
  ### HTTP response details
1403
2427
  | Status code | Description | Response headers |
1404
2428
  |-------------|-------------|------------------|
1405
- | **200** | Group updated | - |
1406
- | **400** | Invalid request (e.g., invalid filter syntax) | - |
1407
- | **404** | Group not found | - |
2429
+ | **202** | Collection triggered; returns report | - |
2430
+ | **400** | Invalid request | - |
1408
2431
  | **500** | Internal server error | - |
1409
2432
 
1410
2433
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1411
2434
 
1412
2435
 
1413
- ## vddkPost
2436
+ ## updateGroup
1414
2437
 
1415
- > VddkProperties vddkPost(file)
2438
+ > Group updateGroup(id, updateGroupRequest)
1416
2439
 
1417
- Upload VDDK tarball
2440
+ Update group
1418
2441
 
1419
2442
  ### Example
1420
2443
 
@@ -1423,19 +2446,21 @@ import {
1423
2446
  Configuration,
1424
2447
  DefaultApi,
1425
2448
  } from '@openshift-migration-advisor/agent-sdk';
1426
- import type { VddkPostRequest } from '@openshift-migration-advisor/agent-sdk';
2449
+ import type { UpdateGroupOperationRequest } from '@openshift-migration-advisor/agent-sdk';
1427
2450
 
1428
2451
  async function example() {
1429
2452
  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1430
2453
  const api = new DefaultApi();
1431
2454
 
1432
2455
  const body = {
1433
- // Blob | VDDK tarball
1434
- file: BINARY_DATA_HERE,
1435
- } satisfies VddkPostRequest;
2456
+ // string | Group ID
2457
+ id: id_example,
2458
+ // UpdateGroupRequest
2459
+ updateGroupRequest: ...,
2460
+ } satisfies UpdateGroupOperationRequest;
1436
2461
 
1437
2462
  try {
1438
- const data = await api.vddkPost(body);
2463
+ const data = await api.updateGroup(body);
1439
2464
  console.log(data);
1440
2465
  } catch (error) {
1441
2466
  console.error(error);
@@ -1451,11 +2476,12 @@ example().catch(console.error);
1451
2476
 
1452
2477
  | Name | Type | Description | Notes |
1453
2478
  |------------- | ------------- | ------------- | -------------|
1454
- | **file** | `Blob` | VDDK tarball | [Defaults to `undefined`] |
2479
+ | **id** | `string` | Group ID | [Defaults to `undefined`] |
2480
+ | **updateGroupRequest** | [UpdateGroupRequest](UpdateGroupRequest.md) | | |
1455
2481
 
1456
2482
  ### Return type
1457
2483
 
1458
- [**VddkProperties**](VddkProperties.md)
2484
+ [**Group**](Group.md)
1459
2485
 
1460
2486
  ### Authorization
1461
2487
 
@@ -1463,17 +2489,16 @@ No authorization required
1463
2489
 
1464
2490
  ### HTTP request headers
1465
2491
 
1466
- - **Content-Type**: `multipart/form-data`
2492
+ - **Content-Type**: `application/json`
1467
2493
  - **Accept**: `application/json`
1468
2494
 
1469
2495
 
1470
2496
  ### HTTP response details
1471
2497
  | Status code | Description | Response headers |
1472
2498
  |-------------|-------------|------------------|
1473
- | **200** | Upload successful | - |
1474
- | **409** | Conflict | - |
1475
- | **413** | File exceeds 64MB limit | - |
1476
- | **400** | Bad request | - |
2499
+ | **200** | Group updated | - |
2500
+ | **400** | Invalid request (e.g., invalid filter syntax) | - |
2501
+ | **404** | Group not found | - |
1477
2502
  | **500** | Internal server error | - |
1478
2503
 
1479
2504
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)