Package org.ovirt.engine.sdk4.internal.services

Class TemplatesServiceImpl

java.lang.Object

org.ovirt.engine.sdk4.internal.services.ServiceImpl

org.ovirt.engine.sdk4.internal.services.TemplatesServiceImpl

All Implemented Interfaces:

Service, TemplatesService

public class TemplatesServiceImpl
extends ServiceImpl
implements TemplatesService

Nested Class Summary

Nested classes/interfaces inherited from interface org.ovirt.engine.sdk4.services.TemplatesService

TemplatesService.AddFromConfigurationRequest, TemplatesService.AddFromConfigurationResponse, TemplatesService.AddFromVmRequest, TemplatesService.AddFromVmResponse, TemplatesService.AddFromVmSnapshotRequest, TemplatesService.AddFromVmSnapshotResponse, TemplatesService.AddRequest, TemplatesService.AddResponse, TemplatesService.ListRequest, TemplatesService.ListResponse

Constructor Summary

Constructors

Constructor	Description
TemplatesServiceImpl(HttpConnection connection, String path)

Method Summary

Modifier and Type	Method	Description
TemplatesService.AddRequest	add()	Creates a new template.
TemplatesService.AddFromConfigurationRequest	addFromConfiguration()	Add a virtual machine template to the system from a configuration.
TemplatesService.AddFromVmRequest	addFromVm()	Add a virtual machine template to the system from an existing virtual machine.
TemplatesService.AddFromVmSnapshotRequest	addFromVmSnapshot()	Add a virtual machine template to the system from a snapshot.
TemplatesService.ListRequest	list()	Returns the list of virtual machine templates.
Service	service(String path)	Service locator method, returns individual service on which the URI is dispatched.
TemplateService	templateService(String id)	Returns a reference to the service that manages a specific virtual machine template.
String	toString()

Methods inherited from class org.ovirt.engine.sdk4.internal.services.ServiceImpl

checkAction, checkFault, getConnection, getPath, throwError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TemplatesServiceImpl

public TemplatesServiceImpl(HttpConnection connection,
                            String path)

Method Detail

add

public TemplatesService.AddRequest add()

Description copied from interface: TemplatesService

Creates a new template. This requires the `name` and `vm` elements. To identify the virtual machine use the `vm.id` or `vm.name` attributes. For example, to create a template from a virtual machine with the identifier `123` send a request like this: [source] ---- POST /ovirt-engine/api/templates ---- With a request body like this: [source,xml] ---- ---- Since version 4.3, in order to create virtual machine template from a snapshot send a request body like this: [source,xml] ---- ---- The disks of the template can be customized, making some of their characteristics different from the disks of the original virtual machine. To do so use the `vm.disk_attachments` attribute, specifying the identifier of the disk of the original virtual machine and the characteristics that you want to change. For example, if the original virtual machine has a disk with the identifier `456`, and, for that disk, you want to change the name to `mydisk` the format to <> and make it <>, send a request body like this: [source,xml] ---- ---- The template can be created as a sub-version of an existing template. This requires the `name` and `vm` attributes for the new template, and the `base_template` and `version_name` attributes for the new template version. The `base_template` and `version_name` attributes must be specified within a `version` section enclosed in the `template` section. Identify the virtual machine with the `id` or `name` attributes. [source,xml] ---- ---- The destination storage domain of the template can be customized, in one of two ways: 1. Globally, at the request level. The request must list the desired disk attachments to be created on the storage domain. If the disk attachments are not listed, the global storage domain parameter will be ignored. + [source,xml] ---- ---- 2. Per each disk attachment. Specify the desired storage domain for each disk attachment. Specifying the global storage definition will override the storage domain per disk attachment specification. + [source,xml] ---- ----

Specified by:

add in interface TemplatesService

addFromConfiguration

public TemplatesService.AddFromConfigurationRequest addFromConfiguration()

Description copied from interface: TemplatesService

Add a virtual machine template to the system from a configuration. Requires the configuration type, the configuration data, and the target cluster.

Specified by:

addFromConfiguration in interface TemplatesService

addFromVm

public TemplatesService.AddFromVmRequest addFromVm()

Description copied from interface: TemplatesService

Add a virtual machine template to the system from an existing virtual machine.

Specified by:

addFromVm in interface TemplatesService

addFromVmSnapshot

public TemplatesService.AddFromVmSnapshotRequest addFromVmSnapshot()

Description copied from interface: TemplatesService

Add a virtual machine template to the system from a snapshot.

Specified by:

addFromVmSnapshot in interface TemplatesService

list

public TemplatesService.ListRequest list()

Description copied from interface: TemplatesService

Returns the list of virtual machine templates. For example: [source] ---- GET /ovirt-engine/api/templates ---- Will return the list of virtual machines and virtual machine templates. The order of the returned list of templates is not guaranteed.

Specified by:

list in interface TemplatesService

templateService

public TemplateService templateService(String id)

Description copied from interface: TemplatesService

Returns a reference to the service that manages a specific virtual machine template.

Specified by:

templateService in interface TemplatesService

service

public Service service(String path)

Description copied from interface: TemplatesService

Service locator method, returns individual service on which the URI is dispatched.

Specified by:

service in interface TemplatesService

toString

public String toString()

Overrides:

toString in class Object