class OvirtSDK4::InstanceTypesService

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 13396
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

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

Creates a new instance type.

This requires only a name attribute and can include all hardware configurations of the virtual machine.

source

POST /ovirt-engine/api/instancetypes


With a request body like this:

source,xml

<instance_type>

<name>myinstancetype</name>

</template>


Creating an instance type with all hardware configurations with a request body like this:

source,xml

<instance_type>

<name>myinstancetype</name>
<console>
  <enabled>true</enabled>
</console>
<cpu>
  <topology>
    <cores>2</cores>
    <sockets>2</sockets>
    <threads>1</threads>
  </topology>
</cpu>
<custom_cpu_model>AMD Opteron_G2</custom_cpu_model>
<custom_emulated_machine>q35</custom_emulated_machine>
<display>
  <monitors>1</monitors>
  <single_qxl_pci>true</single_qxl_pci>
  <smartcard_enabled>true</smartcard_enabled>
  <type>spice</type>
</display>
<high_availability>
  <enabled>true</enabled>
  <priority>1</priority>
</high_availability>
<io>
  <threads>2</threads>
</io>
<memory>4294967296</memory>
<memory_policy>
  <ballooning>true</ballooning>
  <guaranteed>268435456</guaranteed>
</memory_policy>
<migration>
  <auto_converge>inherit</auto_converge>
  <compressed>inherit</compressed>
  <policy id="00000000-0000-0000-0000-000000000000"/>
</migration>
<migration_downtime>2</migration_downtime>
<os>
  <boot>
    <devices>
      <device>hd</device>
    </devices>
  </boot>
</os>
<rng_device>
  <rate>
    <bytes>200</bytes>
    <period>2</period>
  </rate>
  <source>urandom</source>
</rng_device>
<soundcard_enabled>true</soundcard_enabled>
<usb>
  <enabled>true</enabled>
  <type>native</type>
</usb>
<virtio_scsi>
  <enabled>true</enabled>
</virtio_scsi>

</instance_type>


@param instance_type [InstanceType] The `instance_type` to add.

@param opts [Hash] Additional options.

@return [InstanceType]

# File lib/ovirtsdk4/services.rb, line 13494
def add(instance_type, opts = {})
  if instance_type.is_a?(Hash)
    instance_type = OvirtSDK4::InstanceType.new(instance_type)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    InstanceTypeWriter.write_one(instance_type, 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 InstanceTypeReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
instance_type_service(id) click to toggle source

Locates the `instance_type` service.

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

@return [InstanceTypeService] A reference to the `instance_type` service.

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

Lists all existing instance types in the system.

@param opts [Hash] Additional options.

@option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed

taking case into account. The default value is `true`, which means that case is taken
into account. If you want to search ignoring case set it to `false`.

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

types are returned.

@option opts [String] :search A query string used to restrict the returned templates.

@return [Array<InstanceType>]

# File lib/ovirtsdk4/services.rb, line 13537
def list(opts = {})
  query = {}
  value = opts[:case_sensitive]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['case_sensitive'] = value
  end
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  value = opts[:search]
  unless value.nil?
    query['search'] = 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 InstanceTypeReader.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 13586
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return instance_type_service(path)
  end
  return instance_type_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 13602
def to_s
  "#<#{InstanceTypesService}:#{@path}>"
end