class OvirtSDK4::InstanceTypeService

Constants

GET
REMOVE
UPDATE

Public Instance Methods

get(opts = {}) click to toggle source

Get a specific instance type and it's attributes.

source

GET /ovirt-engine/api/instancetypes/123


@param opts [Hash] Additional options.

@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part

of the current request. See <<documents/003_common_concepts/follow, here>> for details.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [InstanceType]

# File lib/ovirtsdk4/services.rb, line 13756
def get(opts = {})
  internal_get(GET, opts)
end
graphics_consoles_service() click to toggle source

Reference to the service that manages the graphic consoles that are attached to this instance type.

@return [InstanceTypeGraphicsConsolesService] A reference to `graphics_consoles` service.

# File lib/ovirtsdk4/services.rb, line 13856
def graphics_consoles_service
  @graphics_consoles_service ||= InstanceTypeGraphicsConsolesService.new(self, 'graphicsconsoles')
end
nics_service() click to toggle source

Reference to the service that manages the NICs that are attached to this instance type.

@return [InstanceTypeNicsService] A reference to `nics` service.

# File lib/ovirtsdk4/services.rb, line 13865
def nics_service
  @nics_service ||= InstanceTypeNicsService.new(self, 'nics')
end
remove(opts = {}) click to toggle source

Removes a specific instance type from the system.

If a virtual machine was created using an instance type X after removal of the instance type the virtual machine's instance type will be set to `custom`.

source

DELETE /ovirt-engine/api/instancetypes/123


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously. @option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 13789
def remove(opts = {})
  internal_remove(REMOVE, opts)
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 13885
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'graphicsconsoles'
    return graphics_consoles_service
  end
  if path.start_with?('graphicsconsoles/')
    return graphics_consoles_service.service(path[17..-1])
  end
  if path == 'nics'
    return nics_service
  end
  if path.start_with?('nics/')
    return nics_service.service(path[5..-1])
  end
  if path == 'watchdogs'
    return watchdogs_service
  end
  if path.start_with?('watchdogs/')
    return watchdogs_service.service(path[10..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
update(instance_type, opts = {}) click to toggle source

Update a specific instance type and it's attributes.

All the attributes are editable after creation. If a virtual machine was created using an instance type X and some configuration in instance type X was updated, the virtual machine's configuration will be updated automatically by the engine.

source

PUT /ovirt-engine/api/instancetypes/123


For example, to update the memory of instance type `123` to 1 GiB and set the cpu topology to 2 sockets and 1 core, send a request like this:

source, xml

<instance_type>

<memory>1073741824</memory>
<cpu>
  <topology>
    <cores>1</cores>
    <sockets>2</sockets>
    <threads>1</threads>
  </topology>
</cpu>

</instance_type>


@param instance_type [InstanceType] The `instance_type` to update. @param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the update should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [InstanceType]

# File lib/ovirtsdk4/services.rb, line 13846
def update(instance_type, opts = {})
  internal_update(instance_type, InstanceType, UPDATE, opts)
end
watchdogs_service() click to toggle source

Reference to the service that manages the watchdogs that are attached to this instance type.

@return [InstanceTypeWatchdogsService] A reference to `watchdogs` service.

# File lib/ovirtsdk4/services.rb, line 13874
def watchdogs_service
  @watchdogs_service ||= InstanceTypeWatchdogsService.new(self, 'watchdogs')
end