Get Virtual Machine

Get Virtual Machine

Retrieves a VM template by id or name with disks.

Request
URI
GET
https://{api_host}/iaas-proxy-provider/api/source-machines/{id}
COPY
Path Parameters
string
id
Required

The ID of the IaaS service as registered in the Component Registry service.

Query Parameters
string
platformTypeId
Required

The platform type id.

string
templateName
Optional

The name of the template.


Responses
200

The virtual machine is retrieved.

Returns Machine of type(s) */*
{
    "hostName": "string",
    "disks": [
        {
            "name": "string",
            "externalDiskId": "string",
            "id": "string",
            "deviceId": "string",
            "capacity": 0
        }
    ],
    "description": "string",
    "externalId": "string",
    "endpointName": "string",
    "cpu": 0,
    "guestOsFamily": "string",
    "reservationName": "string",
    "parentTemplate": "string",
    "memoryMB": 0,
    "interfaceType": "string",
    "isTemplate": false,
    "name": "string",
    "id": "string",
    "region": "string",
    "properties": [
        {
            "virtualMachineId": "string",
            "isEncrypted": false,
            "name": "string",
            "id": "string",
            "value": "string",
            "isRuntime": false,
            "isHidden": false
        }
    ],
    "status": "string",
    "storageGB": 0
}
string
hostName
Optional

hostName

disks
Optional

disks

string
description
Optional

description

string
externalId
Optional

externalId

string
endpointName
Optional

endpointName

integer As int64 As int64
cpu
Optional

cpu

string
guestOsFamily
Optional

guestOsFamily

string
reservationName
Optional

reservationName

string
parentTemplate
Optional

parentTemplate

integer As int64 As int64
memoryMB
Optional

memoryMB

string
interfaceType
Optional

interfaceType

Possible values are : VSPHERE, KVM, SCVMM,
boolean
isTemplate
Optional

isTemplate

string
name
Required

name

string
id
Optional

id

string
region
Optional

region

properties
Optional

properties

string
status
Optional

status

integer As int64 As int64
storageGB
Optional

storageGB