class OvirtSDK4::SnapshotService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 20543
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

cdroms_service() click to toggle source

Locates the `cdroms` service.

@return [SnapshotCdromsService] A reference to `cdroms` service.

# File lib/ovirtsdk4/services.rb, line 20643
def cdroms_service
  SnapshotCdromsService.new(@connection, "#{@path}/cdroms")
end
disks_service() click to toggle source

Locates the `disks` service.

@return [SnapshotDisksService] A reference to `disks` service.

# File lib/ovirtsdk4/services.rb, line 20652
def disks_service
  SnapshotDisksService.new(@connection, "#{@path}/disks")
end
get(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@param opts [Hash] Additional options.

@return [Snapshot]

# File lib/ovirtsdk4/services.rb, line 20555
def get(opts = {})
  query = {}
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return SnapshotReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
nics_service() click to toggle source

Locates the `nics` service.

@return [SnapshotNicsService] A reference to `nics` service.

# File lib/ovirtsdk4/services.rb, line 20661
def nics_service
  SnapshotNicsService.new(@connection, "#{@path}/nics")
end
remove(opts = {}) click to toggle source

Deletes the object managed by this service.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously.

# File lib/ovirtsdk4/services.rb, line 20578
def remove(opts = {})
  query = {}
  value = opts[:async]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['async'] = value
  end
  request = HttpRequest.new(method: :DELETE, url: @path, query: query)
  response = @connection.send(request)
  unless response.code == 200
    check_fault(response)
  end
end
restore(opts = {}) click to toggle source

Restores a virtual machine snapshot.

For example, to restore the snapshot with identifier `456` of virtual machine with identifier `123` send a request like this:

source

POST /ovirt-engine/api/vms/123/snapshots/456/restore


With an empty `action` in the body:

source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the restore should be performed asynchronously.

@option opts [Array<Disk>] :disks

@option opts [Boolean] :restore_memory

# File lib/ovirtsdk4/services.rb, line 20618
def restore(opts = {})
  action = Action.new(opts)
  writer = XmlWriter.new(nil, true)
  ActionWriter.write_one(action, writer)
  body = writer.string
  writer.close
  request = HttpRequest.new(
    method: :POST,
    url: "#{@path}/restore",
    body: body
  )
  response = @connection.send(request)
  case response.code
  when 200
    action = check_action(response)
  else
    check_action(response)
  end
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 20672
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'cdroms'
    return cdroms_service
  end
  if path.start_with?('cdroms/')
    return cdroms_service.service(path[7..-1])
  end
  if path == 'disks'
    return disks_service
  end
  if path.start_with?('disks/')
    return disks_service.service(path[6..-1])
  end
  if path == 'nics'
    return nics_service
  end
  if path.start_with?('nics/')
    return nics_service.service(path[5..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 20702
def to_s
  "#<#{SnapshotService}:#{@path}>"
end