rubyipmi 0.3.0

data/lib/rubyipmi/commands/basecommand.rb

@@ -0,0 +1,171 @@
+require "observer"
+
+module Rubyipmi
+
+  class BaseCommand
+    include Observable
+
+    attr_reader :cmd
+    attr_accessor :options
+    attr_reader :lastcall
+
+    def makecommand
+      # override in subclass
+    end
+
+    def to_s
+      makecommand
+    end
+
+    def initialize(commandname, opts = ObservableHash.new)
+      # This will locate the command path or raise an error if not found
+      @cmdname = commandname
+      @cmd = `which #{commandname}`.strip
+      if not $?.success?
+        raise "#{commandname} command not found, is #{commandname} installed?"
+      end
+      @options = opts
+      @options.add_observer(self)
+    end
+
+    # Use this function to run the command line tool, it will inherently use the options hash for all options
+    # That need to be specified on the command line
+    def runcmd(debug=false)
+      @success = false
+
+      result = catch(:ipmierror){
+        @success = run(debug)
+      }
+      # if error occurs try and find the fix
+      if result and not @success
+        findfix(result, nil, debug, "runcmd")
+      end
+      return @success
+
+
+    end
+
+
+    def runcmd_without_opts(args=[], debug=false)
+
+      @success = false
+      result = catch(:ipmierror){
+        @success = run_without_opts(args, debug)
+
+      }
+      # if error occurs try and find the fix and rerun the method
+      if result and not @success
+        findfix(result, args, debug, "runcmd_with_args")
+      end
+      return @success
+    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 = 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 == "run"
+            run(debug)
+          else
+            run_without_opts(args, debug)
+          end
+
+        end
+
+      end
+    end
+
+
+    def run(debug=false)
+      @result = nil
+      command = makecommand
+      if debug
+        return command
+      end
+
+      @lastcall = "#{command}"
+      @result = `#{command} 2>&1`
+      #puts "Last Call: #{@lastcall}"
+
+      # sometimes the command tool doesnt return the correct result
+      process_status = validate_status($?)
+
+      if not process_status
+        throwError
+      end
+      return process_status
+    end
+
+
+
+    def run_without_opts(args=[], debug=false)
+      @result = ""
+      if debug
+        return "#{cmd} #{args.join(" ")}"
+      else
+        @lastcall = "#{cmd} #{args.join(" ")}"
+        @result = `#{cmd} #{args.join(" ")} 2>&1`
+      end
+
+      process_status = validate_status($?)
+
+      if not process_status
+        throwError
+      end
+      return process_status
+
+
+    end
+
+    def update(opts)
+          @options.merge!(opts)
+          #puts "Options were updated: #{@options.inspect}"
+    end
+
+
+
+
+    # This method will check if the results are really valid as the exit code can be misleading and incorrect
+    def validate_status(exitstatus)
+      # override in child class if needed
+      return exitstatus.success?
+
+    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
+        code = @result.split(":").last.chomp.strip if not @result.empty?
+      end
+      case code
+        when "invalid hostname"
+          raise code
+        when "password invalid"
+          raise code
+        when "username invalid"
+          raise code
+        else
+          throw :ipmierror, code
+      end
+
+    end
+
+
+
+  end
+end

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

@@ -0,0 +1,60 @@
+module Rubyipmi::Freeipmi
+
+  class BaseCommand < Rubyipmi::BaseCommand
+
+    def makecommand
+      # need to format the options to freeipmi format
+      args = @options.collect { |k, v|
+        if not v
+          "--#{k}"
+        else
+          "--#{k}=#{v}"
+        end
+      }.join(" ")
+
+      return "#{cmd} #{args}"
+    end
+
+    # This method will check if the results are really valid as the exit code can be misleading and incorrect
+    def validate_status(exitstatus)
+      case @cmdname
+        when "ipmipower"
+          # until ipmipower returns the correct exit status this is a hack
+          # essentially any result greater than 23 characters is an error
+          if @result.length > 23
+            return false
+          end
+        when "bmc-config"
+          if @result.length > 100
+            return true
+          end
+      end
+      return exitstatus.success?
+
+    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::Freeipmi::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
+  end
+end

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

@@ -0,0 +1,37 @@
+module Rubyipmi::Freeipmi
+
+  class Bmc
+
+    attr_accessor :options
+    attr_accessor :config
+
+    def initialize(opts = ObservableHash.new)
+      @options = opts
+      @bmcinfo = {}
+    end
+
+    def info
+      if @bmcinfo.length > 0
+        @bmcinfo
+      else
+        information.retrieve
+      end
+    end
+
+    def guid
+       information.guid
+    end
+
+    def config
+      @config ||= Rubyipmi::Freeipmi::BmcConfig.new(options)
+    end
+
+    def lan
+      @lan ||= Rubyipmi::Freeipmi::Lan.new(options)
+    end
+
+    def information
+      @info ||= Rubyipmi::Freeipmi::BmcInfo.new(@options)
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Rubyipmi::Freeipmi
+
+  class BmcConfig < Rubyipmi::Freeipmi::BaseCommand
+
+    def initialize(opts = ObservableHash.new)
+      super("bmc-config", opts)
+      @sections = []
+
+    end
+
+    def section(section)
+       @options["checkout"] = false
+       @options["section"] = section
+       value = runcmd
+       @options.delete_notify("checkout")
+       @options.delete_notify("section")
+       @result
+    end
+
+    def setsection(section, key, value)
+      keypair = "#{section}:#{key}=#{value}"
+      @options["commit"] = false
+      if not keypair.empty?
+        @options["key-pair"] = keypair
+        value = runcmd
+        @options.delete_notify("commit")
+        @options.delete_notify("key-pair")
+        return value
+      end
+      return false
+    end
+
+
+    # returns the entire bmc-config configuration, can take a while to execute
+    def configuration
+      @options["checkout"] = false
+      value = runcmd
+      @options.delete_notify("checkout")
+      @result
+    end
+
+    # Returns a list of available sections to inspect
+    def listsections
+      if @sections.length < 1
+        @options["listsections"] = false
+        value = runcmd
+        @options.delete_notify("listsections")
+        if value
+          @sections = @result.split(/\n/)
+        end
+      end
+      @sections
+    end
+
+
+  end
+end

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

@@ -0,0 +1,76 @@
+module Rubyipmi::Freeipmi
+
+  class BmcInfo < Rubyipmi::Freeipmi::BaseCommand
+
+    def initialize(opts = ObservableHash.new)
+      super("bmc-info", opts)
+
+    end
+
+
+    def guid
+      @options["guid"] = false
+      status = runcmd
+      @options.delete_notify["guid"]
+      if not status
+        raise @result
+      else
+        @result.chomp.strip
+      end
+
+    end
+    # freeipmi
+    # Device ID:         17
+    # Device Revision:   1
+    #                    [SDR Support]
+    # Firmware Revision: 2.09
+    #                    [Device Available (normal operation)]
+    # IPMI Version:      2.0
+    # Additional Device Support:
+    #                    [Sensor Device]
+    #                    [SDR Repository Device]
+    #                    [SEL Device]
+    #                    [FRU Inventory Device]
+    # Manufacturer ID:   11
+    # Product ID:        8192
+    # Channel Information:
+    #        Channel No: 2
+    #       Medium Type: 802.3 LAN
+    #     Protocol Type: IPMB-1.0
+    #        Channel No: 7
+    #       Medium Type: OEM
+    #     Protocol Type: KCS
+    def retrieve
+      bmcinfo = {}
+      status = runcmd
+      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.gsub(/\[|\]/, "")
+          else
+            # Normal key/value pair with no subkeys
+            subkey = nil
+            bmcinfo[key] = value
+          end
+        end
+        return bmcinfo
+      end
+    end
+
+
+  end
+end
+
+

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

@@ -0,0 +1,123 @@
+module Rubyipmi::Freeipmi
+
+  class Chassis < Rubyipmi::Freeipmi::BaseCommand
+
+    def initialize(opts = ObservableHash.new)
+      super("ipmi-chassis", opts)
+
+    end
+
+    # Turn the led light on / off or with a delay
+    def identify(status=false, delay=0)
+      if status
+        if delay <= 0
+          options["chassis-identify"] = "FORCE"
+        else
+          options["chassis-identify"] = delay
+        end
+      else
+        options["chassis-identify"] = "TURN-OFF"
+      end
+      # Run the command
+      value = runcmd
+      options.delete_notify("chassis-identify")
+      return value
+    end
+
+    # Access to the power command created on the fly
+    def power
+      @power ||= Rubyipmi::Freeipmi::Power.new(@options)
+    end
+
+    # Access to the config command created on the fly
+    def config
+      @config ||= Rubyipmi::Freeipmi::ChassisConfig.new(@options)
+    end
+
+    # set boot device from given boot device
+    def bootdevice(device, reboot=false, persistent=false)
+      if config.bootdevices.include?(device)
+        bootstatus = config.bootdevice(device, persistent)
+        if reboot and bootstatus
+          power.cycle
+        end
+
+      else
+        raise "Device with name: #{device} is not a valid boot device for host #{options["hostname"]}"
+      end
+    end
+
+    # set boot device to pxe with option to reboot
+    def bootpxe(reboot=false,persistent=false)
+      bootstatus = config.bootpxe(persistent)
+      # Only reboot if setting the boot flag was successful
+      if reboot and bootstatus
+        power.cycle
+      end
+    end
+
+    # set boot device to disk with option to reboot
+    def bootdisk(reboot=false,persistent=false)
+      bootstatus = config.bootdisk(persistent)
+      # Only reboot if setting the boot flag was successful
+      if reboot and bootstatus
+        power.cycle
+      end
+
+    end
+
+    # set boot device to cdrom with option to reboot
+    def bootcdrom(reboot=false,persistent=false)
+      bootstatus = config.bootcdrom(persistent)
+      # Only reboot if setting the boot flag was successful
+      if reboot and bootstatus
+        power.cycle
+      end
+    end
+
+    # boot into bios setup with option to reboot
+    def bootbios(reboot=false,persistent=false)
+      bootstatus = config.bootbios(persistent)
+      # Only reboot if setting the boot flag was successful
+      if reboot and bootstatus
+        power.cycle
+      end
+    end
+
+    def status
+       options["get-status"] = false
+       value = runcmd
+       options.delete_notify("get-status")
+       if value
+         return parsestatus
+       else
+         return value
+       end
+
+    end
+
+    # A currently unsupported method to retrieve the led status
+    def identifystatus
+      # TODO implement this function
+      # parse out the identify status
+     # status.result
+    end
+
+    private
+    def parsestatus
+      statusresult = @result
+      statusvalues = {}
+      subkey = nil
+      statusresult.lines.each do |line|
+        # clean up the data from spaces
+        item = line.split(':')
+        key = item.first.strip
+        value = item.last.strip
+        statusvalues[key] = value
+      end
+      return statusvalues
+    end
+
+
+  end
+end