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

package/docs/RightsizingClusterUtilization.md

@@ -0,0 +1,60 @@
+
+# RightsizingClusterUtilization
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cluster_id` | string
+`cluster_name` | string
+`vm_count` | number
+`cpu_avg` | number
+`cpu_p95` | number
+`cpu_max` | number
+`mem_avg` | number
+`mem_p95` | number
+`mem_max` | number
+`disk` | number
+`confidence` | number
+`total_provisioned_cpus` | number
+`total_provisioned_memory_mb` | number
+`total_provisioned_disk_kb` | number
+
+## Example
+
+```typescript
+import type { RightsizingClusterUtilization } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cluster_id": null,
+  "cluster_name": null,
+  "vm_count": null,
+  "cpu_avg": null,
+  "cpu_p95": null,
+  "cpu_max": null,
+  "mem_avg": null,
+  "mem_p95": null,
+  "mem_max": null,
+  "disk": null,
+  "confidence": null,
+  "total_provisioned_cpus": null,
+  "total_provisioned_memory_mb": null,
+  "total_provisioned_disk_kb": null,
+} satisfies RightsizingClusterUtilization
+
+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 RightsizingClusterUtilization
+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/RightsizingCollectRequest.md

@@ -0,0 +1,46 @@
+
+# RightsizingCollectRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`credentials` | [VcenterCredentials](VcenterCredentials.md)
+`lookback_hours` | number
+`interval_id` | number
+`name_filter` | string
+`cluster_id` | string
+`batch_size` | number
+`discover_vms` | boolean
+
+## Example
+
+```typescript
+import type { RightsizingCollectRequest } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "credentials": null,
+  "lookback_hours": null,
+  "interval_id": null,
+  "name_filter": null,
+  "cluster_id": null,
+  "batch_size": null,
+  "discover_vms": null,
+} satisfies RightsizingCollectRequest
+
+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 RightsizingCollectRequest
+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/RightsizingMetricStats.md

@@ -0,0 +1,44 @@
+
+# RightsizingMetricStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sample_count` | number
+`average` | number
+`p95` | number
+`p99` | number
+`max` | number
+`latest` | number
+
+## Example
+
+```typescript
+import type { RightsizingMetricStats } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sample_count": null,
+  "average": null,
+  "p95": null,
+  "p99": null,
+  "max": null,
+  "latest": null,
+} satisfies RightsizingMetricStats
+
+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 RightsizingMetricStats
+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/RightsizingReport.md

@@ -0,0 +1,50 @@
+
+# RightsizingReport
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`vcenter` | string
+`cluster_id` | string
+`window_start` | Date
+`window_end` | Date
+`interval_id` | number
+`expected_sample_count` | number
+`vms` | [Array<RightsizingVMReport>](RightsizingVMReport.md)
+`created_at` | Date
+
+## Example
+
+```typescript
+import type { RightsizingReport } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "vcenter": null,
+  "cluster_id": null,
+  "window_start": null,
+  "window_end": null,
+  "interval_id": null,
+  "expected_sample_count": null,
+  "vms": null,
+  "created_at": null,
+} satisfies RightsizingReport
+
+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 RightsizingReport
+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/RightsizingReportListResponse.md

@@ -0,0 +1,36 @@
+
+# RightsizingReportListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reports` | [Array<RightsizingReportSummary>](RightsizingReportSummary.md)
+`total` | number
+
+## Example
+
+```typescript
+import type { RightsizingReportListResponse } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reports": null,
+  "total": null,
+} satisfies RightsizingReportListResponse
+
+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 RightsizingReportListResponse
+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/RightsizingReportSummary.md

@@ -0,0 +1,49 @@
+
+# RightsizingReportSummary
+
+Rightsizing report metadata without VM metrics. Use GET /rightsizing/{id} to retrieve the full report including metrics.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`vcenter` | string
+`cluster_id` | string
+`window_start` | Date
+`window_end` | Date
+`interval_id` | number
+`expected_sample_count` | number
+`created_at` | Date
+
+## Example
+
+```typescript
+import type { RightsizingReportSummary } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "vcenter": null,
+  "cluster_id": null,
+  "window_start": null,
+  "window_end": null,
+  "interval_id": null,
+  "expected_sample_count": null,
+  "created_at": null,
+} satisfies RightsizingReportSummary
+
+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 RightsizingReportSummary
+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/RightsizingVMReport.md

@@ -0,0 +1,40 @@
+
+# RightsizingVMReport
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`moid` | string
+`metrics` | [{ [key: string]: RightsizingMetricStats; }](RightsizingMetricStats.md)
+`warnings` | Array<string>
+
+## Example
+
+```typescript
+import type { RightsizingVMReport } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "moid": null,
+  "metrics": null,
+  "warnings": null,
+} satisfies RightsizingVMReport
+
+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 RightsizingVMReport
+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/StartInspectionRequest.md

@@ -1,13 +1,14 @@
 
 # StartInspectionRequest
 
-Array of VirtualMachine id
+Start inspection request
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `vmIds` | Array<string>
+`credentials` | [VcenterCredentials](VcenterCredentials.md)
 
 ## Example
 
@@ -17,6 +18,7 @@ import type { StartInspectionRequest } from '@openshift-migration-advisor/agent-
 // TODO: Update the object below with actual values
 const example = {
   "vmIds": null,
+  "credentials": null,
 } satisfies StartInspectionRequest
 
 console.log(example)

package/docs/StopForecasterPair202Response.md

@@ -0,0 +1,36 @@
+
+# StopForecasterPair202Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pairName` | string
+`state` | string
+
+## Example
+
+```typescript
+import type { StopForecasterPair202Response } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pairName": null,
+  "state": null,
+} satisfies StopForecasterPair202Response
+
+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 StopForecasterPair202Response
+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/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/UpdateLabelVMsRequest.md

@@ -0,0 +1,36 @@
+
+# UpdateLabelVMsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`add` | Array<string>
+`remove` | Array<string>
+
+## Example
+
+```typescript
+import type { UpdateLabelVMsRequest } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "add": null,
+  "remove": null,
+} satisfies UpdateLabelVMsRequest
+
+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 UpdateLabelVMsRequest
+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/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/VMLabelsResponse.md

@@ -0,0 +1,36 @@
+
+# VMLabelsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`labels` | Array<string>
+`counts` | Array<number>
+
+## Example
+
+```typescript
+import type { VMLabelsResponse } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "labels": ["production","staging","critical"],
+  "counts": [5,3,2],
+} satisfies VMLabelsResponse
+
+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 VMLabelsResponse
+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

@@ -16,9 +16,17 @@ Name | Type
 `issueCount` | number
 `migratable` | boolean
 `template` | boolean
+`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
 
 ## Example
 
@@ -37,9 +45,17 @@ const example = {
   "issueCount": null,
   "migratable": null,
   "template": null,
+  "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
 
 console.log(example)

package/docs/VirtualMachineDetail.md

@@ -27,6 +27,8 @@ Name | Type
 `storageUsed` | number
 `template` | boolean
 `migratable` | boolean
+`migrationExcluded` | boolean
+`labels` | Array<string>
 `faultToleranceEnabled` | boolean
 `nestedHVEnabled` | boolean
 `toolsStatus` | string
@@ -37,6 +39,7 @@ Name | Type
 `guestNetworks` | [Array<GuestNetwork>](GuestNetwork.md)
 `issues` | [Array<VMIssue>](VMIssue.md)
 `inspection` | [VmInspectionResults](VmInspectionResults.md)
+`utilization` | [VmUtilizationDetails](VmUtilizationDetails.md)
 
 ## Example
 
@@ -66,6 +69,8 @@ const example = {
   "storageUsed": null,
   "template": null,
   "migratable": null,
+  "migrationExcluded": null,
+  "labels": null,
   "faultToleranceEnabled": null,
   "nestedHVEnabled": null,
   "toolsStatus": null,
@@ -76,6 +81,7 @@ const example = {
   "guestNetworks": null,
   "issues": null,
   "inspection": null,
+  "utilization": null,
 } satisfies VirtualMachineDetail
 
 console.log(example)

package/docs/VirtualMachineUpdateRequest.md

@@ -0,0 +1,36 @@
+
+# VirtualMachineUpdateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`migrationExcluded` | boolean
+`labels` | Array<string>
+
+## Example
+
+```typescript
+import type { VirtualMachineUpdateRequest } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "migrationExcluded": true,
+  "labels": ["production","critical"],
+} satisfies VirtualMachineUpdateRequest
+
+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 VirtualMachineUpdateRequest
+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/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