class OvirtSDK4::SnapshotsService

Constants

ADD
LIST

Public Instance Methods

add(snapshot, opts = {}) click to toggle source

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

<snapshot>

<description>My snapshot</description>

</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

<snapshot>

<description>My snapshot</description>
<disk_attachments>
  <disk_attachment>
    <disk id="123">
      <image_id>456</image_id>
    </disk>
  </disk_attachment>
</disk_attachments>

</snapshot>


IMPORTANT

When a snapshot is created, the default value for the xref:types-snapshot-attributes-persist_memorystate 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

<snapshot>

<description>My snapshot</description>
<persist_memorystate>false</persist_memorystate>

</snapshot>


@param snapshot [Snapshot] The `snapshot` to add.

@param opts [Hash] Additional options.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [Snapshot]

# File lib/ovirtsdk4/services.rb, line 21428
def add(snapshot, opts = {})
  internal_add(snapshot, Snapshot, ADD, opts)
end
list(opts = {}) click to toggle source

Returns the list of snapshots of the storage domain or virtual machine.

The order of the returned list of snapshots isn't guaranteed.

@param opts [Hash] Additional options.

@option opts [Boolean] :all_content Indicates if all the attributes of the virtual machine snapshot should be included in the response.

By default the attribute `initialization.configuration.data` is excluded.

For example, to retrieve the complete representation of the virtual machine with id `123` snapshots send a
request like this:

....
GET /ovirt-engine/api/vms/123/snapshots?all_content=true
....

@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part

of the current request. See <<documents/003_common_concepts/follow, here>> for details.

@option opts [Integer] :max Sets the maximum number of snapshots to return. If not specified all the snapshots are returned.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [Array<Snapshot>]

# File lib/ovirtsdk4/services.rb, line 21474
def list(opts = {})
  internal_get(LIST, opts)
end
service(path) click to toggle source

Locates the service corresponding to the given path.

@param path [String] The path of the service.

@return [Service] A reference to the service.

# File lib/ovirtsdk4/services.rb, line 21496
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return snapshot_service(path)
  end
  return snapshot_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end
snapshot_service(id) click to toggle source

Locates the `snapshot` service.

@param id [String] The identifier of the `snapshot`.

@return [SnapshotService] A reference to the `snapshot` service.

# File lib/ovirtsdk4/services.rb, line 21485
def snapshot_service(id)
  SnapshotService.new(self, id)
end