Class: OvirtSDK4::VmBackupService

Inherits:
Service
  • Object
show all
Defined in:
lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary collapse

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#disks_serviceVmBackupDisksService

A reference to the service that lists the disks in backup.

Returns:



32013
32014
32015
# File 'lib/ovirtsdk4/services.rb', line 32013

def disks_service
  @disks_service ||= VmBackupDisksService.new(self, 'disks')
end

#finalize(opts = {}) ⇒ Object

Finalize the virtual machine backup entity.

End backup, unlock resources, and perform cleanups. To finalize a virtual machine with an id '123' and a backup with an id '456' send a request as follows:

POST /ovirt-engine/api/vms/123/backups/456/finalize

With a request body as follows:

<action />

Parameters:

  • opts (Hash) (defaults to: {})

    Additional options.

Options Hash (opts):

  • :headers (Hash) — default: {}

    Additional HTTP headers.

  • :query (Hash) — default: {}

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true

    If true wait for the response.



31975
31976
31977
# File 'lib/ovirtsdk4/services.rb', line 31975

def finalize(opts = {})
  internal_action(:finalize, nil, FINALIZE, opts)
end

#get(opts = {}) ⇒ Backup

Returns information about the virtual machine backup.

Parameters:

  • opts (Hash) (defaults to: {})

    Additional options.

Options Hash (opts):

  • :follow (String)

    Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.

  • :headers (Hash) — default: {}

    Additional HTTP headers.

  • :query (Hash) — default: {}

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true

    If true wait for the response.

Returns:



32004
32005
32006
# File 'lib/ovirtsdk4/services.rb', line 32004

def get(opts = {})
  internal_get(GET, opts)
end

#service(path) ⇒ Service

Locates the service corresponding to the given path.

Parameters:

  • path (String)

    The path of the service.

Returns:

  • (Service)

    A reference to the service.

Raises:



32024
32025
32026
32027
32028
32029
32030
32031
32032
32033
32034
32035
# File 'lib/ovirtsdk4/services.rb', line 32024

def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'disks'
    return disks_service
  end
  if path.start_with?('disks/')
    return disks_service.service(path[6..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end