@openshift-migration-advisor/agent-sdk 0.12.0-645d2fae3eee → 0.12.0-73dd4924f11b

package/docs/DefaultApi.md

@@ -5,11 +5,15 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /groups | Create a new group |
+| [**deleteCredentials**](DefaultApi.md#deletecredentials) | **DELETE** /credentials | Delete stored credentials |
 | [**deleteForecasterRun**](DefaultApi.md#deleteforecasterrun) | **DELETE** /forecaster/runs/{id} | Delete a benchmark run |
 | [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /groups/{id} | Delete group |
 | [**deleteLabelGlobally**](DefaultApi.md#deletelabelglobally) | **DELETE** /vms/labels/{label} | Delete label from all VMs |
 | [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
+| [**getApplications**](DefaultApi.md#getapplications) | **GET** /applications | List detected applications running on VMs |
+| [**getClusterUtilization**](DefaultApi.md#getclusterutilization) | **GET** /clusters/{cluster_id}/utilization | Get latest cluster utilization by cluster ID |
 | [**getCollectorStatus**](DefaultApi.md#getcollectorstatus) | **GET** /collector | Get collector status |
+| [**getCredentials**](DefaultApi.md#getcredentials) | **GET** /credentials | Get stored credential status |
 | [**getForecasterDatastores**](DefaultApi.md#getforecasterdatastores) | **POST** /forecaster/datastores | List available datastores |
 | [**getForecasterRuns**](DefaultApi.md#getforecasterruns) | **GET** /forecaster/runs | List benchmark runs |
 | [**getForecasterStats**](DefaultApi.md#getforecasterstats) | **GET** /forecaster/stats | Get throughput statistics |
@@ -26,11 +30,13 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
 | [**getVMLabels**](DefaultApi.md#getvmlabels) | **GET** /vms/labels | Get all distinct labels in use across VMs |
 | [**getVMUtilization**](DefaultApi.md#getvmutilization) | **GET** /vms/{id}/utilization | Get utilization breakdown for a specific VM |
 | [**getVMs**](DefaultApi.md#getvms) | **GET** /vms | Get list of VMs with filtering and pagination |
+| [**getVMsFilterOptions**](DefaultApi.md#getvmsfilteroptions) | **GET** /vms/filter-options | Get distinct filter option values for VMs |
 | [**getVersion**](DefaultApi.md#getversion) | **GET** /version | Get agent version information |
 | [**listGroups**](DefaultApi.md#listgroups) | **GET** /groups | List all groups |
 | [**listRightsizingReportClusters**](DefaultApi.md#listrightsizingreportclusters) | **GET** /rightsizing/{report_id}/clusters | Get cluster-level utilization aggregates for a specific report |
 | [**listRightsizingReports**](DefaultApi.md#listrightsizingreports) | **GET** /rightsizing | List all rightsizing reports |
 | [**postForecasterPairCapabilities**](DefaultApi.md#postforecasterpaircapabilities) | **POST** /forecaster/capabilities | Compute pair capabilities |
+| [**putCredentials**](DefaultApi.md#putcredentials) | **PUT** /credentials | Store vCenter credentials |
 | [**putForecasterCredentials**](DefaultApi.md#putforecastercredentials) | **PUT** /forecaster/credentials | Verify vCenter credentials and permissions |
 | [**putInspectorVddk**](DefaultApi.md#putinspectorvddk) | **PUT** /inspector/vddk | Upload VDDK tarball |
 | [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspection | Remove VirtualMachine from inspection queue |
@@ -117,6 +123,66 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteCredentials
+
+> deleteCredentials()
+
+Delete stored credentials
+
+Removes all stored vCenter credentials from the database.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@openshift-migration-advisor/agent-sdk';
+import type { DeleteCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
+  const api = new DefaultApi();
+
+  try {
+    const data = await api.deleteCredentials();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Credentials deleted |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## deleteForecasterRun
 
 > deleteForecasterRun(id)
@@ -376,6 +442,132 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getApplications
+
+> ApplicationListResponse getApplications()
+
+List detected applications running on VMs
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@openshift-migration-advisor/agent-sdk';
+import type { GetApplicationsRequest } from '@openshift-migration-advisor/agent-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
+  const api = new DefaultApi();
+
+  try {
+    const data = await api.getApplications();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApplicationListResponse**](ApplicationListResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of applications with matching VMs |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getClusterUtilization
+
+> RightsizingClusterResponse getClusterUtilization(clusterId)
+
+Get latest cluster utilization by cluster ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@openshift-migration-advisor/agent-sdk';
+import type { GetClusterUtilizationRequest } from '@openshift-migration-advisor/agent-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // string | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\")
+    clusterId: clusterId_example,
+  } satisfies GetClusterUtilizationRequest;
+
+  try {
+    const data = await api.getClusterUtilization(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clusterId** | `string` | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\") | [Defaults to `undefined`] |
+
+### Return type
+
+[**RightsizingClusterResponse**](RightsizingClusterResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Cluster utilization data from the latest completed rightsizing report |  -  |
+| **400** | Invalid cluster_id format |  -  |
+| **404** | No completed rightsizing report found, or cluster not found in report |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getCollectorStatus
 
 > CollectorStatus getCollectorStatus()
@@ -434,6 +626,67 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getCredentials
+
+> CredentialStatus getCredentials()
+
+Get stored credential status
+
+Returns stored credential metadata (URL only). Never exposes username or password. This endpoint does not revalidate credentials against vSphere.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@openshift-migration-advisor/agent-sdk';
+import type { GetCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
+  const api = new DefaultApi();
+
+  try {
+    const data = await api.getCredentials();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CredentialStatus**](CredentialStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Credential status |  -  |
+| **404** | No credentials stored |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getForecasterDatastores
 
 > Array<DatastoreDetail> getForecasterDatastores(forecasterDatastoresRequest)
@@ -720,7 +973,7 @@ async function example() {
   const body = {
     // string | Group ID
     id: id_example,
-    // 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)
+    // 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)
     sort: ["cluster:asc","name:desc"],
     // number | Page number for pagination (optional)
     page: 56,
@@ -746,7 +999,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **id** | `string` | Group ID | [Defaults to `undefined`] |
-| **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] |
+| **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] |
 | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
 
@@ -1457,7 +1710,7 @@ async function example() {
   const body = {
     // string | Filter by expression (matches VMs with the provided expression) (optional)
     byExpression: exp1,
-    // 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)
+    // 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)
     sort: ["cluster:asc","name:desc"],
     // number | Page number for pagination (optional)
     page: 56,
@@ -1483,7 +1736,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
-| **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] |
+| **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] |
 | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
 
@@ -1511,6 +1764,64 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getVMsFilterOptions
+
+> VMFilterOptionsResponse getVMsFilterOptions()
+
+Get distinct filter option values for VMs
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@openshift-migration-advisor/agent-sdk';
+import type { GetVMsFilterOptionsRequest } from '@openshift-migration-advisor/agent-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
+  const api = new DefaultApi();
+
+  try {
+    const data = await api.getVMsFilterOptions();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VMFilterOptionsResponse**](VMFilterOptionsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Filter options |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getVersion
 
 > VersionInfo getVersion()
@@ -1838,6 +2149,76 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## putCredentials
+
+> CredentialStatus putCredentials(vcenterCredentials)
+
+Store vCenter credentials
+
+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.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@openshift-migration-advisor/agent-sdk';
+import type { PutCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // VcenterCredentials
+    vcenterCredentials: ...,
+  } satisfies PutCredentialsRequest;
+
+  try {
+    const data = await api.putCredentials(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) |  | |
+
+### Return type
+
+[**CredentialStatus**](CredentialStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Credentials created and stored |  -  |
+| **200** | Credentials validated and stored |  -  |
+| **400** | Invalid credentials or unreachable vCenter |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## putForecasterCredentials
 
 > putForecasterCredentials(vcenterCredentials)

package/docs/Group.md

@@ -10,7 +10,6 @@ Name | Type
 `name` | string
 `description` | string
 `filter` | string
-`tags` | Array<string>
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -25,7 +24,6 @@ const example = {
   "name": null,
   "description": null,
   "filter": memory >= 8GB and cluster = 'prod',
-  "tags": ["production","critical"],
   "createdAt": null,
   "updatedAt": null,
 } satisfies Group

package/docs/GroupResponse.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `group` | [Group](Group.md)
+`inventory` | [Inventory](Inventory.md)
 `vms` | [Array<VirtualMachine>](VirtualMachine.md)
 `total` | number
 `page` | number
@@ -20,6 +21,7 @@ import type { GroupResponse } from '@openshift-migration-advisor/agent-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "group": null,
+  "inventory": null,
   "vms": null,
   "total": null,
   "page": null,

package/docs/InventoryData.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `vcenter` | [VCenter](VCenter.md)
 `clusterFeatures` | [ClusterFeatures](ClusterFeatures.md)
+`clusterUtilization` | [ClusterUtilization](ClusterUtilization.md)
 `vms` | [VMs](VMs.md)
 `infra` | [Infra](Infra.md)
 
@@ -20,6 +21,7 @@ import type { InventoryData } from '@openshift-migration-advisor/agent-sdk'
 const example = {
   "vcenter": null,
   "clusterFeatures": null,
+  "clusterUtilization": null,
   "vms": null,
   "infra": null,
 } satisfies InventoryData

package/docs/UpdateGroupRequest.md

@@ -9,7 +9,6 @@ Name | Type
 `name` | string
 `description` | string
 `filter` | string
-`tags` | Array<string>
 
 ## Example
 
@@ -21,7 +20,6 @@ const example = {
   "name": null,
   "description": null,
   "filter": null,
-  "tags": null,
 } satisfies UpdateGroupRequest
 
 console.log(example)

package/docs/VMFilterOptionsResponse.md

@@ -0,0 +1,42 @@
+
+# VMFilterOptionsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clusters` | Array<string>
+`datacenters` | Array<string>
+`concernLabels` | Array<string>
+`concernCategories` | Array<string>
+`applications` | Array<string>
+
+## Example
+
+```typescript
+import type { VMFilterOptionsResponse } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "clusters": null,
+  "datacenters": null,
+  "concernLabels": null,
+  "concernCategories": null,
+  "applications": null,
+} satisfies VMFilterOptionsResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as VMFilterOptionsResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/VMNIC.md

@@ -9,6 +9,8 @@ Name | Type
 `mac` | string
 `network` | string
 `index` | number
+`ipv4Address` | string
+`ipv6Address` | string
 
 ## Example
 
@@ -20,6 +22,8 @@ const example = {
   "mac": null,
   "network": null,
   "index": null,
+  "ipv4Address": null,
+  "ipv6Address": null,
 } satisfies VMNIC
 
 console.log(example)

package/docs/VcenterCredentials.md

@@ -9,6 +9,8 @@ Name | Type
 `url` | string
 `username` | string
 `password` | string
+`cacert` | string
+`skipTls` | boolean
 
 ## Example
 
@@ -20,6 +22,8 @@ const example = {
   "url": null,
   "username": null,
   "password": null,
+  "cacert": null,
+  "skipTls": null,
 } satisfies VcenterCredentials
 
 console.log(example)

package/docs/VirtualMachine.md

@@ -19,10 +19,12 @@ Name | Type
 `migrationExcluded` | boolean
 `inspectionStatus` | [VmInspectionStatus](VmInspectionStatus.md)
 `inspectionConcernCount` | number
-`tags` | Array<string>
+`groups` | Array<string>
 `labels` | Array<string>
 `utilization_cpu_p95` | number
 `utilization_mem_p95` | number
+`utilization_cpu_max` | number
+`utilization_mem_max` | number
 `utilization_disk` | number
 `utilization_confidence` | number
 
@@ -46,10 +48,12 @@ const example = {
   "migrationExcluded": null,
   "inspectionStatus": null,
   "inspectionConcernCount": null,
-  "tags": null,
+  "groups": null,
   "labels": null,
   "utilization_cpu_p95": null,
   "utilization_mem_p95": null,
+  "utilization_cpu_max": null,
+  "utilization_mem_max": null,
   "utilization_disk": null,
   "utilization_confidence": null,
 } satisfies VirtualMachine

package/docs/VmInspectionStatus.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `state` | string
+`message` | string
 `error` | string
 `results` | object
 
@@ -18,6 +19,7 @@ import type { VmInspectionStatus } from '@openshift-migration-advisor/agent-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "state": null,
+  "message": null,
   "error": null,
   "results": null,
 } satisfies VmInspectionStatus

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/agent-sdk",
-  "version": "0.12.0-645d2fae3eee",
+  "version": "0.12.0-73dd4924f11b",
   "description": "OpenAPI client for @openshift-migration-advisor/agent-sdk",
   "author": "OpenAPI-Generator",
   "repository": {