rubyipmi 0.3.0

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

@@ -0,0 +1,106 @@
+module Rubyipmi::Ipmitool
+
+  class Chassis < Rubyipmi::Ipmitool::BaseCommand
+
+    def initialize(opts = ObservableHash.new)
+      super("ipmitool", opts)
+
+    end
+
+    # Turn the led light on / off or with a delay
+    def identify(status=false, delay=0)
+      if status
+        if delay <= 0
+          options["cmdargs"] = "chassis identify -1"
+        else
+          options["cmdargs"] = "chassis identify #{delay}"
+        end
+      else
+        options["cmdargs"] = "chassis identify 0"
+      end
+      # Run the command
+      value = runcmd
+      options.delete_notify("cmdargs")
+      return value
+    end
+
+    # Access to the power command created on the fly
+    def power
+      @power ||= Rubyipmi::Ipmitool::Power.new(@options)
+    end
+
+    # Access to the config command created on the fly
+    def config
+      @config ||= Rubyipmi::Ipmitool::ChassisConfig.new(@options)
+    end
+
+    # set boot device from given boot device
+    def bootdevice(device, reboot=false,persistent=false)
+      if config.bootdevices.include?(device)
+        status = config.bootdevice(device, persistent)
+        if reboot and status
+          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)
+      status = config.bootpxe(persistent)
+      # Only reboot if setting the boot flag was successful
+      if reboot and status
+        power.cycle
+      end
+    end
+
+    # set boot device to disk with option to reboot
+    def bootdisk(reboot=false,persistent=false)
+      config.bootdisk(persistent)
+      # Only reboot if setting the boot flag was successful
+      if reboot and status
+        power.cycle
+      end
+
+    end
+
+    # set boot device to cdrom with option to reboot
+    def bootcdrom(reboot=false,persistent=false)
+      config.bootcdrom(persistent)
+      # Only reboot if setting the boot flag was successful
+      if reboot and status
+        power.cycle
+      end
+    end
+
+    # boot into bios setup with option to reboot
+    def bootbios(reboot=false,persistent=false)
+      config.bootbios(persistent)
+      # Only reboot if setting the boot flag was successful
+      if reboot and status
+        power.cycle
+      end
+    end
+
+    def status
+       options["cmdargs"] = "chassis status"
+       value = runcmd
+       options.delete_notify("cmdargs")
+       return { :result => @result, :value => value }
+    end
+
+    # A currently unsupported method to retrieve the led status
+    def identifystatus
+      options["cmdargs"] = "chassis identify status"
+      value = runcmd
+      options.delete_notify("cmdargs")
+      if value
+        @result.chomp.split(":").last.strip
+      end
+    end
+
+
+  end
+end

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

@@ -0,0 +1,52 @@
+module Rubyipmi::Ipmitool
+
+  class ChassisConfig < Rubyipmi::Ipmitool::BaseCommand
+
+    def initialize(opts = ObservableHash.new)
+      super("ipmitool", opts)
+
+    end
+
+    # Get the current boot device
+    def bootdevice
+       # Not available with ipmitool
+       false
+    end
+
+    # Set the boot device
+    def bootdevice(device, persistent=false)
+      @options["cmdargs"] = "chassis bootdev #{device}"
+      value = runcmd
+      @options.delete_notify("cmdargs")
+      return value
+    end
+
+    # Get list of available boot devices
+    def bootdevices
+      # ideally we should get this list from the ipmidevice
+      # However ipmitool only has a static list
+      ["pxe", "disk", "safe", "diag", "cdrom", "bios", "floppy"]
+    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("disk")
+    end
+
+    # shortcut to set boot device to cdrom
+    def bootcdrom(persistent=false)
+      bootdevice("cdrom")
+    end
+
+    # shortcut to boot into bios setup
+    def bootbios(persistent=false)
+      bootdevice("bios")
+    end
+
+  end
+end

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

@@ -0,0 +1,162 @@
+module Rubyipmi::Ipmitool
+
+  class Lan < Rubyipmi::Ipmitool::BaseCommand
+
+    attr_accessor :info
+    attr_accessor :channel
+
+    def initialize(opts = ObservableHash.new)
+      super("ipmitool", opts)
+      @info = {}
+      @channel = 2
+
+    end
+
+    def info
+      if @info.length < 1
+        parse(print)
+      else
+        @info
+      end
+    end
+
+    def print
+      @options["cmdargs"] = "lan print"
+      value = runcmd
+      @options.delete_notify("cmdargs")
+      if value
+        @result
+      end
+    end
+
+  #  def snmp
+  #    if @info.length < 1
+  #      parse(print)
+  #    end
+  #    # Some systems do not report the snmp string
+  #    @info["snmp community string"]
+  #  end
+
+    def ip
+      if @info.length < 1
+        parse(print)
+      end
+      @info["ip address"]
+    end
+
+    def mac
+      if @info.length < 1
+        parse(print)
+      end
+      @info["mac address"]
+    end
+
+    def subnet
+      if @info.length < 1
+        parse(print)
+      end
+      @info["subnet mask"]
+    end
+
+    def gateway
+      if @info.length < 1
+        parse(print)
+      end
+      @info["default gateway ip"]
+    end
+
+  #  def vlanid
+  #    if @info.length < 1
+  #      parse(print)
+  #    end
+  #    @info["802.1q vlan id"]
+  #  end
+
+  #  def snmp=(community)
+  #    @options["cmdargs"] = "lan set #{channel} snmp #{community}"
+  #    value = runcmd
+  #    @options.delete_notify("cmdargs")
+  #    return value
+  #  end
+
+    def set_ip(address, static=true)
+      @options["cmdargs"] = "lan set #{channel} ipaddr #{address}"
+      value = runcmd
+      @options.delete_notify("cmdargs")
+      return value
+    end
+
+    def set_subnet(subnet)
+      @options["cmdargs"] = "lan set #{channel} netmask #{subnet}"
+      value = runcmd
+      @options.delete_notify("cmdargs")
+      return value
+    end
+
+    def set_gateway(address)
+      @options["cmdargs"] = "lan set #{channel} defgw #{address}"
+      value = runcmd
+      @options.delete_notify("cmdargs")
+      return value
+    end
+
+    def dhcp?
+      if @info.length < 1
+        parse(print)
+      end
+      @info["ip address source"].match(/dhcp/i) != nil
+    end
+
+    def static?
+      if @info.length < 1
+        parse(print)
+      end
+      @info["ip address source"].match(/static/i) != nil
+    end
+
+  #  def vlanid=(vlan)
+  #    @options["cmdargs"] = "lan set #{channel} vlan id #{vlan}"
+  #    value = runcmd
+  #    @options.delete_notify("cmdargs")
+  #    return value
+  #  end
+
+
+    def parse(landata)
+      multikey = ""
+      multivalue = {}
+
+      landata.lines.each do |line|
+        # clean up the data from spaces
+        item = line.split(':', 2)
+        key = item.first.strip.downcase
+        value = item.last.strip
+        @info[key] = value
+
+      end
+      return @info
+    end
+
+
+
+
+  end
+end
+
+#Set in Progress         : Set Complete
+#Auth Type Support       :
+#Auth Type Enable        : Callback :
+#                        : User     : NONE MD2 MD5 PASSWORD OEM
+#                        : Operator : NONE MD2 MD5
+#                        : Admin    : MD2 MD5
+#                        : OEM      :
+#IP Address Source       : DHCP Address
+#IP Address              : 192.168.1.41
+#Subnet Mask             : 255.255.255.0
+#MAC Address             : 00:17:a4:49:ab:70
+#BMC ARP Control         : ARP Responses Enabled, Gratuitous ARP Disabled
+#Gratituous ARP Intrvl   : 0.0 seconds
+#Default Gateway IP      : 192.168.1.1
+#802.1q VLAN ID          : Disabled
+#802.1q VLAN Priority    : 0
+#Cipher Suite Priv Max   : Not Available

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

@@ -0,0 +1,74 @@
+module Rubyipmi::Ipmitool
+
+  class Power < Rubyipmi::Ipmitool::BaseCommand
+
+    def initialize(opts = ObservableHash.new)
+      super("ipmitool", opts)
+    end
+
+    # The command function is a wrapper that actually calls the run method
+    def command(opt)
+      @options["cmdargs"] = "power #{opt}"
+      value = runcmd
+      @options.delete_notify("cmdargs")
+      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("diag")
+    end
+
+    # Get the power status of the system, will show either on or off
+    def status
+      value = command("status")
+      if value
+        @result.match(/(off|on)/).to_s
+      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/ipmitool/connection.rb

@@ -0,0 +1,46 @@
+require 'rubyipmi/ipmitool/errorcodes'
+require 'rubyipmi/observablehash'
+require 'rubyipmi/commands/basecommand'
+require 'rubyipmi/ipmitool/commands/basecommand'
+
+Dir[File.dirname(__FILE__) + '/commands/*.rb'].each do |file|
+  require "#{file.split(".rb").first}"
+end
+
+module Rubyipmi
+  module Ipmitool
+
+    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["H"] = host
+        # Credentials can also be stored in the freeipmi configuration file
+        # So they are not required
+        @options["U"] = user if user
+        @options["P"] = pass if pass
+        # default to IPMI 2.0 communication
+        #@options["I"] = "lanplus"
+
+        #getWorkArounds
+      end
+
+      def provider
+        return "ipmitool"
+      end
+
+      def bmc
+        @bmc ||= Rubyipmi::Ipmitool::Bmc.new(@options)
+      end
+
+      def chassis
+        @chassis ||= Rubyipmi::Ipmitool::Chassis.new(@options)
+      end
+
+    end
+  end
+end

data/lib/rubyipmi/ipmitool/errorcodes.rb

@@ -0,0 +1,18 @@
+module Rubyipmi
+  module Ipmitool
+    class ErrorCodes
+
+      @@code = {
+          "Authentication type NONE not supported" => {"I" => "lanplus"},
+
+      }
+
+      def self.code
+        @@code
+      end
+    end
+
+
+  end
+end
+