@openshift-migration-advisor/agent-sdk 0.12.0 → 0.16.0-f224c4e8e35b

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