Class: OvirtSDK4::VmHostDevicesService

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(device, opts = {}) ⇒ HostDevice

Attach target device to given virtual machine.

Example:

POST /ovirt-engine/api/vms/123/hostdevices

With request body of type HostDevice, for example

<host_device id="123" />
Note
 A necessary precondition for a successful host device attachment is that the virtual machine must be pinned to exactly one host. The device ID is then taken relative to this host.
Note
 Attachment of a PCI device that is part of a bigger IOMMU group will result in attachment of the remaining devices from that IOMMU group as "placeholders". These devices are then identified using the placeholder attribute of the HostDevice type set to true.

In case you want attach a device that already serves as an IOMMU placeholder, simply issue an explicit Add operation for it, and its placeholder flag will be cleared, and the device will be accessible to the virtual machine.

Parameters:

  • device (HostDevice) —

    The host device to be attached to given virtual machine.

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



30293
30294
30295
 
# File 'lib/ovirtsdk4/services.rb', line 30293

def add(device, opts = {})
  internal_add(device, HostDevice, ADD, opts)
end

#device_service(id) ⇒ VmHostDeviceService

Returns a reference to the service that manages a specific host device attached to given virtual machine.

Parameters:

  • id (String) —

    The identifier of the device.

Returns:



30338
30339
30340
 
# File 'lib/ovirtsdk4/services.rb', line 30338

def device_service(id)
  VmHostDeviceService.new(self, id)
end

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

List the host devices assigned to given virtual machine.

The order of the returned list of devices 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 devices to return. If not specified all the devices 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:



30327
30328
30329
 
# File 'lib/ovirtsdk4/services.rb', line 30327

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.



30349
30350
30351
30352
30353
30354
30355
30356
30357
30358
 
# File 'lib/ovirtsdk4/services.rb', line 30349

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