Previous Next JavaScript must be enabled to correctly display this content

## Gets all VMs

get

/kvm/vm

Gets all VMs

### Request

There are no request parameters for this operation.

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

OK
Body ()
Root Schema : schema
Type: `array`
Show Source

- Array of: object Vm

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/Vm"
        }
    }

Nested Schema : Vm
Type: `object`
Show Source

- autoStart: boolean
- bootOptions: string
- clonedFrom: string
- createTime: string(date-time)
- description: string
- diskImagePath: string
- diskSizeFormatted: string
- diskSizeInGb: number(double)
- displayPort: string
- failOver: boolean
- graphicsSettings: string
- id: string
- name: string
- nonRunningConfig: object VmConfig
- numaEnabled: boolean
- osType: string
- osVariant: string
- prefNode: string
- runningConfig: object VmConfig
- source: string
- state: string
- status: object VmStatus
- updateTime: string(date-time)
- vmStorageName: string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            },
            "name":{
                "type":"string"
            },
            "state":{
                "type":"string"
            },
            "createTime":{
                "type":"string",
                "format":"date-time"
            },
            "updateTime":{
                "type":"string",
                "format":"date-time"
            },
            "description":{
                "type":"string"
            },
            "vmStorageName":{
                "type":"string"
            },
            "diskImagePath":{
                "type":"string"
            },
            "diskSizeInGb":{
                "type":"number",
                "format":"double"
            },
            "diskSizeFormatted":{
                "type":"string"
            },
            "source":{
                "type":"string"
            },
            "runningConfig":{
                "$ref":"#/definitions/VmConfig"
            },
            "nonRunningConfig":{
                "$ref":"#/definitions/VmConfig"
            },
            "graphicsSettings":{
                "type":"string"
            },
            "displayPort":{
                "type":"string"
            },
            "osType":{
                "type":"string"
            },
            "osVariant":{
                "type":"string"
            },
            "autoStart":{
                "type":"boolean"
            },
            "bootOptions":{
                "type":"string"
            },
            "failOver":{
                "type":"boolean"
            },
            "prefNode":{
                "type":"string"
            },
            "numaEnabled":{
                "type":"boolean"
            },
            "status":{
                "$ref":"#/definitions/VmStatus"
            },
            "clonedFrom":{
                "type":"string"
            }
        }
    }

Nested Schema : VmConfig
Type: `object`
Show Source

- cpuConfig: object VmConfigCpu
- memoryConfig: object VmConfigMemory
- vmVDisks: array vmVDisks
- vmVNetworks: array vmVNetworks

    {
        "type":"object",
        "properties":{
            "memoryConfig":{
                "$ref":"#/definitions/VmConfigMemory"
            },
            "cpuConfig":{
                "$ref":"#/definitions/VmConfigCpu"
            },
            "vmVDisks":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/VmVDisk"
                }
            },
            "vmVNetworks":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/VmVNetwork"
                }
            }
        }
    }

Nested Schema : VmStatus
Type: `object`
Show Source

- currNode: string
- currState: string
- targetState: string

    {
        "type":"object",
        "properties":{
            "currNode":{
                "type":"string"
            },
            "currState":{
                "type":"string"
            },
            "targetState":{
                "type":"string"
            }
        }
    }

Nested Schema : VmConfigCpu
Type: `object`
Show Source

- cpuPoolName: string
- detail: array detail
- effectiveCpuSet: string
- maxVCpuCount: integer
- vCpuCount: integer

    {
        "type":"object",
        "properties":{
            "vCpuCount":{
                "type":"integer"
            },
            "maxVCpuCount":{
                "type":"integer"
            },
            "cpuPoolName":{
                "type":"string"
            },
            "effectiveCpuSet":{
                "type":"string"
            },
            "detail":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/VmConfigCpuDetail"
                }
            }
        }
    }

Nested Schema : VmConfigMemory
Type: `object`
Show Source

- maxMemorySizeFormatted: string
- maxMemorySizeInMb: integer
- memorySizeFormatted: string
- memorySizeInMb: integer

    {
        "type":"object",
        "properties":{
            "memorySizeInMb":{
                "type":"integer"
            },
            "memorySizeFormatted":{
                "type":"string"
            },
            "maxMemorySizeInMb":{
                "type":"integer"
            },
            "maxMemorySizeFormatted":{
                "type":"string"
            }
        }
    }

Nested Schema : vmVDisks
Type: `array`
Show Source

- Array of: object VmVDisk

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/VmVDisk"
        }
    }

Nested Schema : vmVNetworks
Type: `array`
Show Source

- Array of: object VmVNetwork

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/VmVNetwork"
        }
    }

Nested Schema : detail
Type: `array`
Show Source

- Array of: object VmConfigCpuDetail

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/VmConfigCpuDetail"
        }
    }

Nested Schema : VmConfigCpuDetail
Type: `object`
Show Source

- effectiveCpuSet: string
- pinned: boolean
- vCpuId: integer

    {
        "type":"object",
        "properties":{
            "vCpuId":{
                "type":"integer"
            },
            "effectiveCpuSet":{
                "type":"string"
            },
            "pinned":{
                "type":"boolean"
            }
        }
    }

Nested Schema : VmVDisk
Type: `object`
Show Source

- dbSystemName: string
- targetDev: string
- vDiskName: string
- vmName: string

    {
        "type":"object",
        "properties":{
            "vDiskName":{
                "type":"string"
            },
            "vmName":{
                "type":"string"
            },
            "targetDev":{
                "type":"string"
            },
            "dbSystemName":{
                "type":"string"
            }
        }
    }

Nested Schema : VmVNetwork
Type: `object`
Show Source

- dbSystemName: string
- macAddress: string
- pciAddress: string
- vmName: string
- vNetworkName: string

    {
        "type":"object",
        "properties":{
            "vNetworkName":{
                "type":"string"
            },
            "vmName":{
                "type":"string"
            },
            "dbSystemName":{
                "type":"string"
            },
            "macAddress":{
                "type":"string"
            },
            "pciAddress":{
                "type":"string"
            }
        }
    }

#### Default Response

An unexpected error has occurred
Body ()
Root Schema : Error
Type: `object`
Show Source

- code(required): string
- message(required): string

    {
        "required":[
            "code",
            "message"
        ],
        "properties":{
            "code":{
                "type":"string"
            },
            "message":{
                "type":"string"
            }
        }
    }

Back to Top