Jump to

• Request
• Response

Gets all VMs

get

/kvm/vm

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

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

Nested Schema : Vm

Type: object

Show Source

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

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

Nested Schema : VmConfig

Type: object

Show Source

• cpuConfig(optional): object VmConfigCpu
• memoryConfig(optional): object VmConfigMemory
• vmVDisks(optional): array vmVDisks
• vmVNetworks(optional): array vmVNetworks

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

Nested Schema : VmStatus

Type: object

Show Source

• currNode(optional): string
• currState(optional): string
• targetState(optional): string

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

Nested Schema : VmConfigCpu

Type: object

Show Source

• cpuPoolName(optional): string
• detail(optional): array detail
• effectiveCpuSet(optional): string
• maxVCpuCount(optional): integer
• vCpuCount(optional): integer

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

Nested Schema : VmConfigMemory

Type: object

Show Source

• maxMemorySizeFormatted(optional): string
• maxMemorySizeInMb(optional): integer
• memorySizeFormatted(optional): string
• memorySizeInMb(optional): integer

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

Nested Schema : vmVDisks

Type: array

Show Source

• Array of: object VmVDisk

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

Nested Schema : vmVNetworks

Type: array

Show Source

• Array of: object VmVNetwork

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

Nested Schema : detail

Type: array

Show Source

• Array of: object VmConfigCpuDetail

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

Nested Schema : VmConfigCpuDetail

Type: object

Show Source

• effectiveCpuSet(optional): string
• pinned(optional): boolean
• vCpuId(optional): integer

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

Nested Schema : VmVDisk

Type: object

Show Source

• targetDev(optional): string
• vDiskName(optional): string
• vmName(optional): string

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

Nested Schema : VmVNetwork

Type: object

Show Source

• dbSystemName(optional): string
• macAddress(optional): string
• pciAddress(optional): string
• vmName(optional): string
• vNetworkName(optional): string

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

Default Response

An unexpected error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
• message: string

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

Back to Top