class OvirtSDK4::VmHostDevicesService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 31324
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

add(device, opts = {}) click to toggle source

Attach target device to given virtual machine.

Example:

source

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


With request body of type <<types/host_device,HostDevice>>, for example

source,xml

<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 <<types/host_device,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.

@param device [HostDevice] The host device to be attached to given virtual machine.

@param opts [Hash] Additional options.

@return [HostDevice]

# File lib/ovirtsdk4/services.rb, line 31362
def add(device, opts = {})
  if device.is_a?(Hash)
    device = OvirtSDK4::HostDevice.new(device)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    HostDeviceWriter.write_one(device, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200, 201, 202
    begin
      reader = XmlReader.new(response.body)
      return HostDeviceReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
device_service(id) click to toggle source

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

@param id [String] The identifier of the `device`.

@return [VmHostDeviceService] A reference to the `device` service.

# File lib/ovirtsdk4/services.rb, line 31427
def device_service(id)
  VmHostDeviceService.new(@connection, "#{@path}/#{id}")
end
list(opts = {}) click to toggle source

List the host devices assigned to given virtual machine.

@param opts [Hash] Additional options.

@option opts [Integer] :max Sets the maximum number of devices to return. If not specified all the devices are returned.

@return [Array<HostDevice>]

# File lib/ovirtsdk4/services.rb, line 31398
def list(opts = {})
  query = {}
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return HostDeviceReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
service(path) click to toggle source

Locates the service corresponding to the given path.

@param path [String] The path of the service.

@return [Service] A reference to the service.

# File lib/ovirtsdk4/services.rb, line 31438
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
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 31454
def to_s
  "#<#{VmHostDevicesService}:#{@path}>"
end