ruby-iscsiadm 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.0.1 / 2008-05-28
+
+* Initial release
+
+  * Birthday!
+  * Test release

data/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+Manifest.txt
+README.txt
+README_SUDO.txt
+Rakefile
+Todo.txt
+examples/example_session.rb
+examples/show_nodes.rb
+lib/iscsiadm.rb
+lib/iscsiadm/common.rb
+lib/iscsiadm/external.rb
+lib/iscsiadm/iscsiadm.rb
+lib/iscsiadm/node.rb
+lib/iscsiadm/portal.rb
+lib/iscsiadm/proc.rb
+lib/iscsiadm/session.rb
+test/test_iscsiadm.rb

data/README.txt

@@ -0,0 +1,51 @@
+= ruby-iscsiadm
+
+* http://ruby-iscsiadm.rubyforge.org
+* mailto:matt@bravenet.com
+
+== DESCRIPTION:
+
+This is a wrapper for the open-iscsi administration utility, iscsiadm. This is
+a simple binary wrapper and considered a temporary solution until a proper api
+is finished as per http://thread.gmane.org/gmane.linux.iscsi.open-iscsi/422
+
+== FEATURES/PROBLEMS:
+
+* Not finished, is that a problem?
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* popen4 
+
+== INSTALL:
+
+* sudo gem install ruby-iscsiadm 
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Matthew Kent, Bravenet Web Services Inc. 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README_SUDO.txt

@@ -0,0 +1,10 @@
+Want to run this without using root?
+
+1) Create an unprivileged user, preferably with the shell set to /sbin/nologin
+2) Add user to sudoers, eg:
+
+iscsidev ALL = NOPASSWD: /sbin/iscsiadm
+
+3) Pass sudo in with the binary, eg:
+
+Iscsiadm.new(:command => "/usr/bin/sudo /sbin/iscsiadm")

data/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'iscsiadm'
+
+Hoe.new('ruby-iscsiadm', IscsiadmWrapper::VERSION) do |p|
+  p.developer('Matthew Kent', 'matt@bravenet.com')
+  p.extra_deps << ['open4', '>= 0.9.6']
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/Todo.txt

@@ -0,0 +1,11 @@
+= to do
+
+== 0.1.0
+* don't bother wrapping complex operations, just provide a standard 
+  iscsiadm.raw('--login etc'), that traps errors to do work at this level for 
+  now.
+* proper handling of interfaces
+* implement session --stats
+* proper documentation
+* basic test suite
+* compatibility check and warning, pass flag to shutup

data/examples/example_session.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+
+$: << File.dirname(__FILE__) + "/../lib"
+
+require 'iscsiadm'
+
+iscsi = IscsiadmWrapper::Iscsiadm.new(:command => "/usr/bin/sudo /sbin/iscsiadm", :debug => true)
+
+iscsi.discover(:ip => "20.20.20.20").each do |n|
+  puts n 
+  if n.target =~ /shared.1/
+    p iscsi.show_record(:node => n, :name => 'node.session.auth.authmethod')
+    p iscsi.update_record(:node => n, :name => 'node.session.auth.authmethod', :value => 'CHAP')
+    p iscsi.update_record(:node => n, :name => 'node.session.auth.username', :value => 'shareddata')
+    p iscsi.update_record(:node => n, :name => 'node.session.auth.password', :value => 'xxx')
+    p iscsi.show_record(:node => n, :name => 'node.session.auth.authmethod')
+    p iscsi.login(:node => n)
+    p iscsi.logout(:node => n)
+    p iscsi.show_config(:node => n)
+  end
+end

data/examples/show_nodes.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+
+$: << File.dirname(__FILE__) + "/../lib"
+
+require 'iscsiadm'
+
+iscsi = IscsiadmWrapper::Iscsiadm.new(:command => "/usr/bin/sudo /sbin/iscsiadm")
+
+puts "nodes"
+iscsi.list_nodes.each do |n|
+  puts "- #{n.target}"
+end
+
+puts "\nsessions"
+iscsi.list_sessions.each do |n|
+  puts "- #{n.target}"
+end

data/lib/iscsiadm.rb

@@ -0,0 +1,294 @@
+# FIXME: proper rdoc summary here
+#
+# This is a wrapper for the open-iscsi administration utility, iscsiadm.
+#
+# Overview:
+#
+# The basic iscsiadm on disk is structure is
+#  - discovery (/var/lib/iscsi/send_targets on CentOS)
+#    portals which have been scanned
+#  - node (/var/lib/iscsi/send_targets on CentOS)
+#    settings records containing target,ip,and some params
+
+require 'iscsiadm/common'
+require 'iscsiadm/portal'
+require 'iscsiadm/node'
+require 'iscsiadm/session'
+
+module IscsiadmWrapper
+  VERSION = '0.0.1'
+  COMPAT_VERSION = '2.0-865'
+
+  class Iscsiadm
+    DEFAULT_COMMAND = '/sbin/iscsiadm'
+
+    DEFAULT_TYPE      = 'sendtargets'
+    DEFAULT_HOST      = 'localhost'
+    DEFAULT_PORT      = 3260
+    DEFAULT_INTERFACE = 1
+
+    COMMANDS = {
+      # misc
+      :version       => { :cmd => "%s --version", 
+                          :filter => %r{^iscsiadm version (.*)$} },
+      # discovery mode
+      :discover      => { :cmd => "%s --mode discovery --type %s --portal %s:%s", 
+                          :filter => %r{^.* (.*)$} },
+      :list_portals  => { :cmd => "%s --mode discovery", 
+                          :filter => %r{^(.*) via (.*)$} },
+      # node mode
+      :login         => { :cmd => "%s --mode node --target %s --portal %s --login", 
+                          :filter => %r{^iscsiadm version (.*)$} },
+      :logout        => { :cmd => "%s --mode node --target %s --portal %s --logout", 
+                          :filter => %r{^iscsiadm version (.*)$} },
+      :list_nodes    => { :cmd => "%s --mode node", 
+                          :filter => %r{^(.*) (.*)$} },
+      # session mode
+      :list_sessions => { :cmd => "%s --mode session", 
+                          :filter => %r{^tcp: \[(\d+)\] (.*) (.*)$} },
+      # config db
+      :show_config   => { :cmd => "%s --mode node --target %s --portal %s --op show", 
+                          :filter => %r{^(.*) = (.*)$} },
+      :new_record    => { :cmd => "%s --mode node --target %s --portal %s --op new --name %s --value %s", 
+                          :filter => %r{^(.*)$} },
+      :delete_record => { :cmd => "%s --mode node --target %s --portal %s --op delete --name %s", 
+                          :filter => %r{^(.*)$} },
+      :update_record => { :cmd => "%s --mode node --target %s --portal %s --op update --name %s --value %s", 
+                          :filter => %r{^(.*)$} },
+      # iscsiadm doesn't support this one really, see below
+      :show_record   => { :cmd => "%s --mode node --target %s --portal %s --op show --name %s", 
+                          :filter => %r{^.* = (.*)$} },
+    }
+
+    def initialize(args = {})
+      @command = args[:command] || DEFAULT_COMMAND
+      @use_unsupported_version = args[:use_unsupported_version] || false
+      @debug = args[:debug] || false
+
+      puts "Running in debug mode, outputting commands to stdout." if @debug
+    end
+
+    def refresh_all
+      refresh_sessions
+      refresh_nodes
+      refresh_portals
+    end
+    def refresh_sessions; @sessions = list_sessions; end
+    def refresh_nodes;    @nodes    = list_nodes; end
+    def refresh_portals;  @portals  = list_portals; end
+    def sessions; refresh_sessions; @sessions; end
+    def nodes; refresh_nodes; @nodes; end
+    def portals; refresh_portals; @portals; end
+
+    def session(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+
+      refresh_sessions
+
+      @sessions.each do |s|
+        return s if s.target == target && s.portal == portal
+      end
+    end
+    def session_established?(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+
+      refresh_sessions
+
+      @sessions.each do |s|
+        return true if s.target == target && s.portal == portal
+      end
+      false
+    end
+
+    # Query iscsiadm version, returning resulting String
+    def version
+      Common::callout(
+        COMMANDS[:version][:cmd] % @command, 
+        COMMANDS[:version][:filter]).to_s
+    end
+
+    # Discovery Mode
+    #
+
+    # Runs iscsi discovery against a target portal, returing resulting Array of
+    # Node objects.
+    def discover(args = {})
+      type = args[:type] || DEFAULT_TYPE 
+      ip = args[:ip] || DEFAULT_HOST 
+      port = args[:port] || DEFAULT_PORT
+      interface = args[:interface] || DEFAULT_INTERFACE
+
+      Common::callout(
+        COMMANDS[:discover][:cmd] % [@command, type, ip, port], 
+        COMMANDS[:discover][:filter], @debug)
+
+      refresh_portals
+      refresh_nodes
+
+      list_nodes("#{ip}:#{port},#{interface}")
+    end
+
+    # Get list of portals, returning resulting Array of Portal objects.
+    def list_portals
+      ret = []
+
+      Common::callout(
+        COMMANDS[:list_portals][:cmd] % [@command], 
+        COMMANDS[:list_portals][:filter], @debug) do |p,t|
+
+        ret << Portal.parse(p,t)
+      end
+
+      ret
+    end
+
+    # Node Mode
+    #
+
+    # Attempt to login to a given node and portal, returning resulting Session
+    # if successful.
+    def login(args = {}) 
+      target = args[:node].target
+      portal = args[:node].portal
+
+      Common::callout(
+        COMMANDS[:login][:cmd] % [@command, target, portal], 
+        COMMANDS[:login][:filter], @debug)
+
+      session(args)
+    end
+
+    # Logout of a given node and portal, returning resulting Array of remaining
+    # Sessions.
+    def logout(args = {}) 
+      target = args[:node].target
+      portal = args[:node].portal
+
+      Common::callout(
+        COMMANDS[:logout][:cmd] % [@command, target, portal], 
+        COMMANDS[:logout][:filter], @debug)
+
+      refresh_sessions
+    end
+
+    # Get list of nodes, returning resulting Array of Node objects.
+    def list_nodes(args = {})
+      portal = args[:portal]
+      ret = [] 
+
+      Common::callout(
+        COMMANDS[:list_nodes][:cmd] % [@command], 
+        COMMANDS[:list_nodes][:filter], @debug) do |p,t|
+  
+        next if portal.nil? == false and portal != p
+
+        ret << Node.new(:portal => p, :target => t)
+      end
+
+      ret
+    end
+
+    # Session Mode
+    #
+
+    # Get list of sessions, returning resulting Array of Session objects.
+    def list_sessions(args = {})
+      portal = args[:portal]
+      ret = []
+
+      Common::callout(
+        COMMANDS[:list_sessions][:cmd] % [@command], 
+        COMMANDS[:list_sessions][:filter], @debug) do |r,p,t|
+  
+        next if portal.nil? == false and portal != p
+
+        ret << Session.new(:portal => p, :target => t, :id => r)
+      end
+
+      ret
+    end
+ 
+    # Node Config Mode
+    #
+
+    # Get configuration for a given node and portal, returning resulting Hash of
+    # record values.
+    def show_config(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+
+      conf = {}
+
+      Common::callout(
+        COMMANDS[:show_config][:cmd] % [@command, target, portal], 
+        COMMANDS[:show_config][:filter], @debug) do |k,v|
+
+        # easier to deal with nil
+        conf[k] = (v == '<empty>' ? nil : v)
+      end
+
+      conf
+    end
+
+    # Delete a named config entry for a given target
+    # Returns ?
+    # 
+    # Should not be used on a running session so says the man page.
+    def delete_record(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+      name = args[:name]
+
+      Common::callout(
+        COMMANDS[:delete_record][:cmd] % [@command, target, portal, name], 
+        COMMANDS[:delete_record][:filter], @debug)
+    end
+    
+    # Create a new config entry for a given target
+    # Returns ?
+    #
+    # Why would you want to create new records again..?
+    def new_record(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+      name = args[:name]
+      value = args[:value]
+
+      Common::callout(
+        COMMANDS[:new_record][:cmd] % [@command, target, portal, name, value], 
+        COMMANDS[:new_record][:filter], @debug)
+    end
+    
+    # Update a named config entry for a given target
+    # Returns ?
+    #
+    def update_record(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+      name = args[:name]
+      value = args[:value]
+
+      Common::callout(
+        COMMANDS[:update_record][:cmd] % [@command, target, portal, name, value], 
+        COMMANDS[:update_record][:filter], @debug)
+    end
+
+    # Takes a Node object and entry name as args.
+    #
+    # Returns String.
+    #
+    def show_record(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+      name = args[:name]
+
+      # iscsiadm doesn't support show by specific name, fake it
+      Common::callout(
+        COMMANDS[:show_record][:cmd] % [@command, target, portal, name], 
+        %r{#{name} = (.*)$}, @debug)
+    end
+
+  end # class
+end # module

data/lib/iscsiadm/common.rb

@@ -0,0 +1,42 @@
+require 'iscsiadm/external'
+
+module IscsiadmWrapper
+  class Common
+
+    class<<self
+      # Convert match data to array, dropping the match all.
+      # Returns an array of matches.
+      # 
+      def parse(line, filter) #:nodoc:
+        match = filter.match(line).to_a
+        match.shift
+        match
+      end
+     
+      # Invoke an external program, passing each line of returned output through
+      # our filter.
+      #
+      # Yield each all matches per line in block or return an array of all matches on every line.
+      #
+      def callout(cmd, filter, debug=false) #:nodoc:
+        puts "Executing `#{cmd}`" if debug
+
+        ret = []
+        External::cmd(cmd) do |line|
+          match = parse(line, filter)
+          match.each do |t|
+            ret << t 
+          end
+          if defined? yield
+            yield ret
+            ret.clear
+          end
+        end
+
+        ret
+      end
+
+    end # self
+ 
+  end # class
+end # module 

data/lib/iscsiadm/external.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'open4'
+
+module IscsiadmWrapper 
+  class External
+    class ExternalFailure < RuntimeError; end 
+
+     class<<self
+      # Execute a command, returning the resulting String of standard output.
+      #
+      # The block is optional. If given, it will be invoked for each line of
+      # output.
+      def cmd(cmd)
+        output = []
+        error = nil
+        stat = Open4::popen4(cmd) do |pid, stdin, stdout, stderr|
+          while line = stdout.gets
+            output << line 
+          end
+          error = stderr.read.strip
+        end
+        if stat.exited?
+          if stat.exitstatus > 0
+            raise ExternalFailure, "Fatal error, `#{cmd}` returned #{stat.exitstatus} with '#{error}'"
+          end
+        elsif stat.signaled?
+          raise ExternalFailure, "Fatal error, `#{cmd}` got signal #{stat.termsig} and terminated"
+        elsif stat.stopped?
+          raise ExternalFailure, "Fatal error, `#{cmd}` got signal #{stat.stopsig} and is stopped"
+        end
+
+        if block_given?
+          return output.each { |l| yield l }
+        else 
+          return output.join
+        end
+      end
+    end
+
+  end # class
+end # module

data/lib/iscsiadm/iscsiadm.rb

@@ -0,0 +1,309 @@
+module IscsiadmWrapper
+  # This is a wrapper for the open-iscsi administration utility, iscsiadm.
+  #
+  # Overview:
+  #
+  # The basic iscsiadm on disk is structure is
+  #  - discovery (/var/lib/iscsi/send_targets on CentOS)
+  #    portals which have been scanned
+  #  - node (/var/lib/iscsi/send_targets on CentOS)
+  #    settings records containing target,ip,and some params
+
+  require 'iscsiadm/common'
+  require 'iscsiadm/portal'
+  require 'iscsiadm/node'
+  require 'iscsiadm/session'
+
+  class Iscsiadm
+    COMPAT_VERSION = '2.0-865'
+    DEFAULT_BINARY = '/sbin/iscsiadm'
+
+    DEFAULT_TYPE      = 'sendtargets'
+    DEFAULT_HOST      = 'localhost'
+    DEFAULT_PORT      = 3260
+    DEFAULT_INTERFACE = 1
+
+    COMMANDS = {
+      # misc
+      :version       => { :cmd => "%s --version", 
+                          :filter => %r{^iscsiadm version (.*)$} },
+      # discovery mode
+      :discover      => { :cmd => "%s --mode discovery --type %s --portal %s:%s", 
+                          :filter => %r{^.* (.*)$} },
+      :list_portals  => { :cmd => "%s --mode discovery", 
+                          :filter => %r{^(.*) via (.*)$} },
+      # node mode
+      :login         => { :cmd => "%s --mode node --target %s --portal %s --login", 
+                          :filter => %r{^iscsiadm version (.*)$} },
+      :logout        => { :cmd => "%s --mode node --target %s --portal %s --logout", 
+                          :filter => %r{^iscsiadm version (.*)$} },
+      :list_nodes    => { :cmd => "%s --mode node", 
+                          :filter => %r{^(.*) (.*)$} },
+      # session mode
+      :list_sessions => { :cmd => "%s --mode session", 
+                          :filter => %r{^tcp: \[(\d+)\] (.*) (.*)$} },
+      # config db
+      :show_config   => { :cmd => "%s --mode node --target %s --portal %s --op show", 
+                          :filter => %r{^(.*) = (.*)$} },
+      :new_record    => { :cmd => "%s --mode node --target %s --portal %s --op new --name %s --value %s", 
+                          :filter => %r{^(.*)$} },
+      :delete_record => { :cmd => "%s --mode node --target %s --portal %s --op delete --name %s", 
+                          :filter => %r{^(.*)$} },
+      :update_record => { :cmd => "%s --mode node --target %s --portal %s --op update --name %s --value %s", 
+                          :filter => %r{^(.*)$} },
+      # iscsiadm doesn't support this one really, see below
+      :show_record   => { :cmd => "%s --mode node --target %s --portal %s --op show --name %s", 
+                          :filter => %r{^.* = (.*)$} },
+    }
+
+    # Class Methods
+    #
+    class<<self  
+    end
+
+    # Instance Methods
+    #
+    def initialize(args = {})
+      @iscsiadm_binary = args[:iscsiadm_binary] || DEFAULT_BINARY[:iscsiadm]
+      @use_unsupported_version = args[:use_unsupported_version] || false
+      @debug = args[:debug] || false
+
+      puts "Running in debug mode, outputting commands to stdout." if @debug
+    end
+
+    # Misc
+    #
+    
+    def refresh_all
+      refresh_sessions
+      refresh_nodes
+      refresh_portals
+    end
+    def refresh_sessions; @sessions = list_sessions; end
+    def refresh_nodes;    @nodes    = list_nodes; end
+    def refresh_portals;  @portals  = list_portals; end
+    def sessions; refresh_sessions; @sessions; end
+    def nodes; refresh_nodes; @nodes; end
+    def portals; refresh_portals; @portals; end
+
+    def session(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+
+      refresh_sessions
+
+      @sessions.each do |s|
+        return s if s.target == target && s.portal == portal
+      end
+    end
+    def session_established?(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+
+      refresh_sessions
+
+      @sessions.each do |s|
+        return true if s.target == target && s.portal == portal
+      end
+      false
+    end
+
+    # Returns iscsiadm's version
+    #
+    def version
+      Common::callout(
+        COMMANDS[:version][:cmd] % @iscsiadm_binary, 
+        COMMANDS[:version][:filter]).to_s
+    end
+
+    # Discovery Mode
+    #
+
+    # Runs iscsi discovery against a target portal
+    # Returns nodes.
+    #
+    def discover(args = {})
+      type = args[:type] || DEFAULT_TYPE 
+      ip = args[:ip] || DEFAULT_HOST 
+      port = args[:port] || DEFAULT_PORT
+      interface = args[:interface] || DEFAULT_INTERFACE
+
+      Common::callout(
+        COMMANDS[:discover][:cmd] % [@iscsiadm_binary, type, ip, port], 
+        COMMANDS[:discover][:filter], @debug)
+
+      refresh_portals
+      refresh_nodes
+
+      list_nodes("#{ip}:#{port},#{interface}")
+    end
+
+    # Returns an array of portal objects.
+    #
+    def list_portals
+      ret = []
+
+      Common::callout(
+        COMMANDS[:list_portals][:cmd] % [@iscsiadm_binary], 
+        COMMANDS[:list_portals][:filter], @debug) do |p,t|
+
+        ret << Portal.parse(p,t)
+      end
+
+      ret
+    end
+
+    # Node Mode
+    #
+
+    # Attempt to login to a given node.
+    # Returns session 
+    #
+    def login(args = {}) 
+      target = args[:node].target
+      portal = args[:node].portal
+
+      Common::callout(
+        COMMANDS[:login][:cmd] % [@iscsiadm_binary, target, portal], 
+        COMMANDS[:login][:filter], @debug)
+
+      session(args)
+    end
+
+    # Attempt to login to a given node.
+    # Returns ?
+    # 
+    def logout(args = {}) 
+      target = args[:node].target
+      portal = args[:node].portal
+
+      Common::callout(
+        COMMANDS[:logout][:cmd] % [@iscsiadm_binary, target, portal], 
+        COMMANDS[:logout][:filter], @debug)
+
+      refresh_sessions
+    end
+
+    # Returns an array of Node objects. Return all by
+    # default
+    #
+    def list_nodes(args = {})
+      portal = args[:portal]
+      ret = [] 
+
+      Common::callout(
+        COMMANDS[:list_nodes][:cmd] % [@iscsiadm_binary], 
+        COMMANDS[:list_nodes][:filter], @debug) do |p,t|
+  
+        next if portal.nil? == false and portal != p
+
+        ret << Node.new(:portal => p, :target => t)
+      end
+
+      ret
+    end
+
+    # Session Mode
+    #
+
+    # Returns an array of Session objects. Return all by
+    # default.
+    #
+    def list_sessions(args = {})
+      portal = args[:portal]
+      ret = []
+
+      Common::callout(
+        COMMANDS[:list_sessions][:cmd] % [@iscsiadm_binary], 
+        COMMANDS[:list_sessions][:filter], @debug) do |r,p,t|
+  
+        next if portal.nil? == false and portal != p
+
+        ret << Session.new(:portal => p, :target => t, :id => r)
+      end
+
+      ret
+    end
+ 
+    # Node Config Mode
+    #
+
+    # Returns a hash of all config key => value pairs for a given target
+    #
+    def show_config(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+
+      conf = {}
+
+      Common::callout(
+        COMMANDS[:show_config][:cmd] % [@iscsiadm_binary, target, portal], 
+        COMMANDS[:show_config][:filter], @debug) do |k,v|
+
+        # easier to deal with nil
+        conf[k] = (v == '<empty>' ? nil : v)
+      end
+
+      conf
+    end
+
+    # Delete a named config entry for a given target
+    # Returns ?
+    # 
+    # Should not be used on a running session so says the man page.
+    def delete_record(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+      name = args[:name]
+
+      Common::callout(
+        COMMANDS[:delete_record][:cmd] % [@iscsiadm_binary, target, portal, name], 
+        COMMANDS[:delete_record][:filter], @debug)
+    end
+    
+    # Create a new config entry for a given target
+    # Returns ?
+    #
+    # Why would you want to create new records again..?
+    def new_record(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+      name = args[:name]
+      value = args[:value]
+
+      Common::callout(
+        COMMANDS[:new_record][:cmd] % [@iscsiadm_binary, target, portal, name, value], 
+        COMMANDS[:new_record][:filter], @debug)
+    end
+    
+    # Update a named config entry for a given target
+    # Returns ?
+    #
+    def update_record(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+      name = args[:name]
+      value = args[:value]
+
+      Common::callout(
+        COMMANDS[:update_record][:cmd] % [@iscsiadm_binary, target, portal, name, value], 
+        COMMANDS[:update_record][:filter], @debug)
+    end
+
+    # Takes a Node object and entry name as args.
+    #
+    # Returns String.
+    #
+    def show_record(args = {})
+      target = args[:node].target
+      portal = args[:node].portal
+      name = args[:name]
+
+      # iscsiadm doesn't support show by specific name, fake it
+      Common::callout(
+        COMMANDS[:show_record][:cmd] % [@iscsiadm_binary, target, portal, name], 
+        %r{#{name} = (.*)$}, @debug)
+    end
+
+  end
+end

data/lib/iscsiadm/node.rb

@@ -0,0 +1,14 @@
+require 'iscsiadm/common'
+require 'iscsiadm/portal'
+
+module IscsiadmWrapper
+  class Node 
+    attr_reader :portal, :target
+
+    def initialize(args = {})
+      @portal = Portal.parse(args[:portal])
+      @target = args[:target]
+    end
+
+  end # class
+end # module

data/lib/iscsiadm/portal.rb

@@ -0,0 +1,39 @@
+require 'iscsiadm/common'
+
+module IscsiadmWrapper
+  class Portal
+    attr_reader :ip, :port, :interface, :type
+
+    DEFAULT_TYPE = 'sendtargets'
+
+    # Class Methods
+    #
+    class<<self
+      # Takes the typical portal string from iscsiadm and the type and returns a
+      # new Portal object.
+      #
+      # eg Portal.parse('20.20.20.20:3260,1','sendtargets')
+      #
+      # XXX: whats the trailing ,1 again..?
+      def parse(portal,type=DEFAULT_TYPE)
+        if portal =~ %r{^(.*):(\d+),?(\d+)?$}
+          return Portal.new(:ip => $1, :port => $2, :interface => $3, :type => type)
+        end
+      end
+    end
+
+    # Instance Methods
+    #
+    def initialize(args = {})
+      @ip = args[:ip] 
+      @port = args[:port]
+      @interface = args[:interface]
+      @type = args[:type]
+    end
+
+    def to_s
+      "#{@ip}:#{@port},#{@interface}"
+    end 
+
+  end # class 
+end # module 

data/lib/iscsiadm/proc.rb

@@ -0,0 +1,38 @@
+module IscsiadmWrapper
+  class Proc 
+
+    class ExternalFailure < RuntimeError; end 
+
+    class<<self
+      # Return output of external command
+      # Yield each line or return entire output
+      #
+      def external(cmd) #:nodoc:
+        output = []
+        IO.popen(cmd, "r") do |p|
+          while line = p.gets
+            if defined? yield 
+              yield line
+            else
+              output << line 
+            end
+          end
+        end
+        stat = $?
+        if stat.exited?
+          if stat.exitstatus > 0
+            raise ExternalFailure, "Fatal error, `#{cmd}` returned #{stat.exitstatus}"
+          end
+        elsif stat.signaled?
+          raise ExternalFailure, "Fatal error, `#{cmd}` got signal #{stat.termsig} and terminated"
+        elsif stat.stopped?
+          raise ExternalFailure, "Fatal error, `#{cmd}` got signal #{stat.stopsig} and is stopped"
+        else
+          output.join
+        end
+      end
+
+    end # self
+
+  end # class
+end # module

data/lib/iscsiadm/session.rb

@@ -0,0 +1,14 @@
+require 'iscsiadm/common'
+require 'iscsiadm/node'
+
+module IscsiadmWrapper
+  class Session < Node
+    attr_reader :id
+
+    def initialize(args = {})
+      super
+      @id = args[:id]
+    end
+
+  end # class
+end # module

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: ruby-iscsiadm
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2008-05-30 00:00:00 -07:00
+summary: This is a wrapper for the open-iscsi administration utility, iscsiadm
+require_paths: 
+- lib
+email: 
+- matt@bravenet.com
+homepage: http://ruby-iscsiadm.rubyforge.org
+rubyforge_project: ruby-iscsiadm
+description: This is a wrapper for the open-iscsi administration utility, iscsiadm. This is a simple binary wrapper and considered a temporary solution until a proper api is finished as per http://thread.gmane.org/gmane.linux.iscsi.open-iscsi/422
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMDCCAhigAwIBAgIBADANBgkqhkiG9w0BAQUFADA+MQ0wCwYDVQQDDARtYXR0
+  MRgwFgYKCZImiZPyLGQBGRYIYnJhdmVuZXQxEzARBgoJkiaJk/IsZAEZFgNjb20w
+  HhcNMDgwNTI5MjM1MDUwWhcNMDkwNTI5MjM1MDUwWjA+MQ0wCwYDVQQDDARtYXR0
+  MRgwFgYKCZImiZPyLGQBGRYIYnJhdmVuZXQxEzARBgoJkiaJk/IsZAEZFgNjb20w
+  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDDGVrJnpk6/hCO5lg6T7As
+  unEksqdmCly6GkRpX0cVxusWG/wbjrZw4Ka5x9pSS2m3GfefEpu5CuWH9wnGB/q0
+  LwbWhrkpQb+uNVD6hEbQcngDEiQbiitaSWZKSvrIymbM5Tl92rIScmvx7Pd7l8tz
+  BLndL/DmrBHrHWQ47xLxOmBAA4NJy0gk7HdsdAFfJwrEoC14AAXqcI3X0qU3KGrr
+  9Fs0jVeIKktx3fthwGVPrpYrMIw3xgiUqOqn7M+V4soD013dopaN7orewmCm9dQL
+  4N06FMnGNjwFaS6+MV612nk8gkVpJwgcwTHE1GNt2NItR5zeK6j+AZ01DijYdjH9
+  AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQ6jcdN
+  QqNNsx2XxigfTWE0Owy0XzANBgkqhkiG9w0BAQUFAAOCAQEAvWBkYaD7eKP+KHxJ
+  dtQuaebQTZvBX4vjk/Omjn7hj7u8X8aTvmCKyopnmywiApFH1zgDa8NRc1KTsvZt
+  zhSRWIuI7fFB+JFZUatE7Nius56id9UchYO98569t6bNU284XwBtcj4MN5Andfcp
+  LKdUNuuT0yui1InJG4fD0uKnOS1qcXEm+mN2s1uqPGVltEHorG7L/bPNAw8xV+uq
+  NPc7hhQTkbi7HB2Uwxr9uK9IGHEE5tDVnsPWPnJJ4jSOc7Bd1eHZuSMkEPfyREDf
+  h9ljoX3AGXW8qYohFzGjflamaWZ4xYaKZSNqS2i0Kc+M76Sy+r9FldDRNn4FGUBE
+  JqYgHg==
+  -----END CERTIFICATE-----
+
+post_install_message: 
+authors: 
+- Matthew Kent
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- README_SUDO.txt
+- Rakefile
+- Todo.txt
+- examples/example_session.rb
+- examples/show_nodes.rb
+- lib/iscsiadm.rb
+- lib/iscsiadm/common.rb
+- lib/iscsiadm/external.rb
+- lib/iscsiadm/iscsiadm.rb
+- lib/iscsiadm/node.rb
+- lib/iscsiadm/portal.rb
+- lib/iscsiadm/proc.rb
+- lib/iscsiadm/session.rb
+- test/test_iscsiadm.rb
+test_files: 
+- test/test_iscsiadm.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- README_SUDO.txt
+- Todo.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.3
+    version: 

metadata.gz.sig

@@ -0,0 +1,2 @@
+��RN����d�ʄ�Z+VBbY�~�P��ZH�z��W$]Ҏ�7R���E/p4�ў%����5by�zdp�F@3���4�^r
d���_�f�v��"�5�
+��âA�*=Yɭ���ƌb�I��
a
�T��U���ϐ�)�����#>�Kg���X��(!���uպ�F�=���