Class: Libvirt::Domain

Inherits:

Object

• Object
• Libvirt::Domain

Defined in:

lib/libvirt/domain.rb

Class Method Summary

• .load_ref(dom_ptr) ⇒ Object

Instance Method Summary

• #auto_start ⇒ Boolean
• #free_domain ⇒ Object
• #get_metadata(type: :ELEMENT, uri: nil, flags: :AFFECT_CURRENT) ⇒ String

  Retrieves metadata.

• #get_state ⇒ Object
• #initialize(dom_ptr) ⇒ Domain constructor

  A new instance of Domain.

• #max_memory ⇒ Object
• #max_vcpus ⇒ Object
• #name ⇒ Object
• #persistent? ⇒ Boolean
• #power_off(flags = 0) ⇒ Object
• #reboot(flags = 0) ⇒ Object
• #reset(flags = 0) ⇒ Object
• #resume ⇒ Object
• #save_memory(flags = :PAUSED) ⇒ Object

  After save_memory(:PAUSED) you need to call #start and #resume to move domain to the running state.

• #screenshot(stream, display = 0) ⇒ Object
• #set_auto_start(value) ⇒ Object
• #set_metadata(metadata, type: :ELEMENT, key: nil, uri: nil, flags: :AFFECT_CURRENT) ⇒ Object

  Sets metadata.

• #shutdown(flags = :ACPI_POWER_BTN) ⇒ Object
• #start(flags = 0) ⇒ Object
• #suspend ⇒ Object
• #to_ptr ⇒ Object
• #undefine(options_or_flags = nil) ⇒ Object

  Undefine a domain.

• #uuid ⇒ Object
• #vcpus ⇒ Object

  def vcpus # https://github.com/libvirt/ruby-libvirt/blob/9f71ff5add1f57ffef7cf513b72638d92d9fd84f/ext/libvirt/domain.c#L787 # dominfo = virDomainGetInfo # dominfo.nrVirtCpu # maxcpus = ruby_libvirt_get_maxcpus(ruby_libvirt_connect_get(d)); # vcpu_infos_ptr FFI::Domain.virDomainGetVcpus(@dom_ptr, vcpu_infos_ptr, maxinfo, cpumaps, maplen) end.

• #xml_desc(flags = 0) ⇒ Object

Constructor Details

#initialize(dom_ptr) ⇒ Domain

Returns a new instance of Domain.

# File 'lib/libvirt/domain.rb', line 12

def initialize(dom_ptr)
  @dom_ptr = dom_ptr

  free = ->(obj_id) do
    Util.log(:debug) { "Finalize Libvirt::Domain 0x#{obj_id.to_s(16)} @dom_ptr=#{@dom_ptr}," }
    return unless @dom_ptr

    fr_result = FFI::Domain.virDomainFree(@dom_ptr)
    warn "Couldn't free Libvirt::Domain (0x#{obj_id.to_s(16)}) pointer #{@dom_ptr.address}" if fr_result.negative?
  end
  ObjectSpace.define_finalizer(self, free)
end

Class Method Details

.load_ref(dom_ptr) ⇒ Object

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 5

def self.load_ref(dom_ptr)
  ref_result = FFI::Domain.virDomainRef(dom_ptr)
  raise Errors::LibError, "Couldn't retrieve domain reference" if ref_result.negative?

  new(dom_ptr)
end

Instance Method Details

#auto_start ⇒ Boolean

Returns:

• (Boolean)

Raises:

• (Libvirt::Errors::LibError)

# File 'lib/libvirt/domain.rb', line 61

def auto_start
  value = ::FFI::MemoryPointer.new(:int)
  result = FFI::Domain.virDomainGetAutostart(@dom_ptr, value)
  raise Errors::LibError, "Couldn't get domain auto_start" if result.negative?

  value.read_int == 1
end

#free_domain ⇒ Object

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 107

def free_domain
  result = FFI::Domain.virDomainFree(@dom_ptr)
  raise Errors::LibError, "Couldn't free domain" if result.negative?

  @dom_ptr = nil
end

#get_metadata(type: :ELEMENT, uri: nil, flags: :AFFECT_CURRENT) ⇒ String

Retrieves metadata

Parameters:

• type (Integer, Symbol) (defaults to: :ELEMENT) —

  one of :ELEMENT, :TITLE, :DESCRIPTION

• uri (String) (defaults to: nil) —

  xml namespace (required for type element)

• flags (Integer, Symbol) (defaults to: :AFFECT_CURRENT) —

  one off AFFECT_CURRENT, AFFECT_CONFIG, AFFECT_LIVE AFFECT_CURRENT 0x0 - Affect current domain state. AFFECT_LIVE 0x1 - Affect running domain state. AFFECT_CONFIG 0x2 - Affect persistent domain state.

Returns:

• (String) —

  xml node, title, or description.

Raises:

• (Libvirt::Errors::LibError) —

  if operation failed

# File 'lib/libvirt/domain.rb', line 196

def get_metadata(type: :ELEMENT, uri: nil, flags: :AFFECT_CURRENT)
  result = FFI::Domain.virDomainGetMetadata(@dom_ptr, type, uri, flags)
  raise Errors::LibError, "Couldn't get domain metadata" if result.nil?

  result
end

#get_state ⇒ Object

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 25

def get_state
  state = ::FFI::MemoryPointer.new(:int)
  reason = ::FFI::MemoryPointer.new(:int)
  result = FFI::Domain.virDomainGetState(@dom_ptr, state, reason, 0)
  raise Errors::LibError, "Couldn't get domain state" if result.negative?

  state_sym = FFI::Domain.enum_type(:state)[state.read_int]
  reason_sym = FFI::Domain.state_reason(state_sym, reason.read_int)
  [state_sym, reason_sym]
end

#max_memory ⇒ Object

# File 'lib/libvirt/domain.rb', line 89

def max_memory
  FFI::Domain.virDomainGetMaxMemory(@dom_ptr)
end

#max_vcpus ⇒ Object

# File 'lib/libvirt/domain.rb', line 55

def max_vcpus
  FFI::Domain.virDomainGetMaxVcpus(@dom_ptr)
end

#name ⇒ Object

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 48

def name
  result = FFI::Domain.virDomainGetName(@dom_ptr)
  raise Errors::LibError, "Couldn't retrieve storage pool name" if result.nil?

  result
end

#persistent? ⇒ Boolean

Returns:

• (Boolean)

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 203

def persistent?
  result = FFI::Domain.virDomainIsPersistent(@dom_ptr)
  raise Errors::LibError, "Couldn't set domain metadata" if result.negative?

  result == 1
end

#power_off(flags = 0) ⇒ Object

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 129

def power_off(flags = 0)
  result = FFI::Domain.virDomainDestroyFlags(@dom_ptr, flags)
  raise Errors::LibError, "Couldn't power off domain" if result.negative?
end

#reboot(flags = 0) ⇒ Object

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 119

def reboot(flags = 0)
  result = FFI::Domain.virDomainReboot(@dom_ptr, flags)
  raise Errors::LibError, "Couldn't reboot domain" if result.negative?
end

#reset(flags = 0) ⇒ Object

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 134

def reset(flags = 0)
  result = FFI::Domain.virDomainReset(@dom_ptr, flags)
  raise Errors::LibError, "Couldn't reset domain" if result.negative?
end

#resume ⇒ Object

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 144

def resume
  result = FFI::Domain.virDomainResume(@dom_ptr)
  raise Errors::LibError, "Couldn't resume domain" if result.negative?
end

#save_memory(flags = :PAUSED) ⇒ Object

After save_memory(:PAUSED) you need to call #start and #resume to move domain to the running state.

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 164

def save_memory(flags = :PAUSED)
  result = FFI::Domain.virDomainManagedSave(@dom_ptr, flags)
  raise Errors::LibError, "Couldn't save domain memory" if result.negative?
end

#screenshot(stream, display = 0) ⇒ Object

Raises:

• (Errors::LibError)

# File 'lib/libvirt/domain.rb', line 97

def screenshot(stream, display = 0)
  dbg { "#screenshot stream=#{stream}, display=#{display}," }

  mime_type, pointer = FFI::Domain.virDomainScreenshot(@dom_ptr, stream.to_ptr, display, 0)
  raise Errors::LibError, "Couldn't attach domain screenshot" if pointer.null?

  # free pointer required
  mime_type
end

#set_auto_start(value) ⇒ Object

Parameters:

• value (Boolean)

Raises:

• (Libvirt::Errors::LibError)

# File 'lib/libvirt/domain.rb', line 71

def set_auto_start(value)
  value = value ? 1 : 0
  result = FFI::Domain.virDomainSetAutostart(@dom_ptr, value)
  raise Errors::LibError, "Couldn't set domain auto_start" if result.negative?
end

#set_metadata(metadata, type: :ELEMENT, key: nil, uri: nil, flags: :AFFECT_CURRENT) ⇒ Object

Sets metadata

Parameters:

• metadata (String) —

  xml node for element type, text for other types DESCRIPTION 0x0 - Operate on TITLE 0x1 - Operate on