Class: OvirtSDK4::InstanceTypeService

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

#get(opts = {}) ⇒ InstanceType

Get a specific instance type and it’s attributes.

GET /ovirt-engine/api/instancetypes/123 HTTP/1.1

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:



13577
13578
13579
 
# File 'lib/ovirtsdk4/services.rb', line 13577

def get(opts = {})
  internal_get(GET, opts)
end

#graphics_consoles_service ⇒ InstanceTypeGraphicsConsolesService

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

Returns:



13673
13674
13675
 
# File 'lib/ovirtsdk4/services.rb', line 13673

def graphics_consoles_service
  @graphics_consoles_service ||= InstanceTypeGraphicsConsolesService.new(self, 'graphicsconsoles')
end

#nics_service ⇒ InstanceTypeNicsService

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

Returns:



13682
13683
13684
 
# File 'lib/ovirtsdk4/services.rb', line 13682

def nics_service
  @nics_service ||= InstanceTypeNicsService.new(self, 'nics')
end

#remove(opts = {}) ⇒ Object

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.

DELETE /ovirt-engine/api/instancetypes/123 HTTP/1.1

Parameters:

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :async (Boolean) —

    Indicates if the remove should be performed asynchronously.

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



13609
13610
13611
 
# File 'lib/ovirtsdk4/services.rb', line 13609

def remove(opts = {})
  internal_remove(REMOVE, 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.

Raises:



13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
 
# File 'lib/ovirtsdk4/services.rb', line 13702

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 = {}) ⇒ InstanceType

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.

PUT /ovirt-engine/api/instancetypes/123 HTTP/1.1

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:

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

Parameters:

  • instance_type (InstanceType) —

    The instance_type to update.

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :async (Boolean) —

    Indicates if the update should be performed asynchronously.

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



13663
13664
13665
 
# File 'lib/ovirtsdk4/services.rb', line 13663

def update(instance_type, opts = {})
  internal_update(instance_type, InstanceType, UPDATE, opts)
end

#watchdogs_service ⇒ InstanceTypeWatchdogsService

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

Returns:



13691
13692
13693
 
# File 'lib/ovirtsdk4/services.rb', line 13691

def watchdogs_service
  @watchdogs_service ||= InstanceTypeWatchdogsService.new(self, 'watchdogs')
end