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

package/docs/DeleteLabelGloballyResponse.md

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

@@ -6,7 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`vcenterId` | string
+`vcenter_id` | string
+`vcenter_version` | string
 `clusters` | [{ [key: string]: InventoryData; }](InventoryData.md)
 `vcenter` | [InventoryData](InventoryData.md)
 `agentId` | string
@@ -19,7 +20,8 @@ import type { GetInventory200Response } from '@openshift-migration-advisor/agent
 
 // TODO: Update the object below with actual values
 const example = {
-  "vcenterId": null,
+  "vcenter_id": null,
+  "vcenter_version": null,
   "clusters": null,
   "vcenter": null,
   "agentId": null,

package/docs/InspectorStatus.md

@@ -7,9 +7,7 @@
 Name | Type
 ------------ | -------------
 `state` | string
-`credentials` | [VcenterCredentials](VcenterCredentials.md)
 `vddk` | [VddkProperties](VddkProperties.md)
-`error` | string
 
 ## Example
 
@@ -19,9 +17,7 @@ import type { InspectorStatus } from '@openshift-migration-advisor/agent-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "state": null,
-  "credentials": null,
   "vddk": null,
-  "error": null,
 } satisfies InspectorStatus
 
 console.log(example)

package/docs/Inventory.md

@@ -6,7 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`vcenterId` | string
+`vcenter_id` | string
+`vcenter_version` | string
 `clusters` | [{ [key: string]: InventoryData; }](InventoryData.md)
 `vcenter` | [InventoryData](InventoryData.md)
 
@@ -17,7 +18,8 @@ import type { Inventory } from '@openshift-migration-advisor/agent-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "vcenterId": null,
+  "vcenter_id": null,
+  "vcenter_version": null,
   "clusters": null,
   "vcenter": null,
 } satisfies Inventory

package/docs/InventoryData.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `vcenter` | [VCenter](VCenter.md)
+`clusterFeatures` | [ClusterFeatures](ClusterFeatures.md)
 `vms` | [VMs](VMs.md)
 `infra` | [Infra](Infra.md)
 
@@ -18,6 +19,7 @@ import type { InventoryData } from '@openshift-migration-advisor/agent-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "vcenter": null,
+  "clusterFeatures": null,
   "vms": null,
   "infra": null,
 } satisfies InventoryData

package/docs/RightsizingClusterListResponse.md

@@ -6,7 +6,7 @@
 
 Name | Type
 ------------ | -------------
-`reportId` | string
+`report_id` | string
 `clusters` | [Array<RightsizingClusterUtilization>](RightsizingClusterUtilization.md)
 
 ## Example
@@ -16,7 +16,7 @@ import type { RightsizingClusterListResponse } from '@openshift-migration-adviso
 
 // TODO: Update the object below with actual values
 const example = {
-  "reportId": null,
+  "report_id": null,
   "clusters": null,
 } satisfies RightsizingClusterListResponse
 

package/docs/RightsizingClusterResponse.md

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

@@ -6,20 +6,20 @@
 
 Name | Type
 ------------ | -------------
-`clusterId` | string
-`clusterName` | string
-`vmCount` | number
-`cpuAvg` | number
-`cpuP95` | number
-`cpuMax` | number
-`memAvg` | number
-`memP95` | number
-`memMax` | number
+`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
-`totalProvisionedCpus` | number
-`totalProvisionedMemoryMb` | number
-`totalProvisionedDiskKb` | number
+`total_provisioned_cpus` | number
+`total_provisioned_memory_mb` | number
+`total_provisioned_disk_kb` | number
 
 ## Example
 
@@ -28,20 +28,20 @@ import type { RightsizingClusterUtilization } from '@openshift-migration-advisor
 
 // TODO: Update the object below with actual values
 const example = {
-  "clusterId": null,
-  "clusterName": null,
-  "vmCount": null,
-  "cpuAvg": null,
-  "cpuP95": null,
-  "cpuMax": null,
-  "memAvg": null,
-  "memP95": null,
-  "memMax": null,
+  "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,
-  "totalProvisionedCpus": null,
-  "totalProvisionedMemoryMb": null,
-  "totalProvisionedDiskKb": null,
+  "total_provisioned_cpus": null,
+  "total_provisioned_memory_mb": null,
+  "total_provisioned_disk_kb": null,
 } satisfies RightsizingClusterUtilization
 
 console.log(example)

package/docs/RightsizingCollectRequest.md

@@ -7,12 +7,12 @@
 Name | Type
 ------------ | -------------
 `credentials` | [VcenterCredentials](VcenterCredentials.md)
-`lookbackHours` | number
-`intervalId` | number
-`nameFilter` | string
-`clusterId` | string
-`batchSize` | number
-`discoverVms` | boolean
+`lookback_hours` | number
+`interval_id` | number
+`name_filter` | string
+`cluster_id` | string
+`batch_size` | number
+`discover_vms` | boolean
 
 ## Example
 
@@ -22,12 +22,12 @@ import type { RightsizingCollectRequest } from '@openshift-migration-advisor/age
 // TODO: Update the object below with actual values
 const example = {
   "credentials": null,
-  "lookbackHours": null,
-  "intervalId": null,
-  "nameFilter": null,
-  "clusterId": null,
-  "batchSize": null,
-  "discoverVms": null,
+  "lookback_hours": null,
+  "interval_id": null,
+  "name_filter": null,
+  "cluster_id": null,
+  "batch_size": null,
+  "discover_vms": null,
 } satisfies RightsizingCollectRequest
 
 console.log(example)

package/docs/RightsizingMetricStats.md

@@ -6,7 +6,7 @@
 
 Name | Type
 ------------ | -------------
-`sampleCount` | number
+`sample_count` | number
 `average` | number
 `p95` | number
 `p99` | number
@@ -20,7 +20,7 @@ import type { RightsizingMetricStats } from '@openshift-migration-advisor/agent-
 
 // TODO: Update the object below with actual values
 const example = {
-  "sampleCount": null,
+  "sample_count": null,
   "average": null,
   "p95": null,
   "p99": null,

package/docs/RightsizingReport.md

@@ -8,13 +8,13 @@ Name | Type
 ------------ | -------------
 `id` | string
 `vcenter` | string
-`clusterId` | string
-`windowStart` | Date
-`windowEnd` | Date
-`intervalId` | number
-`expectedSampleCount` | number
+`cluster_id` | string
+`window_start` | Date
+`window_end` | Date
+`interval_id` | number
+`expected_sample_count` | number
 `vms` | [Array<RightsizingVMReport>](RightsizingVMReport.md)
-`createdAt` | Date
+`created_at` | Date
 
 ## Example
 
@@ -25,13 +25,13 @@ import type { RightsizingReport } from '@openshift-migration-advisor/agent-sdk'
 const example = {
   "id": null,
   "vcenter": null,
-  "clusterId": null,
-  "windowStart": null,
-  "windowEnd": null,
-  "intervalId": null,
-  "expectedSampleCount": null,
+  "cluster_id": null,
+  "window_start": null,
+  "window_end": null,
+  "interval_id": null,
+  "expected_sample_count": null,
   "vms": null,
-  "createdAt": null,
+  "created_at": null,
 } satisfies RightsizingReport
 
 console.log(example)

package/docs/RightsizingReportSummary.md

@@ -9,12 +9,12 @@ Name | Type
 ------------ | -------------
 `id` | string
 `vcenter` | string
-`clusterId` | string
-`windowStart` | Date
-`windowEnd` | Date
-`intervalId` | number
-`expectedSampleCount` | number
-`createdAt` | Date
+`cluster_id` | string
+`window_start` | Date
+`window_end` | Date
+`interval_id` | number
+`expected_sample_count` | number
+`created_at` | Date
 
 ## Example
 
@@ -25,12 +25,12 @@ import type { RightsizingReportSummary } from '@openshift-migration-advisor/agen
 const example = {
   "id": null,
   "vcenter": null,
-  "clusterId": null,
-  "windowStart": null,
-  "windowEnd": null,
-  "intervalId": null,
-  "expectedSampleCount": null,
-  "createdAt": 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)

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/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,40 @@
+
+# VMFilterOptionsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clusters` | Array<string>
+`datacenters` | Array<string>
+`concernLabels` | Array<string>
+`concernCategories` | 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,
+} 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/VirtualMachine.md

@@ -16,13 +16,15 @@ Name | Type
 `issueCount` | number
 `migratable` | boolean
 `template` | boolean
+`migrationExcluded` | boolean
 `inspectionStatus` | [VmInspectionStatus](VmInspectionStatus.md)
 `inspectionConcernCount` | number
 `tags` | Array<string>
-`utilizationCpuP95` | number
-`utilizationMemP95` | number
-`utilizationDisk` | number
-`utilizationConfidence` | number
+`labels` | Array<string>
+`utilization_cpu_p95` | number
+`utilization_mem_p95` | number
+`utilization_disk` | number
+`utilization_confidence` | number
 
 ## Example
 
@@ -41,13 +43,15 @@ const example = {
   "issueCount": null,
   "migratable": null,
   "template": null,
+  "migrationExcluded": null,
   "inspectionStatus": null,
   "inspectionConcernCount": null,
   "tags": null,
-  "utilizationCpuP95": null,
-  "utilizationMemP95": null,
-  "utilizationDisk": null,
-  "utilizationConfidence": null,
+  "labels": null,
+  "utilization_cpu_p95": null,
+  "utilization_mem_p95": 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)
+
+