rubyipmi 0.6.0 → 0.7.0

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

@@ -10,7 +10,7 @@ module Rubyipmi::Freeipmi
       @options[opt] = false
       value = runcmd
       @options.delete_notify(opt)
-      return value
+      return @result
     end
 
     # Turn on the system

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

@@ -6,103 +6,106 @@ module Rubyipmi::Freeipmi
       super("ipmi-sensors", opts)
       @options["no-header-output"] = false
       @options["output-sensor-state"] = false
+      @options["entity-sensor-names"] = false
     end
 
     def refresh
       @sensors = nil
-      sensors
+      list
     end
 
     def list
-      sensors
+      @sensors ||= parse(getsensors)
     end
 
     def count
-      sensors.count
+      list.count
     end
 
     def names
-      sensors.keys
+      list.keys
     end
 
+    # returns a hash of fan sensors where the key is fan name and value is the sensor
     def fanlist(refreshdata=false)
       refresh if refreshdata
-      flist = []
-      values = sensors.each do |sensor|
-        match = sensor.first.match(/(fan)_(\d+)/)
-        next if match.nil?
-        if match[1] == "fan"
-          num = (match[2].to_i) -1
-          flist[num] = sensor.last[:value]
+      flist = {}
+      list.each do | name,sensor |
+        if name =~ /.*fan.*/
+          flist[name] = sensor
         end
       end
-      flist
+      return flist
     end
 
+    # returns a hash of sensors where each key is the name of the sensor and the value is the sensor
     def templist(refreshdata=false)
       refresh if refreshdata
-      tlist = []
-      values = sensors.each do |sensor|
-        match = sensor.first.match(/(temp)_(\d+)/)
-        next if match.nil?
-        if match[1] == "temp"
-          num = (match[2].to_i) -1
-          tlist[num] = sensor.last[:value]
+      tlist = {}
+      list.each do | name , sensor |
+        if sensor[:unit] =~ /.*degree.*/ || name =~ /.*temp.*/
+          tlist[name] = sensor
         end
       end
-      tlist
+      return tlist
     end
 
-
+    def getsensors
+      value = runcmd
+      return @result
+    end
 
     private
 
-    def sensors
-      @sensors ||= parse(getsensors)
-    end
-
     def method_missing(method, *args, &block)
-      if not sensors.has_key?(method.to_s)
+      if not list.has_key?(method.to_s)
         raise NoMethodError
       else
-        sensors[method.to_s]
+        list[method.to_s]
       end
     end
 
-
-    def getsensors
-      value = runcmd
-      @result
-    end
-
     def parse(data)
       sensorlist = {}
-      data.lines.each do | line|
-        # skip the header
-        data = line.split(/\|/)
-        # remove number column
-        data.shift
-        sensor = Sensor.new(data[0].strip)
-        sensor[:type] = data[1].strip
-        sensor[:state] = data[2].strip
-        sensor[:value] = data[3].strip
-        sensor[:unit] = data[4].strip
-        sensor[:status] = data[5].strip
-        sensorlist[sensor[:name]] = sensor
-
+      if ! data.nil?
+        data.lines.each do | line|
+          # skip the header
+          sensor = Sensor.new(line)
+          sensorlist[sensor[:name]] = sensor
+        end
       end
       return sensorlist
-
     end
+
   end
 
   class Sensor < Hash
+    def initialize(line)
+      parse(line)
+      self[:name] = normalize(self[:name])
+    end
 
-    def initialize(sname)
-      self[:fullname] = sname
-      self[:name] = sname.gsub(/\ /, '_').gsub(/\./, '').downcase
+    private
+    def normalize(text)
+      text.gsub(/\ /, '_').gsub(/\./, '').downcase
     end
 
+    # Parse the individual sensor
+    # Note: not all fields will exist on every server
+    def parse(line)
+      fields = [:id_num, :name, :value, :unit, :status, :type, :state, :lower_nonrec,
+                :lower_crit,:lower_noncrit, :upper_crit, :upper_nonrec, :asserts_enabled, :deasserts_enabled  ]
+      data = line.split(/\|/)
+      # should we ever encounter a field not in the fields list, just use a counter based fieldname so we just
+      # use field1, field2, field3, ...
+      i = 0
+      data.each do | value |
+        field ||= fields.shift || "field#{i}"
+        self[field] = value.strip
+        i = i.next
+      end
+    end
   end
+
 end
 

data/lib/rubyipmi/freeipmi/connection.rb

@@ -14,7 +14,7 @@ module Rubyipmi
       attr_accessor :options
 
 
-      def initialize(user, pass, host)
+      def initialize(user, pass, host,debug=false)
         @options = Rubyipmi::ObservableHash.new
         raise("Must provide a host to connect to") unless host
         @options["hostname"] = host
@@ -22,7 +22,7 @@ module Rubyipmi
         # So they are not required
         @options["username"] = user if user
         @options["password"] = pass if pass
-
+        #@options["driver-type"] = 'LAN_2_0'
         #getWorkArounds
       end
 
@@ -46,6 +46,20 @@ module Rubyipmi
         @sensors ||= Rubyipmi::Freeipmi::Sensors.new(@options)
       end
 
+      def get_diag
+        data = {}
+        data['provider'] = provider
+        if @fru
+          data['frus'] = @fru.getfrus
+        end
+        if @sensors
+          data['sensors'] = @sensors.getsensors
+        end
+        if @bmc
+          data['bmc_info'] = @bmc.info
+        end
+      end
+
     end
   end
 end

data/lib/rubyipmi/freeipmi/errorcodes.rb

@@ -2,14 +2,37 @@ module Rubyipmi::Freeipmi
 
   class ErrorCodes
 
-    @@code = {
+    @@codes = {
         "authentication type unavailable for attempted privilege level" => {"driver-type" => "LAN_2_0"},
+        "authentication type unavailable for attempted privilege level\n" => {"driver-type" => "LAN_2_0"},
 
     }
 
+    def self.length
+      @@codes.length
+    end
+
     def self.code
-       @@code
+       @@codes
     end
+
+    def self.search(code)
+      # example error code:
+      # "/usr/local/sbin/bmc-info: authentication type unavailable for attempted privilege level\n"
+      code.chomp!  # clean up newline
+      code = code.split(':').last.strip  # clean up left hand side and strip white space from sides
+      fix = @@codes.fetch(code,nil)
+      if fix.nil?
+        @@codes.each do | error, result |
+          if code =~ /.*#{error}.*/i
+            fix = result
+          end
+        end
+      end
+      raise "No Fix found" if fix.nil?
+      return fix
+    end
+
   end
 
 end

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

@@ -1,3 +1,5 @@
+require 'rubyipmi/ipmitool/errorcodes'
+
 module Rubyipmi::Ipmitool
 
   class BaseCommand < Rubyipmi::BaseCommand
@@ -5,68 +7,49 @@ module Rubyipmi::Ipmitool
     def setpass
       super
       @options["f"] = @passfile.path
-      @passfile.puts "#{@options["P"]}"
+      @passfile.write "#{@options["P"]}"
+      @passfile.rewind
       @passfile.close
+    end
 
-
+    def max_retry_count
+      @max_retry_count ||= Rubyipmi::Ipmitool::ErrorCodes.length
     end
 
     def makecommand
-      args = ""
+      args = ''
       # need to format the options to ipmitool format
       @options.each do  |k,v|
+        # must remove from command line as its handled via conf file
+        next if k == "P"
         next if k == "cmdargs"
-        args << "-#{k} #{v} "
+        args << " -#{k} #{v}"
       end
-      # must remove from command line as its handled via conf file
-      args.delete("-P")
 
       # since ipmitool requires commands to be in specific order
-      args << " " + options["cmdargs"]
 
-      return "#{cmd} #{args}"
-    end
+      args << ' ' + options.fetch('cmdargs', '')
 
+      return "#{cmd} #{args.lstrip}"
+    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)
+    def find_fix(result)
       if result
         # The errorcode code hash contains the fix
-        fix = Rubyipmi::Ipmitool::ErrorCodes.code[result]
-
-        if not fix
-          raise "#{result}"
-        else
+        begin
+          fix = ErrorCodes.search(result)
           @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
 
+        rescue
+          raise "Could not find fix for error code: \n#{result}"
         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
 end

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

@@ -49,29 +49,6 @@ module Rubyipmi::Ipmitool
 
     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"
@@ -87,7 +64,7 @@ module Rubyipmi::Ipmitool
           key = item.first.strip
           value = item.last.strip
           # if the following condition is met we have subvalues
-          if key == value and not subkey
+          if value.empty?
             subkey = key
             @bmcinfo[subkey] = []
           elsif key == value and subkey

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

@@ -8,6 +8,7 @@ module Rubyipmi::Ipmitool
     end
 
     # Turn the led light on / off or with a delay
+    # status means to enable or disable the blinking
     def identify(status=false, delay=0)
       if status
         if not delay.between?(1,255)

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

@@ -2,62 +2,144 @@ module Rubyipmi::Ipmitool
 
   class Fru < Rubyipmi::Ipmitool::BaseCommand
 
+    attr_accessor :list
+
+    DEFAULT_FRU = 'builtin_fru_device'
+
+
     def initialize(opts = ObservableHash.new)
       super("ipmitool", opts)
+      @list = {}
     end
 
-    # return the list of fru information in a hash
-    def list
-      @list ||= parse(command)
+    def names
+      list.keys
+    end
+
+    def manufacturer
+      list[DEFAULT_FRU]['product_manufacturer']
     end
 
-    # returns the serial of the board
     def serial
-       list["board_serial"]
+      list[DEFAULT_FRU]['board_serial']
     end
 
-    # returns the manufacturer of the server
-    def manufacturer
-       list["product_manufacturer"]
+    def model
+      list[DEFAULT_FRU]['product_manufacturer']
     end
 
-    # returns the product name of the server
-    def product
-       list["product_name"]
+    # return the list of fru information in a hash
+    def list
+      if @list.count < 1
+        parse(getfrus)
+      end
+      @list
+    end
+
+  # method to retrieve the raw fru data
+    def getfrus
+      command
     end
 
    private
 
+    # I use method missing to allow the user to say Fru.<name> which returns a frudata object unless the user
+    # passes a keyname from the default fru device
     def method_missing(method, *args, &block)
-          if not list.has_key?(method.to_s)
-            raise NoMethodError
-          else
-            list[method.to_s]
-          end
-     end
+      name = method.to_s
+      fru = list.fetch(name, nil)
+      # if the user wanted some data from the default fru, lets show the data for the fru.  Otherwise
+      # we return the Fru with the given name
+      if fru.nil?
+        if list[DEFAULT_FRU].keys.include?(name)
+          return list[DEFAULT_FRU][name]
+        else
+          # maybe we should return nil instead? hmm...
+          raise NoMethodError
+        end
+      else
+        return fru
+      end
+    end
 
     # parse the fru information
     def parse(data)
-      datalist = {}
-      data.lines.each do |line|
-        key, value = line.split(':')
-        next if key =~ /\n/
-        key = key.strip.gsub(/\ /, '_').downcase
-        datalist[key] = value.strip
+      if ! data.nil?
+        parsed_data = []
+        data.lines.each do |line|
+          if line =~ /^FRU.*/
+            # this is the either the first line of of the fru or another fru
+            if parsed_data.count != 0
+              # we have reached a new fru device so lets record the previous fru
+              new_fru = FruData.new(parsed_data)
+              parsed_data = []
+              @list[new_fru[:name]] = new_fru
+            end
+
+          end
+          parsed_data << line
+        end
+        # process the last fru
+        if parsed_data.count != 0
+          # we have reached a new fru device so lets record the previous fru
+          new_fru = FruData.new(parsed_data)
+          parsed_data = []
+          @list[new_fru[:name]] = new_fru
+        end
       end
-      return datalist
     end
 
     # run the command and return result
     def command
-       @options["cmdargs"] = "fru"
-       value = runcmd
-       @options.delete_notify("cmdargs")
-       if value
-         return @result
-       end
+      @options["cmdargs"] = "fru"
+      value = runcmd
+      @options.delete_notify("cmdargs")
+      if value
+        return @result
+      end
     end
 
   end
 
+
+
+
+  class FruData < Hash
+
+    def name
+      self[:name]
+    end
+
+    def initialize(data)
+      parse(data)
+    end
+
+    # parse the fru information that should be an array of lines
+    def parse(data)
+      if ! data.nil?
+        data.each do |line|
+          key, value = line.split(':', 2)
+          if key =~ /^FRU\s+Device.*/
+            if value =~ /([\w\s]*)\(.*\)/
+              self[:name] = $~[1].strip.gsub(/\ /, '_').downcase
+            end
+          else
+            key = key.strip.gsub(/\ /, '_').downcase
+            if ! value.nil?
+              self[key] = value.strip
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      self.fetch(method.to_s, nil)
+    end
+
+  end
+
+
 end