rubyipmi 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73a317277673e2c70ada368153734878751b0697
-  data.tar.gz: ca3ae9b2f301a9ed9c4327af190912dc16525e73
+  metadata.gz: 3ed850aa093b990a1aa90dd18715c163e69a1d5f
+  data.tar.gz: d26e0b37395b5c94054c5fa8287b02cf3a7b96eb
 SHA512:
-  metadata.gz: 4b09be14a0edc2c20bc479f4e430311f081daa98601cc064ced0e69b680b8f5c637ecbaf05c505ddf164d7d42ffd9dd7aee8d39f0d03dcf3a36b7b0327257f1a
-  data.tar.gz: c56d4d03854fa96d484c515a6e2ac05d47be8fc7f578846901c08a2807fa893a4454ca775e08ff0d57120329b6272edd9afed05c67efa80c66fcbd4426982b10
+  metadata.gz: e0fba60554b048d68386581a7cb9a798c07257fd752f35ab8d0432d96bcddd7c4cf657818cc4cd2a0ac7257900e3d98af990ba4d190df626d6347510f926e8cc
+  data.tar.gz: dfb8e7a813fd20f2f1a8ff61e8b532fae46db6214cdc54b959bf960efb506d2865badbafc7b5b90b9c49c3f88a3362b4b11e2ebb82a0984a1af323819d7006f1

data/README.md

@@ -78,39 +78,46 @@ from the standard.  In general this library should work will all servers.
    1. Install the freeipmi from source (http://www.gnu.org/software/freeipmi/) or ipmitool
    2. `gem install rubyipmi`
 
-#### Create a connection object
+### Create a connection object
 
    ```ruby
    require 'rubyipmi'
    conn = Rubyipmi.connect("username", "password", "hostname", "providertype")
-
    ```
 
-   Providertype: optional (ipmitool or freeipmi)
+   Additionally, if your using [openipmi](http://openipmi.sourceforge.net) and will be using rubyipmi to connect to
+   the 
localhost you can utilize the openipmi driver and not have to pass in any connection parameters.
+   Openipmi works
by installing a driver and makes it available to the host.  Freeipmi/Ipmitool will then try to use
+   this driver to
automatically use the openipmi if no host is given.  The one caveat here is that you cannot control
+   remote hosts using
openipmi.  The rubyipmi code must be executed on the host you want to control.
+   The upside is that you don't need
any credentials.  Some commands may require root privileges to run when using openipmi.
+
+   Providertype: optional
+
+      valid options: 'auto', 'ipmitool', 'freeipmi'
 
    If you don't specify the provider type, Rubyipmi will detect if freeipmi or ipmitool
    is installed and load the first tool found.  If you specify the provider type rubyipmi will only use that specific
    provider.
 
-   Additionally, if your using [openipmi](http://openipmi.sourceforge.net) and will be using rubyipmi to connect to the
-   localhost you can utilize the openipmi driver and not have to pass in any connection parameters. Openipmi works
-   by installing a driver and makes it available to the host.  Freeipmi/Ipmitool will then try to use this driver to
-   automatically use the openipmi if no host is given.  The one caveat here is that you cannot control remote hosts using
-   openipmi.  The rubyipmi code must be executed on the host you want to control.  The upside is that you don't need
-   any credentials.  Some commands may require root privileges to run when using openipmi.
-
+   You can specify additional options by passing an options hash into the connection method
    ```ruby
-      conn = Rubyipmi.connect
-      conn.power.status
+      conn = Rubyipmi.connect("username", "password", "hostname", 'freeipmi', {:privilege  =>'USER', :driver => 'lan20'})
    ```
 
-   Should you need to specify some additional options or the provider type
-   ```ruby
-      conn = Rubyipmi.connect("username", "password", "hostname", 'freeipmi', {:privilege  =>'USER'})
-   ```
+   Privilege
+
+      This option controls the role of the user making the ipmi call.
+      valid options: 'CALLBACK', 'USER', 'OPERATOR', 'ADMINISTRATOR'  -- defaults to nil and uses the freeipmi/ipmitool default
+
+   Driver
+
+      This option allows you to control which driver to use when making IPMI calls.  Selecting auto will choose
+      either lan15 or lan20 based on your device.  The open type is when using openipmi in conjunction with the provider.
+      valid options: "auto", "lan15", "lan20", "open"   -- defaults to lan20
 
 
-#### power functions
+### power functions
 
    ```ruby
    require 'rubyipmi'
@@ -123,7 +130,7 @@ from the standard.  In general this library should work will all servers.
 
    ```
 
-#### Boot to specific device
+### Boot to specific device
 
   ```ruby
    require 'rubyipmi'
@@ -134,7 +141,7 @@ from the standard.  In general this library should work will all servers.
   ```
 
 
-#### Sensors
+### Sensors
 
   ```ruby
     require 'rubyipmi'
@@ -145,7 +152,7 @@ from the standard.  In general this library should work will all servers.
 
   ```
 
-#### Fru
+### Fru
 
   ```ruby
     require 'rubyipmi'

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+### 0.10.0
+* gh-26 - make the driver default to lan20
+
+Users of older IPMI devices will now need to pass the specified driver type.
+
 ### 0.9.3
 * normalize the options being passed into the connect method
 

data/VERSION

@@ -1 +1 @@
-0.9.3
+0.10.0

data/lib/rubyipmi.rb

@@ -73,12 +73,12 @@ module Rubyipmi
   # If provider is left blank the function will use the first available provider
   # When the driver is set to auto, rubyipmi will try and figure out which driver to use by common error messages.  We will most likely be using
   # the lan20 driver, but in order to support a wide use case we default to auto.
-  def self.connect(user, pass, host, provider='any', opts={:driver => 'auto', :timeout => 'default'})
+  def self.connect(user, pass, host, provider='any', opts={:driver => 'lan20', :timeout => 'default'})
     # use this variable to reduce cmd calls
     installed = false
 
     # if the user supplied nil, we want to fix this automatically
-    opts = {:driver => 'auto', :timeout => 'default'} if opts.nil?
+    opts = {:driver => 'lan20', :timeout => 'default'} if opts.nil?
 
     # convert all keys to symbols for opts, we can't assume the user will use symbols
     opts.keys.each do |key|
@@ -94,7 +94,7 @@ module Rubyipmi
     end
 
     # Verify options just in case user passed in a incomplete hash
-    opts[:driver]  ||= 'auto'
+    opts[:driver]  ||= 'lan20'
     opts[:timeout] ||= 'default'
 
     if opts[:privilege] and not supported_privilege_type?(opts[:privilege])
@@ -189,7 +189,7 @@ module Rubyipmi
   end
 
   # gets data from the bmc device and puts in a hash for diagnostics
-  def self.get_diag(user, pass, host, opts={:driver => 'auto', :timeout => 'default'})
+  def self.get_diag(user, pass, host, opts={:driver => 'lan20', :timeout => 'default'})
     data = {}
     if Rubyipmi.is_provider_installed?('freeipmi')
       freeconn = Rubyipmi.connect(user, pass, host, 'freeipmi', opts)

data/rubyipmi.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rubyipmi 0.9.3 ruby lib
+# stub: rubyipmi 0.10.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rubyipmi"
-  s.version = "0.9.3"
+  s.version = "0.10.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

data/spec/unit/freeipmi/bmc-info_spec.rb

@@ -27,12 +27,12 @@ describe "Bmc" do
 
   it "cmd should be bmc-info with correct number of arguments" do
     @bmcinfo.retrieve
-    verify_freeipmi_command(@bmcinfo, 2, "#{@path}/bmc-info")
+    verify_freeipmi_command(@bmcinfo, 3, "#{@path}/bmc-info")
   end
 
   it "cmd should be bmc-info with correct number of arguments" do
     @bmcinfo.guid
-    verify_freeipmi_command(@bmcinfo, 3, "#{@path}/bmc-info")
+    verify_freeipmi_command(@bmcinfo, 4, "#{@path}/bmc-info")
   end
 
 end

data/spec/unit/freeipmi/connection_spec.rb

@@ -50,8 +50,9 @@ describe "Bmc" do
 
   end
 
-  it 'object should have driver set to auto if not specified' do
-    expect(@conn.options.has_key?('driver-type')).to eq false
+  it 'object should have driver set to lan20 if not specified' do
+    expect(@conn.options['driver-type']).to eq "LAN_2_0"
+
   end
 
   it 'object should have driver set to auto if not specified' do

data/spec/unit/freeipmi/fru_spec.rb

@@ -28,7 +28,7 @@ describe :Fru do
 
   it "cmd should be ipmi-fru with correct number of arguments" do
     @fru.list
-    verify_freeipmi_command(@fru, 2, "#{@path}/ipmi-fru")
+    verify_freeipmi_command(@fru, 3, "#{@path}/ipmi-fru")
   end
 
   it 'should list data' do

data/spec/unit/freeipmi/sensors_spec.rb

@@ -32,7 +32,7 @@ describe :Sensors do
 
  it "cmd should be ipmi-sensors with six arguments" do
     @sensors.list
-    verify_freeipmi_command(@sensors, 5, "#{@path}/ipmi-sensors")
+    verify_freeipmi_command(@sensors, 6, "#{@path}/ipmi-sensors")
  end
 
   it "can return a list of sensors" do

data/spec/unit/ipmitool/connection_spec.rb

@@ -51,7 +51,8 @@ describe :Connection do
   end
 
   it 'object should have driver set to auto if not specified' do
-    expect(@conn.options.has_key?('driver-type')).to eq false
+    expect(@conn.options['I']).to eq 'lanplus'
+
   end
 
   it 'object should have driver set to auto if not specified' do

data/spec/unit/ipmitool/fru_spec.rb

@@ -30,7 +30,7 @@ describe :Fru do
 
   it "cmd should be ipmi-sensors with correct number of arguments" do
     @fru.list
-    verify_ipmitool_command(@fru, 3, "#{@path}/ipmitool", 'fru')
+    verify_ipmitool_command(@fru, 4, "#{@path}/ipmitool", 'fru')
   end
 
   it 'should return a list of unparsed frus' do

data/spec/unit/ipmitool/lan_spec.rb

@@ -27,7 +27,7 @@ describe "Lan" do
 
   it "cmd should be lan with correct number of arguments" do
     @lan.info
-    verify_ipmitool_command(@lan, 3, "#{@path}/ipmitool", 'lan')
+    verify_ipmitool_command(@lan, 4, "#{@path}/ipmitool", 'lanplus')
   end
 
   it "can return a lan information" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyipmi
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.0
 platform: ruby
 authors:
 - Corey Osman