Class: OvirtSDK4::AffinityLabelVmsService

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

Add a label to a vm.

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:



2187
2188
2189
 
# File 'lib/ovirtsdk4/services.rb', line 2187

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

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

List all virtual machines with the label.

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.

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


2218
2219
2220
 
# File 'lib/ovirtsdk4/services.rb', line 2218

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.



2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
 
# File 'lib/ovirtsdk4/services.rb', line 2241

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

A link to the specific label-vm assignment to allow label removal.

Parameters:

  • id (String) —

    The identifier of the vm.

Returns:



2230
2231
2232
 
# File 'lib/ovirtsdk4/services.rb', line 2230

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