xen 0.1.1

data/README

@@ -0,0 +1,16 @@
+= Xen -- Ruby interface to the Xen API.
+
+Xen strives to be the Ruby interface talking to the Xen API. It grew from our own need to talk to Xen Servers with Ruby.
+
+=== Usage:
+
+  # Connect to xenhost
+  xenhost = Xen::Host.new('xenhost.example.com')
+  
+  # Get status of each VM running
+  xenhost.vms.each do |vm|
+	puts vm.state unless vm.is_dom0?
+  end
+  
+  # Restart a certain VM
+  xenhost.find_vm('example_vm').clean_reboot!

data/lib/xen.rb

@@ -0,0 +1,4 @@
+require 'xen/connection.rb'
+require 'xen/host.rb'
+require 'xen/vm.rb'
+require 'xen/network.rb'

data/lib/xen/connection.rb

@@ -0,0 +1,38 @@
+require 'xmlrpc/client'
+
+module Xen
+
+  class Connection
+
+    # Initializes an xml-rpc connection to a Xen host, and logs in with the given credentials.
+    # === Example
+    # Xen::Connection.new ('xenhost.example.com', 2000, 'login', 'pass')
+    def initialize(host, port = 2000, login = 'user', pass = '')
+      @server = XMLRPC::Client.new(host,'/', port)
+      @session = @server.call("session.login_with_password", login, pass)
+    end
+
+    # Returns the session_id of the connection
+    def session_id
+      @session['Value']
+    end
+
+    # Make a direct call to the Xen API.
+    # === Example
+    # call('session.get_this_host', session_id) # => {"Status"=>"Success", "Value"=>"3a8f495d-939d-823b-fa08-fc407c73dc94"}
+    def call(function_name, *params)
+      call_without_session(function_name, session_id, *params)
+    end
+
+    def to_s
+      session_id.to_s
+    end
+
+    private
+    def call_without_session(function_name, *params)
+      @server.call(function_name, *params)
+    end
+
+  end
+
+end

data/lib/xen/host.rb

@@ -0,0 +1,65 @@
+module Xen
+
+  class Host
+
+    attr_reader :connection
+
+    # Creates a new Host object, and initiates an API connection to the given host on the given port, with a login and pass.
+    def initialize(host, port = 2000, login = 'user', pass = '')
+      @host = host
+      @connection = Connection.new(host, port, login, pass)
+    end
+
+    # Returns the uid of the host.
+    def uid # Lazy Loaded
+      @uid ||= get_value("session.get_this_host", @connection.session_id)
+    end
+
+    # Gives an array of active VM's on that Host.
+    def vms
+      get_value("host.get_resident_VMs", uid).collect do |vm_uid|
+        Vm.new(vm_uid, self) # Isn't this expensive?
+      end
+    end
+    
+    # Find a certain VM by a given domain-name.
+    def find_vm name
+      vms.detect { |vm| vm.name == name } # || raise Exception
+    end
+
+    # Gives the different bridges on your system
+    def networks
+      get_value("network.get_all").collect do |network_uid|
+        Network.new(network_uid, self)
+      end
+    end
+
+    # Gives the API version number in the form of major.minor vendor.
+    def version
+      major  = get_value("host.get_API_version_major", uid)
+      minor  = get_value("host.get_API_version_minor", uid)
+      vendor = get_value("host.get_API_version_vendor", uid)
+
+      "#{major}.#{minor} #{vendor}"
+    end
+
+    def record
+      get_value("host.get_record")
+    end
+
+    def to_s
+      uid.to_s
+    end
+    
+    # Call to the API
+    def call(function_name, *params)
+      @connection.call(function_name, *params)
+    end
+    
+    # Call to the API, Returns only the return value.
+    def get_value(function, *params)
+      call(function, *params)['Value']
+    end
+  end
+
+end

data/lib/xen/network.rb

@@ -0,0 +1,21 @@
+module Xen
+  class Network
+
+    def initialize(uid, host)
+      @uid = uid
+      @host = host
+    end
+    
+    def record
+      @host.call("network.get_record", @uid)['Value']
+    end
+    
+    def uuid
+      self.to_s
+    end
+    
+    def to_s
+      @uid.to_s
+    end
+  end
+end

data/lib/xen/vm.rb

@@ -0,0 +1,91 @@
+module Xen
+
+  class Vm
+
+    attr_reader :uid
+
+    # Creates a new VM, Given the VM's UID and the host it is running on.
+    def initialize(uid, host)
+      @uid, @host = uid, host
+      # self.get_state       # Too expensive!
+    end
+
+    # Gets the state of the VM. The first time it is called it query's the server, other times it is cached. There is an optional parameter 'refresh' which, when true, will re-query the server.
+    # === Example
+    #   # Having vm being a new initiated Vm
+    #   vm.state # => "Running"
+    #   vm.clean_shutdown! # => "Running"
+    #   # We wait a while
+    #   vm.state # => "Running" (cached)
+    #   vm.state(true) # => "Halted"
+    def state refresh = false
+      @state = refresh || !@state ? @host.get_value("VM.get_power_state",@uid) : @state
+    end
+
+    # Returns the VM's name
+    def name
+      @host.get_value("VM.get_name_label",@uid)
+    end
+
+    # Returns true if the current vm happens to be dom0.
+    def is_dom0?
+      name.to_s == "Domain-0" 
+    end
+    
+    # Returns the VM's uuid
+    def uuid
+      @host.get_value("VM.get_uuid",@uid)
+    end
+
+    # Starts a VM, and returns the current state
+    def start!(paused = false)
+      @host.call("VM.start",@uid, paused)    
+      state(true)
+    end
+
+    # Pauses the VM, and returns the current state
+    def pause!
+      @host.call("VM.pause",@uid)    
+      state(true)
+    end
+
+    # Unpauses the VM, and returns the current state
+    def unpause!
+      @host.call("VM.unpause",@uid)    
+      state(true)
+    end
+
+    # Shuts down the VM in a clean way, and returns the current state
+    def clean_shutdown!
+      @host.call("VM.clean_shutdown",@uid)    
+      state(true)
+    end
+
+    # Reboots the VM in a clean way, and returns the current state
+    def clean_reboot!
+      @host.call("VM.clean_reboot",@uid)    
+      state(true)
+    end
+
+    # Shuts down the VM immediatly, hard, and returns the current state
+    def hard_shutdown!
+      @host.call("VM.hard_shutdown",@uid)    
+      state(true)
+    end
+
+    # Hard reboots the VM, and returns the current state
+    def hard_reboot!
+      @host.call("VM.hard_reboot",@uid)    
+      state(true)
+    end
+
+    # Record..
+    def record
+        @host.get_value("VM.get_record", @uid)
+    end
+
+    def to_s
+      @uid.to_s
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: xen
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+date: 2007-08-29 00:00:00 +02:00
+summary: A package that is a link between Ruby and Xen API.
+require_paths: 
+- lib
+email: xen-ruby@openminds.be
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: xen
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- - Bernard Grymonpon
+  - Jan De Poorter
+files: 
+- lib/xen
+- lib/xen/connection.rb
+- lib/xen/host.rb
+- lib/xen/network.rb
+- lib/xen/vm.rb
+- lib/xen.rb
+- README
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+