rbvmomi 1.1.2 → 1.1.3

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.1.3

data/examples/logbundle.rb

@@ -0,0 +1,63 @@
+# @todo Retrieve ESX log bundles when run against VC.
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+DEFAULT_SERVER_PLACEHOLDER = '0.0.0.0'
+
+opts = Trollop.options do
+  banner <<-EOS
+Generate and retrieve a log bundle.
+
+Usage:
+    logbundle.rb [options] dest
+
+dest must be a directory.
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+Other options:
+  EOS
+end
+
+Trollop.die("must specify host") unless opts[:host]
+dest = ARGV[0] or abort("must specify destination directory")
+
+abort "destination is not a directory" unless File.directory? dest
+
+vim = VIM.connect opts
+is_vc = vim.serviceContent.about.apiType == 'VirtualCenter'
+diagMgr = vim.serviceContent.diagnosticManager
+
+bundles =
+  begin
+    diagMgr.GenerateLogBundles_Task(includeDefault: true).wait_for_completion
+  rescue VIM::TaskInProgress
+    $!.task.wait_for_completion
+  end
+
+bundles.each do |b|
+  uri = URI.parse(b.url.sub('*', DEFAULT_SERVER_PLACEHOLDER))
+  dest_path = File.join(dest, File.basename(uri.path))
+  puts "downloading bundle #{b.url} to #{dest_path}"
+  if uri.host == DEFAULT_SERVER_PLACEHOLDER
+    vim.http.request_get(uri.path) do |res|
+      File.open dest_path, 'w' do |io|
+        res.read_body do |data|
+          io.write data
+          $stdout.write '.'
+          $stdout.flush
+        end
+      end
+      puts
+    end
+  else
+    puts 'not supported yet'
+  end
+end

data/examples/logtail.rb

@@ -0,0 +1,60 @@
+# Translation of example 2-2 from the vSphere SDK for Perl Programming Guide
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+
+opts = Trollop.options do
+  banner <<-EOS
+Follow a log file.
+
+Usage:
+    logtail.rb [options] [logKey]
+
+If logKey is not provided the list of available log keys will be printed and
+the program will exit.
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+Other options:
+  EOS
+end
+
+Trollop.die("must specify host") unless opts[:host]
+logKey = ARGV[0]
+
+vim = VIM.connect opts
+diagMgr = vim.serviceContent.diagnosticManager
+
+if not logKey
+  puts "Available logs:"
+  diagMgr.QueryDescriptions.each do |desc|
+    puts "#{desc.key}: #{desc.info.label}"
+  end
+  exit 0
+end
+
+# Obtain the last line of the logfile by setting an arbitrarily large
+# line number as the starting point
+log = diagMgr.BrowseDiagnosticLog(key: logKey, start: 999999999)
+lineEnd = log.lineEnd
+
+# Get the last 5 lines of the log first, and then check every 2 seconds
+# to see if the log size has increased.
+start = lineEnd - 5
+while true
+  log = diagMgr.BrowseDiagnosticLog(key: logKey, start: start)
+  if log.lineStart != 0
+    log.lineText.each do |l|
+      puts l
+    end
+  end
+  start = log.lineEnd + 1
+  sleep 2
+end

data/examples/run.sh

@@ -35,5 +35,7 @@ echo "Listing extraConfig"
 $RUBY $EXAMPLES/extraConfig.rb foo list | grep guestinfo.bar
 echo Powering off VM
 $RUBY $EXAMPLES/power.rb off foo
+echo Querying datastore utilization
+$RUBY $EXAMPLES/vdf.rb
 echo Destroying VM
 $RUBY $EXAMPLES/power.rb destroy foo

data/examples/vdf.rb

@@ -0,0 +1,81 @@
+# Translation of vGhetto vdf, originally by William Lam
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+
+opts = Trollop.options do
+  banner <<-EOS
+Display utilization of each datastore in the datacenter.
+
+Usage:
+    vdf.rb [options]
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+Datacenter selection:
+    EOS
+
+    rbvmomi_datacenter_opt
+
+    text <<-EOS
+
+Other options:
+  EOS
+end
+
+Trollop.die("must specify host") unless opts[:host]
+
+vim = VIM.connect opts
+
+dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
+
+def si n
+  ['', 'K', 'M', 'G', 'T', 'P'].each_with_index do |x,i|
+    v = n.to_f/(1000**i)
+    return v,x if v < 1000 or x == 'P'
+  end
+end
+
+def unit n, u, p
+  "%.*g%s%s" % [p, si(n), u].flatten
+end
+
+def b n
+  unit(n,'B',3)
+end
+
+puts "Filesystem#{' '*43}Size    Used    Avail   Use%    Mounted on"
+fmt = "%-52s %-7s %-7s %-7s %-7s %s"
+
+if false
+  # simple version
+  dc.datastore.sort_by { |ds| ds.info.url }.each do |ds|
+    s = ds.summary
+    next unless s.accessible
+    size = s.capacity
+    free = s.freeSpace
+    used = size - free
+    pct_used = used*100.0/size
+    puts(fmt % [ds.info.url, b(size), b(used), b(free), unit(pct_used,'%',3), ds.name])
+  end
+else
+  # fast version
+  paths = %w(name info.url summary.accessible summary.capacity summary.freeSpace)
+  propSet = [{ :type => 'Datastore', :pathSet => paths }]
+  filterSpec = { :objectSet => dc.datastore.map { |ds| { :obj => ds } }, :propSet => propSet }
+  data = vim.propertyCollector.RetrieveProperties(:specSet => [filterSpec])
+  data.select { |d| d['summary.accessible'] }.sort_by { |d| d['info.url'] }.each do |d|
+    size = d['summary.capacity']
+    free = d['summary.freeSpace']
+    used = size - free
+    pct_used = used*100.0/size
+    puts(fmt % [d['info.url'], b(size), b(used), b(free), unit(pct_used,'%',3), d['name']])
+  end
+end

data/lib/rbvmomi/connection.rb

@@ -49,7 +49,7 @@ class Connection < TrivialSoap
       if desc
         type = desc['is-task'] ? 'Task' : desc['wsdl_type']
         returnvals = resp.children.select(&:element?).map { |c| xml2obj c, type }
-        desc['is-array'] ? returnvals : returnvals.first
+        (desc['is-array'] && !desc['is-task']) ? returnvals : returnvals.first
       else
         nil
       end

data/test/test_parse_response.rb

@@ -50,10 +50,22 @@ class ParseResponseTest < Test::Unit::TestCase
   </detail>
 </soapenv:Fault>
         EOS
-      rescue RbVmomi::Fault
+      rescue VIM::InvalidArgument
         raise
+      rescue
+        raise "wrong fault"
       end
     end
   end
+
+  def test_task_array_result
+    desc = { 'wsdl_type' => 'xsd:string', 'is-array' => true, 'is-task' => true }
+
+    check desc, <<-EOS, VIM.Task(nil, 'haTask-ha-host-vim.DiagnosticManager.generateLogBundles-865')
+<root xmlns="urn:vim25">
+  <returnval type="Task">haTask-ha-host-vim.DiagnosticManager.generateLogBundles-865</returnval>
+</root>
+    EOS
+  end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 2
-  version: 1.1.2
+  - 3
+  version: 1.1.3
 platform: ruby
 authors: 
 - Rich Lane
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-21 00:00:00 -08:00
+date: 2011-02-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,10 +91,13 @@ files:
 - examples/create_vm-1.9.rb
 - examples/create_vm.rb
 - examples/extraConfig.rb
+- examples/logbundle.rb
+- examples/logtail.rb
 - examples/power.rb
 - examples/readme-1.rb
 - examples/readme-2.rb
 - examples/run.sh
+- examples/vdf.rb
 - lib/rbvmomi.rb
 - lib/rbvmomi/basic_types.rb
 - lib/rbvmomi/connection.rb
@@ -160,9 +163,12 @@ test_files:
 - examples/create_vm-1.9.rb
 - examples/create_vm.rb
 - examples/extraConfig.rb
+- examples/logbundle.rb
+- examples/logtail.rb
 - examples/power.rb
 - examples/readme-1.rb
 - examples/readme-2.rb
+- examples/vdf.rb
 - test/test_deserialization.rb
 - test/test_emit_request.rb
 - test/test_exceptions.rb