Get Ovf Machine

Get Ovf Machine

Retrieves a OVF/OVA VM template from url

Request
URI
POST
https://{api_host}/iaas-proxy-provider/api/source-machines/ovf
COPY
Query Parameters
string
ovfUrl
Required

The OVF location url

Request Body

Authentication details

OvfAuth of type(s) application/json
Optional 
{
    "password": "string",
    "proxyEndpointId": "string",
    "thumbprint": "string",
    "userName": "string",
    "trustAllCerts": false
}
string
password
Optional

password

string
proxyEndpointId
Optional

proxyEndpointId

string
thumbprint
Optional

thumbprint

string
userName
Optional

userName

boolean
trustAllCerts
Optional

trustAllCerts

Responses
200

The ovf virtual machine template 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

array of MachineDisk
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

array of MachineProperty
properties
Optional

properties

string
status
Optional

status

integer As int64 As int64
storageGB
Optional

storageGB


On This Page
Internal Operations
POST
Get Ovf Machine
GET
Get Virtual Machine
GET
List Virtual Machines