Class: OvirtSDK4::StorageDomainVmsService

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

#list(opts = {}) ⇒ Array<Vm>

Returns the list of virtual machines of the export storage domain.

The order of the returned list of virtual machines isn’t guaranteed.

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.

  • :max (Integer)

    Sets the maximum number of virtual machines to return. If not specified all the virtual machines are returned.

  • :unregistered (Boolean)

    Indicates whether to retrieve a list of registered or unregistered virtual machines which contain disks on the storage domain. To get a list of unregistered virtual machines the call should indicate the unregistered flag. For example, to get a list of unregistered virtual machines the REST API call should look like this:

    GET /ovirt-engine/api/storagedomains/123/vms?unregistered=true

    The default value of the unregisterd flag is false. The request only apply to storage domains that are attached.

  • :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:

  • (Array<Vm>)

24005
24006
24007
# File 'lib/ovirtsdk4/services.rb', line 24005

def list(opts = {})
  internal_get(LIST, 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.


24027
24028
24029
24030
24031
24032
24033
24034
24035
24036
# File 'lib/ovirtsdk4/services.rb', line 24027

def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return vm_service(path)
  end
  return vm_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end

#vm_service(id) ⇒ StorageDomainVmService

Locates the vm service.

Parameters:

  • id (String)

    The identifier of the vm.

Returns:


24016
24017
24018
# File 'lib/ovirtsdk4/services.rb', line 24016

def vm_service(id)
  StorageDomainVmService.new(self, id)
end