wbem 0.3.0 → 0.5.0

data/lib/wbem/wsman_instance.rb

@@ -0,0 +1,148 @@
+
+module WsmanInstance
+
+  require "wbem/wbem"
+  require "openwsman"
+  require "cim"
+    #
+    # Class constructor
+    #   client - client instance, used for method invocation
+    #            either a Wbem::CimxmlClient
+    #            or a Wbem::WsmanClient
+    #
+    #   instance_ref - instance reference
+    #                  either ObjectPath (Wbem::CimxmlClient) or
+    #                  EndPointReference (Wbem::WsmanClient)
+    #
+    #   instance_data - instance data
+    #                   Wbem::WsmanClient: Openwsman::XmlNode
+    #                   Wbem::CimxmlClient: nil (instance_ref has all information)
+    #
+    def wsman_initialize client, epr_or_uri, node
+#      STDERR.puts "Wbem::WsmanInstance.new epr_or_uri #{epr_or_uri}"
+      @node = node.body.child rescue node
+#      STDERR.puts "Wsman::Instance.new @node #{@node.class}"
+      @epr = (epr_or_uri.is_a? Openwsman::EndPointReference) ? epr_or_uri : Openwsman::EndPointReference.new(epr_or_uri) if epr_or_uri
+      @client = client
+    end
+    def classname
+      @epr.classname
+    end
+    #
+    # attribute iterator
+    #
+    def attributes
+      @node.each do |node|
+#        STDERR.puts "Wsman::Instance #{node}"
+        yield [ node.name, node.text ]
+      end
+    end
+    #
+    # access attribute by name
+    #
+    def [] name
+      name = name.to_s
+      node = @node.find(nil, name) rescue nil
+      return nil unless node
+      begin
+        type = _typemap()[name]
+      rescue
+        raise "Property #{name} of #{self.class} has unknown type"
+      end
+#      puts "#{self.class}[#{name}]: #{node.name}<#{type.inspect}>"
+      Wbem::Conversion.to_ruby type, node
+    end
+    #
+    # to_s - stringify
+    #
+    def to_s
+      s = "#{@epr.classname}\n"
+      @node.each do |child|
+        s << "\t" << child.name << ": " 
+        v = self[child.name]
+        s << v.to_s if v
+        s << "\n"
+      end
+      s
+    end
+    #
+    # Instance#invoke
+    #   name => String
+    #   type => [ :uint32, 
+    #             [ "RequestedState", :uint16, :in ],
+    #             [ "Job", :class, :out ],
+    #             [ "TimeoutPeriod", :dateTime, :in ],
+    #           ]
+    #   args => Array
+    #
+    def invoke name, type, args
+#      STDERR.puts "#{__FILE__}: #{self.class}#invoke #{name}<#{type}>(#{args.inspect})"
+      result_type = type.shift
+      argsin = {}
+      argsout = {}
+      loop do
+        break if args.empty?
+        if type.empty?
+          raise "Excess argument '#{args.shift}' at pos #{argsin.size + argsout.size + 1} in call to #{self.class}.#{name}"
+        end
+        argname, argtype, direction = type.shift
+        value = args.shift
+        case direction
+        when :in
+          argsin[argname] = Wbem::Conversion.from_ruby( argtype, value )
+        when :out
+          unless value.nil? || value.is_a?(:symbol)
+            raise "Argument '#{argname}' of #{self.class}.#{name} is 'out', pass nil to symbol instead of value"
+          end
+          argsout[argname] = value
+        else
+          raise "Arg #{argname} of #{self.class}.#{name} has bad direction #{direction.inspect}"
+        end
+      end
+      STDERR.puts "\tproperties #{argsin.inspect}" if Wbem.debug
+      STDERR.puts "\targsout #{argsout.inspect}" if Wbem.debug
+      options = Openwsman::ClientOptions.new
+      options.set_dump_request if Wbem.debug
+      options.properties = argsin
+      @epr.each do |k,v|
+        options.add_selector( k, v )
+      end
+      STDERR.puts "\tinvoke" if Wbem.debug
+      res = @client.client.invoke(options, @epr.resource_uri, name.to_s)
+      raise "Invoke failed with: #{@client.fault_string}" unless res
+      raise Openwsman::Exception.new(res) if res.fault?
+      STDERR.puts "\n\tresult #{res.to_xml}\n" if Wbem.debug
+      result = res.find(uri, "#{name}_OUTPUT").find(uri, "ReturnValue").text
+      Wbem::Conversion.to_ruby result_type, result
+    end
+  
+    #
+    # method_missing
+    #   needs to be here to access TYPEMAP
+    #
+    def method_missing name, *args
+#      STDERR.puts "Wbem::WsmanInstance.method_missing #{name}"
+      # http://stackoverflow.com/questions/8960685/ruby-why-does-puts-call-to-ary
+      raise NoMethodError if name == :to_ary
+      name = name.to_s
+      assign = false
+      if name[-1,1] == '=' # assignment
+        name = name[0...-1]
+        assign = true
+      end
+      type = _typemap[name]
+      if type.is_a? Array
+        invoke(name, type, args)
+      else
+        return nil unless type # unknown property
+        if assign
+          # property assignment
+          self[name] = Wbem::Conversion.from_ruby type, args[0]
+        else
+          # property read
+          value = self[name]
+          Wbem::Conversion.to_ruby type, value
+        end
+      end
+    end # method_missing
+end # module WsmanInstance

data/samples/amt.rb

@@ -0,0 +1,129 @@
+#
+# Managed iAMT
+#   SOL (serial-over-lan)
+# https://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide/WordDocuments/enablingthesolinterface.htm
+#   KVM (keyboard-video-moust)
+# https://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide/WordDocuments/kvmconfiguration.htm
+#
+# Written by Klaus Kämpf 2015
+#
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'wbem'
+
+def usage msg = nil
+  if msg
+    STDERR.puts "** Err: #{msg}"
+    STDERR.puts "amt [-d] {sol|kvm} {start|stop} <uri>"
+    exit 1
+  end
+end
+
+def connect url
+  usage "<url> missing" unless url
+  return Wbem::Client.connect url, :wsman
+end
+
+def enable_listener instance
+  unless instance.ListenerEnabled
+    instance.ListenerEnabled = true
+    instance.put
+  end
+end
+
+def sol_start client
+  instance = client.get "AMT_RedirectionService", "Name" => "Intel(r) AMT Redirection Service"
+  case instance.EnabledState
+  when 32770
+    puts "SOL is enabled and IDE-R is disabled"
+  when 32771
+    puts "SOL and IDE-R are enabled"
+  when 32768
+    # SOL and IDE-R are disabled
+    puts "Enabling SOL"
+    instance.RequestStateChange(32770)
+  when 32769
+    # SOL is disabled and IDE-R is enabled
+    puts "Enabling SOL"
+    instance.RequestStateChange(32771)
+  end
+end
+
+def sol_stop client
+  instance = client.get "AMT_RedirectionService", "Name" => "Intel(r) AMT Redirection Service"
+  case instance.EnabledState
+  when 32770
+    # SOL is enabled and IDE-R is disabled
+    puts "Disabling SOL"
+    instance.RequestStateChange(32768)
+  when 32771
+    # SOL and IDE-R are enabled
+    puts "Disabling SOL"
+    instance.RequestStateChange(32769)
+  when 32768
+    puts "SOL and IDE-R are disabled"
+  when 32769
+    puts "SOL is disabled and IDE-R is enabled"
+  end
+end
+
+def kvm_start client
+  sap = client.get "CIM_KVMRedirectionSAP", "Name" => "KVM Redirection Service Access Point"
+  unless sap.EnabledState
+    data = client.get "IPS_KVMRedirectionSettingData", "InstanceID" => "Intel(r) KVM Redirection Settings"
+    if data.EnabledByMEBx
+      result = sap.RequestStateChange(2)
+      if result == 0
+        # enable listener
+      else
+      end
+    end
+  else
+    puts "KVM already enabled"
+  end
+end
+
+def kvm_stop client
+  sap = client.get "CIM_KVMRedirectionSAP", "Name" => "KVM Redirection Service Access Point"
+  if sap.EnabledState
+    data = client.get "IPS_KVMRedirectionSettingData", "InstanceID" => "Intel(r) KVM Redirection Settings"
+    if data.EnabledByMEBx
+      result = sap.RequestStateChange(3)
+      if result == 0
+        # disable listener
+      else
+      end
+    end
+  else
+    puts "KVM already disabled"
+  end
+end
+
+# ---------------------------------------------------------
+target = nil
+loop do
+  target = ARGV.shift
+  break unless target && target[0,1] == '-'
+  case target[1..-1]
+  when 'd'
+    Wbem.debug = 99
+  else
+    usage "Unknown option '#{target}'"
+  end
+end
+
+cmd = ARGV.shift
+url = ARGV.shift
+
+case [target, cmd]
+when ["sol", "start"]
+  sol_start( connect(url) )
+when ["sol", "stop"]
+  sol_stop( connect(url) )
+when ["kvm", "start"]
+  kvm_start( connect(url) )
+when ["kvm", "stop"]
+  kvm_stop( connect(url) )
+else
+  usage "Unknown command: #{target.inspect} #{cmd.inspect}"
+end

data/samples/enum.rb

@@ -0,0 +1,34 @@
+#
+# ruby-wbem sample code
+#
+# Enumerate instances
+#
+# Written by Klaus Kämpf 2015
+#
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'wbem'
+
+def usage msg = nil
+  if msg
+    STDERR.puts "** Err: #{msg}"
+    exit 1
+  end
+end
+
+def connect url
+  usage "<url> missing" unless url
+  return Wbem::Client.connect url
+end
+
+url = ARGV.shift
+if url == "-d"
+  Wbem.debug = -1
+  url = ARGV.shift
+end
+client = connect url
+eprs = client.instance_names nil, ARGV.shift
+eprs.each do |epr|
+  instance = client.get(epr)
+  puts "#{instance.class}: #{instance}\n"
+end

data/samples/get.rb

@@ -0,0 +1,47 @@
+#
+# ruby-wbem sample code
+#
+# Get instance
+#
+# Written by Klaus Kämpf 2015
+#
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'wbem'
+
+def usage msg = nil
+  if msg
+    STDERR.puts "** Err: #{msg}"
+    STDERR.puts "Usage:"
+    STDERR.puts "get [-d] <url> <class> <key>=<value> [<key>=<value> ...]"
+    exit 1
+  end
+end
+
+def connect url
+  usage "<url> missing" unless url
+  return Wbem::Client.connect url
+end
+
+url = ARGV.shift
+if url == "-d"
+  Wbem.debug = -1
+  url = ARGV.shift
+end
+usage "<url> missing" unless url
+klass = ARGV.shift
+usage "<class> missing" unless klass
+args = {}
+while arg = ARGV.shift
+  k,v = arg.split("=")
+  usage "Bad <key>=<value> pair" unless k && v
+  args[k] = v
+end
+usage "needs at least one <key>=<value> pair" if args.empty?
+client = connect url
+instance = client.get klass, args
+if instance
+  puts "#{instance.class}: #{instance}\n"
+else
+  puts "Not found"
+end

data/tasks/clean.rake

@@ -0,0 +1,2 @@
+require 'rake/clean'
+CLEAN.include("**/*~", "Gemfile.lock", "doc", ".yardoc", "pkg" )

data/tasks/doc.rake

@@ -0,0 +1,15 @@
+begin
+ require 'yard'
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['--no-private']
+  end
+rescue LoadError
+  STDERR.puts "Install yard if you want prettier docs"
+  require 'rdoc/task'
+  require 'wbem/version'
+  Rake::RDocTask.new(:doc) do |rdoc|
+    rdoc.rdoc_dir = "doc"
+    rdoc.title = "wbem #{Wbem::VERSION}"
+  end
+end

data/tasks/test.rake

@@ -0,0 +1,6 @@
+Rake::TestTask.new do |t|
+  t.libs << File.expand_path('../test', __FILE__)
+  t.libs << File.expand_path('../', __FILE__)
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require 'rubygems'
+$: << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))

data/test/test_class_factory.rb

@@ -0,0 +1,25 @@
+DIR = File.dirname(__FILE__)
+$: << DIR
+require 'helper'
+require 'wbem'
+
+class TestClassFactory < Test::Unit::TestCase
+  def setup
+    @factory = Wbem::ClassFactory.new File.join(DIR, "wbem")
+  end
+  #def teardown
+  #end
+  def test_initialize
+    assert @factory
+  end
+  def test_create_cim
+    klass = @factory.gen_class "CIM_ManagedElement"
+    assert klass
+    assert klass.new(nil,nil).is_a? Wbem::CIM_ManagedElement
+  end
+  def test_create_ips
+    klass = @factory.gen_class "IPS_KVMRedirectionSettingData"
+    assert klass
+    assert klass.new(nil,nil).is_a? Wbem::IPS_KVMRedirectionSettingData
+  end
+end

data/test/test_classnames.rb

@@ -0,0 +1,68 @@
+$: << File.dirname(__FILE__)
+require 'helper'
+require 'wbem'
+
+class TestClassnames < Test::Unit::TestCase
+  #def setup
+  #end
+  #def teardown
+  #end
+  def test_classnames_cimxml
+    c = Wbem::Client.connect("https://wsman:secret@localhost:5989", :cimxml)
+    assert c
+    names = c.class_names "root/cimv2"
+    assert names
+    assert names.size > 0
+    assert !names.include?("CIM_ManagedSystemElement")
+    puts "test_classnames_cimxml: #{names.size} classes"
+  end
+  def test_classnames_cimxml_partial
+    c = Wbem::Client.connect("https://wsman:secret@localhost:5989", :cimxml)
+    assert c
+    names = c.class_names "root/cimv2", "CIM_ManagedElement"
+    assert names
+    assert names.size > 0
+    assert names.include?("CIM_ManagedSystemElement")
+    puts "test_classnames_cimxml: #{names.size} classes"
+  end
+  def test_classnames_cimxml_deep
+    c = Wbem::Client.connect("https://wsman:secret@localhost:5989", :cimxml)
+    assert c
+    names = c.class_names "root/cimv2", true
+    assert names
+    assert names.size > 0
+    puts "test_classnames_cimxml: #{names.size} classes"
+  end
+  def test_classnames_openwsman
+    c = Wbem::Client.connect("http://wsman:secret@localhost:5985", :wsman)
+    assert c
+    names = c.class_names "root/cimv2"
+    assert names
+    assert names.size > 0
+    puts "test_classnames_openwsman: #{names.size} classes"
+  end
+  def test_classnames_openwsman_deep
+    c = Wbem::Client.connect("http://wsman:secret@localhost:5985", :wsman)
+    assert c
+    names = c.class_names "root/cimv2", true
+    assert names
+    assert names.size > 0
+    puts "test_classnames_openwsman_deep: #{names.size} classes"
+  end
+  def test_classnames_winrm
+    c = Wbem::Client.connect("http://wsman:secret@wsman2003sp2.suse.de:5985", :wsman, :basic)
+    assert c
+    names = c.class_names "root/cimv2"
+    assert names
+    assert names.size > 0
+    puts "test_classnames_winrm: #{names.size} classes"
+  end
+  def test_classnames_winrm_deep
+    c = Wbem::Client.connect("http://wsman:secret@wsman2003sp2.suse.de:5985", :wsman, :basic)
+    assert c
+    names = c.class_names "root/cimv2", true
+    assert names
+    assert names.size > 0
+    puts "test_classnames_winrm_deep: #{names.size} classes"
+  end
+end