Package org.ovirt.engine.sdk4.services

Interface SnapshotsService

All Superinterfaces:

Service

All Known Implementing Classes:

SnapshotsServiceImpl

public interface SnapshotsService
extends Service

Manages the set of snapshots of a storage domain or virtual machine.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SnapshotsService.AddRequest	Creates a virtual machine snapshot.
static interface	SnapshotsService.AddResponse	Creates a virtual machine snapshot.
static interface	SnapshotsService.ListRequest	Returns the list of snapshots of the storage domain or virtual machine.
static interface	SnapshotsService.ListResponse	Returns the list of snapshots of the storage domain or virtual machine.

Method Summary

Modifier and Type	Method	Description
SnapshotsService.AddRequest	add()	Creates a virtual machine snapshot.
SnapshotsService.ListRequest	list()	Returns the list of snapshots of the storage domain or virtual machine.
Service	service(String path)	Service locator method, returns individual service on which the URI is dispatched.
SnapshotService	snapshotService(String id)

Method Detail

add

SnapshotsService.AddRequest add()

Creates a virtual machine snapshot. For example, to create a new snapshot for virtual machine `123` send a request like this: [source] ---- POST /ovirt-engine/api/vms/123/snapshots ---- With a request body like this: [source,xml] ---- My snapshot ---- For including only a sub-set of disks in the snapshots, add `disk_attachments` element to the request body. Note that disks which are not specified in `disk_attachments` element will not be a part of the snapshot. If an empty `disk_attachments` element is passed, the snapshot will include only the virtual machine configuration. If no `disk_attachments` element is passed, then all the disks will be included in the snapshot. For each disk, `image_id` element can be specified for setting the new active image id. This is used in order to restore a chain of images from backup. I.e. when restoring a disk with snapshots, the relevant `image_id` should be specified for each snapshot (so the identifiers of the disk snapshots are identical to the backup). [source,xml] ---- My snapshot 456 ---- [IMPORTANT] ==== When a snapshot is created the default value for the <> attribute is `true`. That means that the content of the memory of the virtual machine will be included in the snapshot, and it also means that the virtual machine will be paused for a longer time. That can negatively affect applications that are very sensitive to timing (NTP servers, for example). In those cases make sure that you set the attribute to `false`: [source,xml] ---- My snapshot false ---- ====

list

SnapshotsService.ListRequest list()

Returns the list of snapshots of the storage domain or virtual machine. The order of the returned list of snapshots isn't guaranteed.

snapshotService

SnapshotService snapshotService(String id)

service

Service service(String path)

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