@openshift-migration-advisor/agent-sdk 0.0.0-62ab9022d189

package/docs/DiskSizeTierSummary.md

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

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

@@ -0,0 +1,42 @@
+
+# GetInventory200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`vcenterId` | string
+`clusters` | [{ [key: string]: InventoryData; }](InventoryData.md)
+`vcenter` | [InventoryData](InventoryData.md)
+`agentId` | string
+`inventory` | [Inventory](Inventory.md)
+
+## Example
+
+```typescript
+import type { GetInventory200Response } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "vcenterId": null,
+  "clusters": null,
+  "vcenter": null,
+  "agentId": null,
+  "inventory": null,
+} satisfies GetInventory200Response
+
+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 GetInventory200Response
+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/Group.md

@@ -0,0 +1,46 @@
+
+# Group
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`filter` | string
+`tags` | Array<string>
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { Group } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "filter": memory >= 8GB and cluster = 'prod',
+  "tags": ["production","critical"],
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies Group
+
+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 Group
+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/GroupListResponse.md

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

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

@@ -0,0 +1,42 @@
+
+# GuestNetwork
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`device` | string
+`mac` | string
+`ip` | string
+`prefixLength` | number
+`network` | string
+
+## Example
+
+```typescript
+import type { GuestNetwork } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "device": null,
+  "mac": null,
+  "ip": null,
+  "prefixLength": null,
+  "network": null,
+} satisfies GuestNetwork
+
+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 GuestNetwork
+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/Histogram.md

@@ -0,0 +1,38 @@
+
+# Histogram
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`minValue` | number
+`step` | number
+`data` | Array<number>
+
+## Example
+
+```typescript
+import type { Histogram } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "minValue": null,
+  "step": null,
+  "data": null,
+} satisfies Histogram
+
+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 Histogram
+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/Host.md

@@ -0,0 +1,44 @@
+
+# Host
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`vendor` | string
+`model` | string
+`cpuCores` | number
+`cpuSockets` | number
+`memoryMB` | number
+
+## Example
+
+```typescript
+import type { Host } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "vendor": null,
+  "model": null,
+  "cpuCores": null,
+  "cpuSockets": null,
+  "memoryMB": null,
+} satisfies Host
+
+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 Host
+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/Infra.md

@@ -0,0 +1,56 @@
+
+# Infra
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalHosts` | number
+`totalDatacenters` | number
+`totalClusters` | number
+`clustersPerDatacenter` | Array<number>
+`cpuOverCommitment` | number
+`memoryOverCommitment` | number
+`hosts` | [Array<Host>](Host.md)
+`hostsPerCluster` | Array<number>
+`vmsPerCluster` | Array<number>
+`hostPowerStates` | { [key: string]: number; }
+`networks` | [Array<Network>](Network.md)
+`datastores` | [Array<Datastore>](Datastore.md)
+
+## Example
+
+```typescript
+import type { Infra } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalHosts": null,
+  "totalDatacenters": null,
+  "totalClusters": null,
+  "clustersPerDatacenter": null,
+  "cpuOverCommitment": null,
+  "memoryOverCommitment": null,
+  "hosts": null,
+  "hostsPerCluster": null,
+  "vmsPerCluster": null,
+  "hostPowerStates": null,
+  "networks": null,
+  "datastores": null,
+} satisfies Infra
+
+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 Infra
+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/InspectorStartRequest.md

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

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

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

@@ -0,0 +1,38 @@
+
+# InventoryData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`vcenter` | [VCenter](VCenter.md)
+`vms` | [VMs](VMs.md)
+`infra` | [Infra](Infra.md)
+
+## Example
+
+```typescript
+import type { InventoryData } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "vcenter": null,
+  "vms": null,
+  "infra": null,
+} satisfies InventoryData
+
+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 InventoryData
+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/MigrationIssue.md

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

@@ -0,0 +1,42 @@
+
+# Network
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`name` | string
+`vlanId` | string
+`dvswitch` | string
+`vmsCount` | number
+
+## Example
+
+```typescript
+import type { Network } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "name": null,
+  "vlanId": null,
+  "dvswitch": null,
+  "vmsCount": null,
+} satisfies Network
+
+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 Network
+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)
+
+