Documentation

Skip to end of metadata
Go to start of metadata

Virtual Machine Templates Resource

Exposed Resources Hierarchy
Virtual Machine Templates Resource

Contents:

This resource allows you to manage templates for virtual machines.

Main URI of the Resource

This class operates mainly over the Resource URI: /admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates

Exposed Methods

Retrieve all virtual machine templates

Returns all virtual machine templates.

Paging Method

This method works with paging. Check out Basic Behaviors for information about how it works

Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates
Roles Required: ROLE_APPLIB_VIEW,ROLE_VDC_ENUMERATE,ROLE_VDC_MANAGE_VAPP, ROLE_VAPP_CUSTOMISE_SETTINGS,ROLE_VAPP_CREATE_STATEFUL
Request Headers: Accept: application/vnd.abiquo.virtualmachinetemplates+json; version=3.8; application/vnd.abiquo.virtualmachinetemplates+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

categoryName

false

 

name of a category

hypervisorTypeName

false

 

type of an hypervisor

virtualdatacenter

false

 

identifier of a virtual datacenter

stateful

false

 

string value to inclued persistent templates, it can be ALL, USED or NOTUSED

imported

false

false

boolean to include imported templates

ostype

false

 

comma separated value, optionally filter by operating systems (null for no filter)

64bits

false

 

optionally filter by x64 architecture. It requires ''ostype'' param set to null
(null for any filter)

startwith

false

0

first element to retrieve

by

false

id

ordering the request.

has

false

 

filter the request. With this parameter the response just contains the elements
which name matches the filter value.

limit

false

25

number of elements to return

asc

false

true

order ascending or descending. By default the sort mode is ascending.

source

false

LOCAL

LOCAL: only retrieve templates in the database
REMOTE: (public cloud only) search in the provider, it doesn't contain already LOCAL templates
ALL: (public cloud only) both LOCAL and REMOTE templates, may contains duplicated templates (local and remote representation for the same template)

pluginfalse (only valid when ''source=REMOTE'') specify the plugin used to retrieve templates (e.g DOCKER)
externalfalsetrueif false does not return templates managed by a plugin (if you are using Docker, the container images are not physically downloaded to the NFS repository. If you need to filter the templates that physically exists in the repository you can use the "external" query parameter, setting to 'true' or 'false', to include or not the templates that are not present in the NFS)
statesfalse if present only returns templates in the desired states (comma separated values)
masterfalse if specified only returns templates with or without master link relation
diskformattypesfalse if specified only returns templates with this disk format type, for example ISO. See DiskFormatTypesResource#Retrievealldiskformattypes

Request Message Body Entity:
Response Message Body Entity: VirtualMachineTemplates Media Type
Request Example:

Retrieve virtual machine templates

 Click here to show or hide the request example

API example removed: GET_adm_ents_X_dcrpos_X_vmtmps_AC_vmtmps_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Retrieve virtual machine templates by disk format type

 Click here to show or hide the request example

API example removed: GET_adm_ents_X_dcrpos_X_vmtmps_AC_vmtmps_j_dskfmttypes
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Retrieve virtual machine templates by disk format type and hypervisor type

 Click here to show or hide the request example

 

API example removed: GET_adm_ents_X_dcrpos_X_vmtmps_AC_vmtmps_j_hypervisorTypeName_dskfmttypes
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Retrieve virtual machine templates by a combination of many of the above parameters

 Click here to show or hide the request example

API example removed: GET_adm_ents_X_dcrpos_X_vmtmps_AC_vmtmps_j_src_startw_lmt_by_id_asc_F_plugin_desc_path_ostype_name_crUser_shared_F_64bits_T
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Create a new persistent template

This functionality creates a new persistent template from an existing template. To create the persistent template, the disk of the existing template will be dumped on a volume. The dto sent to this method contains:

  • two properties:
    • the name for the new volume 
    • the name for the new template
  • three required links: 
    • the link of the original template, which has the disk to dump to the volume
    • the link of the virtual datacenter, where the template will be accessible 
    • a link with the information about the storage device where the disk will be dumped, which could be a link to a specific volume or a link to a tier where a new volume will be created.

Important: this process requires a RAW conversion of the original template. If this conversion does not exist, it will be created as the first step of the process.

Synopsis: POST http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates
Roles Required: ROLE_VAPP_CREATE_STATEFUL,ROLE_APPLIB_ALLOW_MODIFY
Request Headers: Accept: application/vnd.abiquo.acceptedrequest+json; version=3.8; application/vnd.abiquo.acceptedrequest+xml; version=3.8;  Content-type:  application/vnd.abiquo.virtualmachinetemplatepersistent+json; version=3.8; application/vnd.abiquo.virtualmachinetemplatepersistent+xml; version=3.8;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: VirtualMachineTemplatePersistent Media Type
Response Message Body Entity: AcceptedRequest Media Type
Request Example:

 Click here to show or hide the request example

API example removed: POST_adm_ents_X_dcrpos_X_vmtmps_CT_vmtmppst_j_AC_acrq_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

 

Request creation of a new virtual machine template in the datacenter repository

There are different ways to create a new virtual machine template:

  • Download: use a ''TemplateDefinition'' link in the VirtualMachineTemplateRequestDto
  • Promote: use an instance ''VirtualMachineTemplate'' link and the ''promotedName'' in VirtualMachineTemplateRequestDto
    • Since Abiquo 3.4, you can supply links to the disks to be included in the new template 
  • Duplicate: use a "virtualmachinetemplate" link and the "promotedName" in the VirtualMachineTemplateRequestDto (since Abiquo 3.4)
    • Supply links to the disks to be included in the new template
  • Export: make the request by posting to the URL of the target datacenter 

All methods pre-create the virtual machine template and return a task to track the progress.

Synopsis: POST http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates
Roles Required: ROLE_VAPP_CREATE_STATEFUL,ROLE_APPLIB_ALLOW_MODIFY
Request Headers: Accept: application/vnd.abiquo.acceptedrequest+json; version=3.8; application/vnd.abiquo.acceptedrequest+xml; version=3.8;  Content-type:  application/vnd.abiquo.virtualmachinetemplaterequest+json; version=3.8; application/vnd.abiquo.virtualmachinetemplaterequest+xml; version=3.8;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: VirtualMachineTemplateRequest Media Type
Response Message Body Entity: AcceptedRequest Media Type
Request Example:

Download a template definition to create a new template

 Click here to show or hide the request

API example removed: POST_adm_ents_X_dcrpos_X_vmtmps_CT_vmtmprq_j_AC_acrq_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Promote an instance to create a new template

 Click here to show or hide the request

API example removed: POST_adm_ents_X_dcrpos_X_vmtmps_CT_vmtmprq_j_AC_acrq_j_0015
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Duplicate an existing template to create a new template

 Click here to show or hide the request

API example removed: POST_adm_ents_X_dcrpos_X_vmtmps_CT_vmtmprq_j_AC_acrq_j_0013
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Export a template to create a new template

 Click here to show or hide the request

UPDATE_EXAMPLE

Install template in datacenter repository from template definition

Request a virtual machine template download into a datacenter repository.

Synopsis: POST http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates
Roles Required: ROLE_VAPP_CREATE_STATEFUL,ROLE_APPLIB_ALLOW_MODIFY
Request Headers: Accept: application/vnd.abiquo.acceptedrequest+json; version=3.8; application/vnd.abiquo.acceptedrequest+xml; version=3.8;  Content-type:  application/vnd.abiquo.templatedefinition+json; version=3.8; application/vnd.abiquo.templatedefinition+xml; version=3.8;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: TemplateDefinition Media Type
Response Message Body Entity: AcceptedRequest Media Type
Request Example:

 Click here to show or hide the request example

UPDATE EXAMPLE

Install template in datacenterrepository based on TemplateDefinition representation example
curl --verbose -u user:password -X POST example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates -H "content-type:application/vnd.abiquo.templatedefinition+xml;version=2.4" -H "accept:application/vnd.abiquo.acceptedrequest+xml;version=2.4" -d @dtos/templatedefinition.xml


> POST /api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates HTTP/1.1
> User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3
> Host: example.com
> accept:application/vnd.abiquo.acceptedrequest+xml;version=2.4
> content-type:application/vnd.abiquo.templatedefinition+xml;version=2.4
> Content-Length: 525


< HTTP/1.1 202 Aceptado
< Server: Apache-Coyote/1.1
< Set-Cookie: auth=YWRtaW46MTM2MzI1ODQ0MTgxMTpmZjIwZmY2NGE4Y2YwYjdhN2JlZWVmNGQ3YzFhNjI3YTpBQklRVU8; Expires=Thu, 14-Mar-2013 10:54:01 GMT; Path=/api
< Set-Cookie: JSESSIONID=5E1195809DDA3F7570F30B370B3079A1; Path=/api
< Content-Type: application/vnd.abiquo.acceptedrequest+xml;version=2.4
< Content-Length: 439
< Date: Thu, 14 Mar 2013 10:24:02 GMT


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<acceptedrequest>
    <link rel="status" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/2/tasks/f5cf66c4-ce19-436f-9f40-f3535f2f28f4"/>
    <message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">You can keep track of the progress in the link</message>
</acceptedrequest>

 

 

 

Retrieve a task for a virtual machine template

Displays a specific task on the virtual machine template. Tasks are a set of jobs (operations on hypervisors). Any of these tasks may still be in progress. Every task has a UUID.

Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}//tasks/{id}
Roles Required:
Request Headers: Accept: application/vnd.abiquo.task+json; version=3.8; application/vnd.abiquo.task+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: Task Media Type
Request Example:

 Click here to show or hide the request example
UPDATE EXAMPLE

 

Retrieve a task for a virtual machine template example
curl --verbose -u user:password http://example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26/tasks/eee40847-974b-4501-801d-c36c87b09f9d -X GET -H "accept:application/vnd.abiquo.task+xml;version=2.4"

> GET /api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26/tasks/eee40847-974b-4501-801d-c36c87b09f9d HTTP/1.1
> User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3
> Host: example.com
> accept:application/vnd.abiquo.task+xml;version=2.4

< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Set-Cookie: auth=YWRtaW46MTM1OTYyNzIyNzY5Mzo3NWRkZmY4ZDUyM2Q5YmFmNDJhNWJhZjI3NWNhMDE1ODpBQklRVU8; Expires=Thu, 31-Jan-2013 10:13:47 GMT; Path=/api
< Set-Cookie: JSESSIONID=E55F6C171504DFD98EEA70EC3C3AF7EB; Path=/api
< Content-Type: application/vnd.abiquo.task+xml;version=2.4
< Content-Length: 1196
< Date: Thu, 31 Jan 2013 09:43:47 GMT

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<task>
    <link rel="parent" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26/tasks"/>
    <link rel="result" type="application/vnd.abiquo.virtualmachinetemplate+xml" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26"/>
    <link rel="self" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26/tasks/eee40847-974b-4501-801d-c36c87b09f9d"/>
    <creationTimestamp>1359624796</creationTimestamp>
    <jobs>
        <job>
            <creationTimestamp>1359624796</creationTimestamp>
            <description>Make persistent task's dump disk to volume on virtual machine template with id 26</description>
            <id>740268ef-0df8-46f7-b92d-9aae33ac481c</id>
            <parentTaskId>eee40847-974b-4501-801d-c36c87b09f9d</parentTaskId>
            <rollbackState>UNKNOWN</rollbackState>
            <state>DONE</state>
            <timestamp>1359624815</timestamp>
            <type>DUMP_DISK_TO_VOLUME</type>
        </job>
    </jobs>
    <ownerId>26</ownerId>
    <state>FINISHED_SUCCESSFULLY</state>
    <taskId>eee40847-974b-4501-801d-c36c87b09f9d</taskId>
    <timestamp>1359624815</timestamp>
    <type>MAKE_PERSISTENT</type>
    <userId>admin</userId>
</task>


Retrieve a virtual machine template

Returns a virtual machine template.

Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}
Roles Required: ROLE_APPLIB_VIEW,ROLE_VDC_ENUMERATE,ROLE_VDC_MANAGE_VAPP,ROLE_VAPP_CUSTOMISE_SETTINGS,ROLE_VAPP_PERFORM_ACTIONS,ROLE_VAPP_DEPLOY_UNDEPLOY,ROLE_VAPP_ASSIGN_NETWORK,ROLE_VAPP_ASSIGN_VOLUME,ROLE_VAPP_CREATE_STATEFUL,ROLE_PHYS_DC_RETRIEVE_DETAILS,ROLE_MANAGE_HARD_DISKS
Request Headers: Accept: application/vnd.abiquo.virtualmachinetemplate+json; version=3.8; application/vnd.abiquo.virtualmachinetemplate+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: VirtualMachineTemplate Media Type
Request Example:

 Click here to show or hide the request example

API example removed: GET_adm_ents_X_dcrpos_X_vmtmps_X_AC_vmtmp_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Retrieve all tasks on a virtual machine template

Displays the tasks on the virtual machine template. Tasks are a set of jobs (operations). Any of these tasks may still be in progress.

Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}//tasks
Roles Required:
Request Headers: Accept: application/vnd.abiquo.tasks+json; version=3.8; application/vnd.abiquo.tasks+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: Tasks Media Type
Request Example:

 Click here to show or hide the request example

API example removed: GET_adm_ents_X_dcrpos_X_vmtmps_X_tsks_AC_tsks_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Update a vitual machine template

Modifies a virtual machine template.

There are the possibility to modify the recommended hardware profiles by adding the proper links. HardwareProfiles page should tell how to retrieve them.

Synopsis: PUT http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}
Roles Required: ROLE_APPLIB_ALLOW_MODIFY,ROLE_VDC_MANAGE_VAPP,ROLE_VAPP_CREATE_STATEFUL
Request Headers: Accept: application/vnd.abiquo.virtualmachinetemplate+json; version=3.8; application/vnd.abiquo.virtualmachinetemplate+xml; version=3.8;  Content-type:  application/vnd.abiquo.virtualmachinetemplate+json; version=3.8; application/vnd.abiquo.virtualmachinetemplate+xml; version=3.8;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: VirtualMachineTemplate Media Type
Response Message Body Entity: VirtualMachineTemplate Media Type
Request Example:

 Click here to show or hide the request example

API example removed: PUT_adm_ents_X_dcrpos_X_vmtmps_X_CT_vmtmp_j_AC_vmtmp_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Delete a virtual machine template

Deletes a virtual machine template.

Synopsis: DELETE http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}
Roles Required: ROLE_APPLIB_ALLOW_MODIFY,ROLE_VDC_MANAGE_VAPP,ROLE_VAPP_CREATE_STATEFUL
Request Headers: Accept: ; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity:
Request Example:

 Click here to show or hide the request example

API example removed: DELETE_adm_ents_X_dcrpos_X_vmtmps_X
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Make unavailable a virtual machine template

If the virtual machine template is in use (instances or virtual machines) it can't be deleted, but it can be marked as unavailable, this will remove the template disk file from the repository filesystem but keept the API reference as a virtual machine template with state = UNAVAILABLE

Synopsis: POST http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}/action/deletefile
Roles Required: ROLE_APPLIB_ALLOW_MODIFY,ROLE_VDC_MANAGE_VAPP,ROLE_VAPP_CREATE_STATEFUL
Request Headers: Accept: ; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity:
Request Example:

 Click here to show or hide the request example

API example removed: POST_adm_ents_X_dcrpos_X_vmtmps_X_act_delfile
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Retrieve a task with job info of progress and errorCause for a virtual machine template

Displays a specific task on the virtual machine template. Tasks are a set of jobs (operations on hypervisors). Any of these tasks may still be in progress. Every task has a UUID. Job includes downloading progress or error cause.

Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}//tasks/{id}
Roles Required:
Request Headers: Accept: application/vnd.abiquo.taskextended+json; version=3.8; application/vnd.abiquo.taskextended+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: TaskExtended Media Type
Request Example:

 Click here to show or hide the request example
UPDATE EXAMPLE

 

Retrieve a task including additional job info (progress, errorCause) for a virtual machine template example
curl --verbose -u user:password http://example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26/tasks/eee40847-974b-4501-801d-c36c87b09f9d -X GET -H "accept:application/vnd.abiquo.taskextended+xml;version=2.4"

> GET /api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26/tasks/eee40847-974b-4501-801d-c36c87b09f9d HTTP/1.1
> User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3
> Host: example.com
> accept:application/vnd.abiquo.taskextended+xml;version=2.4

< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Set-Cookie: auth=YWRtaW46MTM1OTYyNzI5NjA1NTo2YzE0MzE5MzU3MmU1YzViNjgxODY1ZDlmNmMxN2E5ZTpBQklRVU8; Expires=Thu, 31-Jan-2013 10:14:56 GMT; Path=/api
< Set-Cookie: JSESSIONID=CF17A6EF50AD63A1DA78F1C969373AC9; Path=/api
< Content-Type: application/vnd.abiquo.taskextended+xml;version=2.4
< Content-Length: 1146
< Date: Thu, 31 Jan 2013 09:44:56 GMT

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<taskextended>
    <link rel="parent" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26/tasks"/>
    <link rel="result" type="application/vnd.abiquo.virtualmachinetemplate+xml" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26"/>
    <link rel="self" href="http://example.com/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/26/tasks/eee40847-974b-4501-801d-c36c87b09f9d"/>
    <ownerId>26</ownerId>
    <state>FINISHED_SUCCESSFULLY</state>
    <taskId>eee40847-974b-4501-801d-c36c87b09f9d</taskId>
    <timestamp>1359624815</timestamp>
    <type>MAKE_PERSISTENT</type>
    <userId>admin</userId>
    <jobsExtended>
        <jobextended>
            <description>Make persistent task's dump disk to volume on virtual machine template with id 26</description>
            <id>740268ef-0df8-46f7-b92d-9aae33ac481c</id>
            <parentTaskId>eee40847-974b-4501-801d-c36c87b09f9d</parentTaskId>
            <rollbackState>UNKNOWN</rollbackState>
            <state>DONE</state>
            <timestamp>1359624815</timestamp>
            <type>DUMP_DISK_TO_VOLUME</type>
        </jobextended>
    </jobsExtended>
</taskextended>


 

 

Retrieve instance templates of the current template

Returns all the virtual machine templates instances of the current (master) virtual machine template

Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}/action/instances
Roles Required: ROLE_APPLIB_VIEW,ROLE_VDC_MANAGE_VAPP, ROLE_VAPP_CUSTOMISE_SETTINGS
Request Headers: Accept: application/vnd.abiquo.virtualmachinetemplates+json; version=3.8; application/vnd.abiquo.virtualmachinetemplates+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

allenterprises

false

false

a cloudadmin can see all the virtual machine templates in all enterprises (by default only see those in its current enterprise)

Request Message Body Entity:
Response Message Body Entity: VirtualMachineTemplates Media Type
Request Example:

 Click here to show or hide the request example

API example removed: GET_adm_ents_X_dcrpos_X_vmtmps_X_act_insts_AC_vmtmps_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Retrieve virtual machines using the current template

Returns all the virtual machines with relation to the current virtual machine template

Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/datacenterrepositories/{datacenterrepository}/virtualmachinetemplates/{virtualmachinetemplate}/action/virtualmachines
Roles Required: ROLE_APPLIB_VIEW,ROLE_VDC_MANAGE_VAPP, ROLE_VAPP_CUSTOMISE_SETTINGS
Request Headers: Accept: application/vnd.abiquo.virtualmachine+json; version=3.8; application/vnd.abiquo.virtualmachine+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

allenterprises

false

false

a cloudadmin can see all the virtual machine templates in all enterprises (by default only see those in its current enterprise)

hashypervisorfalse 

if provided filter returned vms having/not having a relation to some hypervisor

Request Message Body Entity:
Response Message Body Entity: VirtualMachineTemplates Media Type
Request Example:

 Click here to show or hide the request example

API example removed: GET_adm_ents_X_dcrpos_X_vmtmps_X_act_vms_AC_vms_j_hashv_F
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip