Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Deploying virtual machine from OVA or OVF images has been one of the core features of the RESTful API. Now, you are able to upload any Open Virtualization Format archives in your personal space at https://vskeys-tor.eis.utoronto.ca and use it to deploy one or many virtual machines. 

It is also possible to export an existent virtual machine (Virtual Machine - Attributes) to OVF and then use this OVF to deploy new ones. 

Panel

On this page:

Table of Contents
outlinetrue

The following table shows a brief description and HTTP methods allowed to interact with Open Virtualization Format images:

ResourceURIDescriptionGETPOSTPUTPATCHOPTIONS
Images/imageOVF/OVA Virtual Machine images available from VSKEY-STOR.(tick)    (tick)
Note
titleOPTIONS HTTP method

Remember, you can also show what methods are allowed and description, parameters, etc. by making an OPTIONS HTTP request to /v2/image.

Code Block
languagebash
http OPTIONS "https://vss-api.eis.utoronto.ca:8001/v2/image"
curl -X OPTIONS "https://vss-api.eis.utoronto.ca:8001/v2/image"

List

In order to list available OVA/OVF images you should make a GET request to the endpoint /v2/image passing your access token. As a result, you will get list of images available in your VSKEY-STOR space in form of JSON objects with the following attributes:

NameTypeDescription
namestringOVA/OVF image file name
pathstringPersonal space path

The following examples implements HTTPie and CURL to list available OVA/OVF images:

Code Block
http -a $TK GET "https://vss-api.eis.utoronto.ca:8001/v2/image"
curl -u $TK -X GET "https://vss-api.eis.utoronto.ca:8001/v2/image"
Code Block
languagepy
titleResponse Body
collapsetrue
{
    "_links": {
        "api": "https://vss-api.eis.utoronto.ca:8001/v2/",
        "self": "https://vss-api.eis.utoronto.ca:8001/v2/image"
    },
    "data": [
        {
            "name": "1605T-sick_stallman",
            "path": "50124dc2-aba4-5c57-130c-da207557e5bd/1605T-sick_stallman.ovf"
        },
        {
            "name": "coreos_production_vmware_ova",
            "path": "coreos_production_vmware_ova.ova"
        },
        {
            "name": "photon-custom-1.0-37d64ad-RC1",
            "path": "photon-custom-1.0-37d64ad-RC1.ova"
        },
        {
            "name": "photon-custom-1.0-a6f0f63-RC",
            "path": "photon-custom-1.0-a6f0f63-RC.ova"
        }
    ],
    "meta": {
        "count": 5,
        "time": "0.25403s",
        "user": "jm"
    }
}
Note

The attribute value you will use to deploy new virtual machines using an image is path.