Class: OvirtSDK4::AffinityGroupVmsService

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

#add(vm, opts = {}) ⇒ Vm

Adds a virtual machine to the affinity group.

For example, to add the virtual machine 789 to the affinity group 456 of cluster 123, send a request like this:

POST /ovirt-engine/api/clusters/123/affinitygroups/456/vms

With the following body:

<vm id="789"/>

Parameters:

  • vm (Vm) —

    The vm to add.

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

Returns:



1615
1616
1617
 
# File 'lib/ovirtsdk4/services.rb', line 1615

def add(vm, opts = {})
  internal_add(vm, Vm, ADD, opts)
end

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

List all virtual machines assigned to this affinity group.

The order of the returned 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.

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


1650
1651
1652
 
# File 'lib/ovirtsdk4/services.rb', line 1650

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.



1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
 
# File 'lib/ovirtsdk4/services.rb', line 1672

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) ⇒ AffinityGroupVmService

Access the service that manages the virtual machine assignment to this affinity group.

Parameters:

  • id (String) —

    The identifier of the vm.

Returns:



1661
1662
1663
 
# File 'lib/ovirtsdk4/services.rb', line 1661

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