rubyipmi 0.3.0

data/lib/rubyipmi/freeipmi/commands/chassisconfig.rb

@@ -0,0 +1,100 @@
+module Rubyipmi::Freeipmi
+
+  class ChassisConfig < Rubyipmi::Freeipmi::BaseCommand
+
+    def initialize(opts = ObservableHash.new)
+      super("ipmi-chassis-config", opts)
+
+    end
+
+    # This is the raw command to send a new configuration to the ipmi device
+    def commit
+      @options["commit"] = false
+      value = runcmd
+      @options.delete_notify("commit")
+      return value
+    end
+
+    # This is the raw command to get the entire ipmi chassis configuration
+    # If you pass in a section you will get just the section
+    def checkout(section=nil)
+      @options["checkout"] = false
+      if section
+        @options["section"] = section
+      end
+      value = runcmd
+      @options.delete_notify("checkout")
+      if section
+        @options.delete_notify("section")
+      end
+      return value
+    end
+
+    def bootdevice
+      value = checkout("Chassis_Boot_Flags")
+      if value
+        # TODO parse result to return current boot device
+        #@result
+      end
+    end
+
+    def bootdevice(device, persistent=false)
+      setBootFlag("Boot_Device", device)
+    end
+
+    def bootdevices
+      # freeipmi returns a list of supported devices
+      # However, for now we will just assume the following
+      ["PXE", "HARD-DRIVE", "CD-DVD", "BIOS-SETUP"]
+      # TODO return array of possible boot devices
+    end
+
+    def bootpersistent(value)
+      # TODO find out if we can specify multiple key-pair values
+      if value == true
+        flag = "Chassis_Boot_Flags:Boot_Flags_Persistent=Yes"
+      else
+        flag = "Chassis_Boot_Flags:Boot_Flags_Persistent=No"
+      end
+      @options["key-pair"] = "\"#{flag}\""
+      value = commit
+      @options.delete_notify("key-pair")
+      return value
+    end
+
+
+
+    # shortcut to set boot device to pxe
+    def bootpxe(persistent=false)
+      bootdevice("PXE")
+    end
+
+    # shortcut to set boot device to disk
+    def bootdisk(persistent=false)
+      bootdevice("HARD-DRIVE")
+    end
+
+    # shortcut to set boot device to cdrom
+    def bootcdrom(persistent=false)
+      bootdevice("CD-DVD")
+    end
+
+    # shortcut to boot into bios setup
+    def bootbios(persistent=false)
+      bootdevice("BIOS-SETUP")
+    end
+
+    private
+
+    def setBootFlag(key,flag, persistent=false)
+      @options["key-pair"] = "\"Chassis_Boot_Flags:#{key}=#{flag}\""
+      value = commit
+      @options.delete_notify("key-pair")
+      return value
+    end
+  end
+
+   ## Possible values: NO-OVERRIDE/PXE/HARD-DRIVE/HARD-DRIVE-SAFE-MODE/
+   ##                  DIAGNOSTIC_PARTITION/CD-DVD/BIOS-SETUP/REMOTE-FLOPPY
+   ##                  PRIMARY-REMOTE-MEDIA/REMOTE-CD-DVD/REMOTE-HARD-DRIVE/FLOPPY
+end

data/lib/rubyipmi/freeipmi/commands/lan.rb

@@ -0,0 +1,111 @@
+module Rubyipmi::Freeipmi
+
+  class Lan
+
+    attr_accessor :info
+    attr_accessor :channel
+    attr_accessor :config
+
+    def initialize(opts)
+      @config = Rubyipmi::Freeipmi::BmcConfig.new(opts)
+
+      @info = {}
+      @channel = 2
+    end
+
+    def info
+      if @info.length < 1
+        parse(@config.section("Lan_Conf"))
+      else
+        @info
+      end
+    end
+
+    def dhcp?
+      if @info.length < 1
+        parse(@config.section("Lan_Conf"))
+      end
+      @info["ip_address_source"].match(/dhcp/i) != nil
+    end
+
+    def static?
+      if @info.length < 1
+        parse(@config.section("Lan_Conf"))
+      end
+      @info["ip_address_source"].match(/static/i) != nil
+    end
+
+    def ip
+      if @info.length < 1
+        parse(@config.section("Lan_Conf"))
+      end
+      @info["ip_address"]
+    end
+
+    def mac
+      if @info.length < 1
+        parse(@config.section("Lan_Conf"))
+      end
+      @info["mac_address"]
+    end
+
+    def subnet
+      if @info.length < 1
+        parse(@config.section("Lan_Conf"))
+      end
+      @info["subnet_mask"]
+    end
+
+    def gateway
+      if @info.length < 1
+        parse(@config.section("Lan_Conf"))
+      end
+      @info["default_gateway_ip_address"]
+    end
+
+  #  def snmp
+  #
+  #  end
+
+  #  def vlanid
+  #
+  #  end
+
+  #  def snmp=(community)
+  #
+  #  end
+
+    def set_ip(address, static=true)
+      @config.setsection("Lan_Conf", "IP_Address", address)
+    end
+
+    def set_subnet(subnet)
+      @config.setsection("Lan_Conf", "Subnet_Mask", subnet)
+    end
+
+    def set_gateway(address)
+      @config.setsection("Lan_Conf", "Default_Gateway_IP_Address", address)
+    end
+
+  #  def vlanid=(vlan)
+  #
+  #  end
+
+    def parse(landata)
+      landata.lines.each do |line|
+        # clean up the data from spaces
+        next if line.match(/#+/)
+        next if line.match(/Section/i)
+        line.gsub!(/\t/, '')
+        item = line.split(/\s+/)
+        key = item.first.strip.downcase
+        value = item.last.strip
+        @info[key] = value
+
+      end
+      return @info
+    end
+  end
+end
+
+

data/lib/rubyipmi/freeipmi/commands/power.rb

@@ -0,0 +1,72 @@
+module Rubyipmi::Freeipmi
+  class Power < Rubyipmi::Freeipmi::BaseCommand
+
+    def initialize(opts = ObservableHash.new)
+      super("ipmipower", opts)
+    end
+
+    # The command function is a wrapper that actually calls the run method
+    def command(opt)
+      @options[opt] = false
+      value = runcmd
+      @options.delete_notify(opt)
+      return value
+    end
+
+    # Turn on the system
+    def on
+      command("on")
+    end
+
+    # Turn off the system
+    def off
+      command("off")
+    end
+
+    # Power cycle the system
+    def cycle
+      # if the system is off turn it on
+      if off?
+        on
+      else
+        command("cycle")
+      end
+
+    end
+
+    # Perform a power reset on the system
+    def reset
+      command("reset")
+    end
+
+    # Perform a soft shutdown, like briefly pushing the power button
+    def softShutdown
+      command("soft")
+    end
+
+    def powerInterrupt
+      command("pulse")
+    end
+
+    # Get the power status of the system, will show either on or off
+    def status
+      value = command("stat")
+      if value
+        @result.split(":").last.chomp.strip
+      end
+    end
+
+    # Test to see if the power is on
+    def on?
+      status == "on"
+    end
+
+    # Test to see if the power is off
+    def off?
+      status == "off"
+    end
+
+
+
+  end
+end

data/lib/rubyipmi/freeipmi/connection.rb

@@ -0,0 +1,43 @@
+require 'rubyipmi/freeipmi/errorcodes'
+require 'rubyipmi/observablehash'
+require 'rubyipmi/commands/basecommand'
+require 'rubyipmi/freeipmi/commands/basecommand'
+
+Dir[File.dirname(__FILE__) + '/commands/*.rb'].each do |file|
+  require "#{file.split(".rb").first}"
+end
+module Rubyipmi
+  module Freeipmi
+
+    class Connection
+
+      attr_accessor :options
+
+
+      def initialize(user, pass, host)
+        @options = Rubyipmi::ObservableHash.new
+        raise("Must provide a host to connect to") unless host
+        @options["hostname"] = host
+        # Credentials can also be stored in the freeipmi configuration file
+        # So they are not required
+        @options["username"] = user if user
+        @options["password"] = pass if pass
+
+        #getWorkArounds
+      end
+
+      def provider
+        return "freeipmi"
+      end
+
+      def bmc
+        @bmc ||= Rubyipmi::Freeipmi::Bmc.new(@options)
+      end
+
+      def chassis
+        @chassis ||= Rubyipmi::Freeipmi::Chassis.new(@options)
+      end
+
+    end
+  end
+end

data/lib/rubyipmi/freeipmi/errorcodes.rb

@@ -0,0 +1,15 @@
+module Rubyipmi::Freeipmi
+
+  class ErrorCodes
+
+    @@code = {
+        "authentication type unavailable for attempted privilege level" => {"driver-type" => "LAN_2_0"},
+
+    }
+
+    def self.code
+       @@code
+    end
+  end
+
+end

data/lib/rubyipmi/ipmitool/commands/basecommand.rb

@@ -0,0 +1,60 @@
+module Rubyipmi::Ipmitool
+
+  class BaseCommand < Rubyipmi::BaseCommand
+
+    def makecommand
+      args = ""
+      # need to format the options to ipmitool format
+      @options.each do  |k,v|
+        next if k == "cmdargs"
+        args << "-#{k} #{v} "
+      end
+      # since ipmitool requires commands to be in specific order
+      args << " " + options["cmdargs"]
+
+      return "#{cmd} #{args}"
+    end
+
+
+    # The findfix method acts like a recursive method and applies fixes defined in the errorcodes
+    # If a fix is found it is applied to the options hash, and then the last run command is retried
+    # until all the fixes are exhausted or a error not defined in the errorcodes is found
+    def findfix(result, args, debug, runmethod)
+      if result
+        # The errorcode code hash contains the fix
+        fix = Rubyipmi::Ipmitool::ErrorCodes.code[result]
+
+        if not fix
+          raise "Ipmi Fix not found, email author with error: #{result}"
+        else
+          @options.merge_notify!(fix)
+          # retry the last called method
+          # its quicker to explicitly call these commands than calling a command block
+          if runmethod == "runcmd"
+            runcmd(debug)
+          else
+            runcmd_without_opts(args, debug)
+          end
+
+        end
+
+      end
+    end
+    def throwError
+      # Find out what kind of error is happening, parse results
+      # Check for authentication or connection issue
+      #puts "ipmi call: #{@lastcall}"
+
+      if @result =~ /timeout|timed\ out/
+        code = "ipmi call: #{@lastcall} timed out"
+        raise code
+      else
+        # ipmitool spits out many errors so for now we will just take the first error
+        code = @result.split(/\r\n/).first if not @result.empty?
+      end
+      throw :ipmierror, code
+    end
+
+
+  end
+end

data/lib/rubyipmi/ipmitool/commands/bmc.rb

@@ -0,0 +1,95 @@
+module Rubyipmi::Ipmitool
+
+  class Bmc < Rubyipmi::Ipmitool::BaseCommand
+
+    attr_accessor :config
+
+    def initialize(opts = ObservableHash.new)
+      super("ipmitool", opts)
+      @bmcinfo = {}
+    end
+
+    def lan
+      @lan ||= Rubyipmi::Ipmitool::Lan.new(@options)
+    end
+
+    def info
+      if @bmcinfo.length > 0
+        @bmcinfo
+      else
+        retrieve
+      end
+    end
+
+    def guid
+      @options["cmdargs"] = "bmc guid"
+      value = runcmd()
+      @options.delete_notify("cmdargs")
+      if value
+        @result.lines.each { | line |
+          line.chomp
+          if line =~ /GUID/
+            line.split(":").last.strip
+          end
+        }
+      end
+
+    end
+
+    # Some sample data for info
+    # Device ID                 : 17
+    # Device Revision           : 1
+    # Firmware Revision         : 2.9
+    # IPMI Version              : 2.0
+    # Manufacturer ID           : 11
+    # Manufacturer Name         : Hewlett-Packard
+    # Product ID                : 8192 (0x2000)
+    # Product Name              : Unknown (0x2000)
+    # Device Available          : yes
+    # Provides Device SDRs      : yes
+    # Additional Device Support :
+    #     Sensor Device
+    #     SDR Repository Device
+    #     SEL Device
+    #     FRU Inventory Device
+    # Aux Firmware Rev Info     :
+    #     0x00
+    #     0x00
+    #     0x00
+    #     0x30
+
+
+    # This function will get the bmcinfo and return a hash of each item in the info
+    def retrieve
+      @options["cmdargs"] = "bmc info"
+      status = runcmd
+      @options.delete_notify("cmdargs")
+      subkey = nil
+      if not status
+        raise @result
+      else
+        @result.lines.each do |line|
+          # clean up the data from spaces
+          item = line.split(':')
+          key = item.first.strip
+          value = item.last.strip
+          # if the following condition is met we have subvalues
+          if key == value and not subkey
+            subkey = key
+            @bmcinfo[subkey] = []
+          elsif key == value and subkey
+            # subvalue found
+            @bmcinfo[subkey] << value
+          else
+            # Normal key/value pair with no subkeys
+            subkey = nil
+            @bmcinfo[key] = value
+          end
+        end
+        return @bmcinfo
+      end
+    end
+
+
+  end
+end