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

package/docs/OsInfo.md

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

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

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

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

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

@@ -0,0 +1,46 @@
+
+# VMDisk
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | number
+`file` | string
+`capacity` | number
+`shared` | boolean
+`rdm` | boolean
+`bus` | string
+`mode` | string
+
+## Example
+
+```typescript
+import type { VMDisk } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "file": null,
+  "capacity": null,
+  "shared": null,
+  "rdm": null,
+  "bus": null,
+  "mode": null,
+} satisfies VMDisk
+
+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 VMDisk
+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/VMIssue.md

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

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

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

@@ -0,0 +1,72 @@
+
+# VMs
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`totalMigratable` | number
+`totalMigratableWithWarnings` | number
+`totalWithSharedDisks` | number
+`cpuCores` | [VMResourceBreakdown](VMResourceBreakdown.md)
+`diskSizeTier` | [{ [key: string]: DiskSizeTierSummary; }](DiskSizeTierSummary.md)
+`diskTypes` | [{ [key: string]: DiskTypeSummary; }](DiskTypeSummary.md)
+`distributionByCpuTier` | { [key: string]: number; }
+`distributionByMemoryTier` | { [key: string]: number; }
+`distributionByNicCount` | { [key: string]: number; }
+`distributionByComplexity` | { [key: string]: number; }
+`ramGB` | [VMResourceBreakdown](VMResourceBreakdown.md)
+`diskGB` | [VMResourceBreakdown](VMResourceBreakdown.md)
+`diskCount` | [VMResourceBreakdown](VMResourceBreakdown.md)
+`nicCount` | [VMResourceBreakdown](VMResourceBreakdown.md)
+`powerStates` | { [key: string]: number; }
+`os` | { [key: string]: number; }
+`osInfo` | [{ [key: string]: OsInfo; }](OsInfo.md)
+`notMigratableReasons` | [Array<MigrationIssue>](MigrationIssue.md)
+`migrationWarnings` | [Array<MigrationIssue>](MigrationIssue.md)
+
+## Example
+
+```typescript
+import type { VMs } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+  "totalMigratable": null,
+  "totalMigratableWithWarnings": null,
+  "totalWithSharedDisks": null,
+  "cpuCores": null,
+  "diskSizeTier": null,
+  "diskTypes": null,
+  "distributionByCpuTier": null,
+  "distributionByMemoryTier": null,
+  "distributionByNicCount": null,
+  "distributionByComplexity": null,
+  "ramGB": null,
+  "diskGB": null,
+  "diskCount": null,
+  "nicCount": null,
+  "powerStates": null,
+  "os": null,
+  "osInfo": null,
+  "notMigratableReasons": null,
+  "migrationWarnings": null,
+} satisfies VMs
+
+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 VMs
+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/VcenterCredentials.md

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

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

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

@@ -0,0 +1,56 @@
+
+# VirtualMachine
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`id` | string
+`vCenterState` | string
+`cluster` | string
+`datacenter` | string
+`diskSize` | number
+`memory` | number
+`issueCount` | number
+`migratable` | boolean
+`template` | boolean
+`inspection` | [VmInspectionStatus](VmInspectionStatus.md)
+`tags` | Array<string>
+
+## Example
+
+```typescript
+import type { VirtualMachine } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "id": null,
+  "vCenterState": null,
+  "cluster": null,
+  "datacenter": null,
+  "diskSize": null,
+  "memory": null,
+  "issueCount": null,
+  "migratable": null,
+  "template": null,
+  "inspection": null,
+  "tags": null,
+} satisfies VirtualMachine
+
+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 VirtualMachine
+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/VirtualMachineDetail.md

@@ -0,0 +1,94 @@
+
+# VirtualMachineDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`uuid` | string
+`firmware` | string
+`powerState` | string
+`connectionState` | string
+`host` | string
+`datacenter` | string
+`cluster` | string
+`folder` | string
+`cpuCount` | number
+`coresPerSocket` | number
+`cpuAffinity` | Array<number>
+`memoryMB` | number
+`guestName` | string
+`guestId` | string
+`hostName` | string
+`ipAddress` | string
+`storageUsed` | number
+`template` | boolean
+`migratable` | boolean
+`faultToleranceEnabled` | boolean
+`nestedHVEnabled` | boolean
+`toolsStatus` | string
+`toolsRunningStatus` | string
+`disks` | [Array<VMDisk>](VMDisk.md)
+`nics` | [Array<VMNIC>](VMNIC.md)
+`devices` | [Array<VMDevice>](VMDevice.md)
+`guestNetworks` | [Array<GuestNetwork>](GuestNetwork.md)
+`issues` | [Array<VMIssue>](VMIssue.md)
+`inspection` | [VmInspectionStatus](VmInspectionStatus.md)
+
+## Example
+
+```typescript
+import type { VirtualMachineDetail } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "uuid": null,
+  "firmware": null,
+  "powerState": null,
+  "connectionState": null,
+  "host": null,
+  "datacenter": null,
+  "cluster": null,
+  "folder": null,
+  "cpuCount": null,
+  "coresPerSocket": null,
+  "cpuAffinity": null,
+  "memoryMB": null,
+  "guestName": null,
+  "guestId": null,
+  "hostName": null,
+  "ipAddress": null,
+  "storageUsed": null,
+  "template": null,
+  "migratable": null,
+  "faultToleranceEnabled": null,
+  "nestedHVEnabled": null,
+  "toolsStatus": null,
+  "toolsRunningStatus": null,
+  "disks": null,
+  "nics": null,
+  "devices": null,
+  "guestNetworks": null,
+  "issues": null,
+  "inspection": null,
+} satisfies VirtualMachineDetail
+
+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 VirtualMachineDetail
+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)
+
+