rbvmomi 1.1.3 → 1.1.4

data/README.html

@@ -0,0 +1,76 @@
+<h1>RbVmomi</h1>
+
+<h2>Introduction</h2>
+
+<p>RbVmomi is a Ruby interface to the vSphere API. Like the Perl and Java SDKs,
+you can use it to manage ESX and VirtualCenter servers. The current release
+supports the vSphere 4.1 API.</p>
+
+<h2>Usage</h2>
+
+<p>A simple example of turning on a VM:</p>
+
+<pre><code>require 'rbvmomi'
+conn = RbVmomi.connect host: 'foo', user: 'bar', password: 'baz'
+dc = conn.serviceInstance.find_datacenter("mydatacenter") or fail "datacenter not found"
+vm = dc.find_vm("myvm") or fail "VM not found"
+vm.PowerOn_Task.wait_for_completion
+</code></pre>
+
+<p>This code uses several RbVmomi extensions to the VI API for concision. The
+expanded snippet below uses only standard API calls and should be familiar to
+users of the Java SDK:</p>
+
+<pre><code>require 'rbvmomi'
+conn = RbVmomi.connect host: 'foo', user: 'bar', password: 'baz'
+rootFolder = conn.serviceInstance.content.rootFolder
+dc = rootFolder.childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == "mydatacenter" } or fail "datacenter not found"
+vm = dc.vmFolder.childEntity.grep(RbVmomi::VIM::VirtualMachine).find { |x| x.name == "myvm" } or fail "VM not found"
+task = vm.PowerOn_Task
+filter = conn.propertyCollector.CreateFilter(
+  spec: {
+    propSet: [{ type =&gt; 'Task', all: false, pathSet: ['info.state']}],
+    objectSet: [{ obj: task }]
+  },
+  partialUpdates: false
+)
+ver = ''
+while true
+  result = conn.propertyCollector.WaitForUpdates(version: ver)
+  ver = result.version
+  break if ['success', ['error'].member? task.info.state
+end
+filter.DestroyPropertyFilter
+raise task.info.error if task.info.state == 'error'
+</code></pre>
+
+<p>As you can see, the extensions RbVmomi adds can dramatically decrease the code
+needed to perform simple tasks while still letting you use the full power of
+the API when necessary. RbVmomi extensions are often more efficient than a
+naive implementation; for example, the find_vm method on VIM::Datacenter used
+in the first example uses the SearchIndex for fast lookups.</p>
+
+<p>A few important points:</p>
+
+<ul>
+<li>Ruby 1.9 is required.</li>
+<li>Properties are exposed as methods: vm.summary</li>
+<li>All class, method, parameter, and property names match the <a href="http://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/index.html">official documentation</a>.</li>
+<li>Data object types can usually be inferred from context, so you may simply use a hash instead.</li>
+<li>Enumeration values are simply strings.</li>
+<li>Example code is included in the examples/ directory.</li>
+<li>A set of helper methods for Trollop is included to speed up development of
+command line apps. See the included examples for usage.</li>
+<li>This is a side project of a VMware developer and is entirely unsupported by VMware.</li>
+</ul>
+
+<p>Built-in extensions are in lib/rbvmomi/extensions.rb. You are encouraged to
+reopen VIM classes in your applications and add extensions of your own. If you
+write something generally useful please send it to me and I'll add it in. One
+important point about extensions is that since VIM classes are lazily loaded,
+you need to trigger this loading before you can reopen the class. Putting the
+class name on a line by itself before reopening is enough.</p>
+
+<h2>Development</h2>
+
+<p>Send patches to rlane@vmware.com.</p>

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.1.4

data/bin/rbvmomish

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby
+# TODO keepalive
+# TODO rc file
+# TODO proxy support?
+require 'trollop'
+require 'readline'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+
+opts = Trollop.options do
+  banner <<-EOS
+vSphere API console.
+
+Usage:
+       rbvmomish [options]
+
+Predefined methods:
+si: Returns the ServiceInstance
+help: Displays this text.
+
+Special syntax:
+Adding a '#' suffix to an expression displays information about the type of the
+result, including its properties and methods, instead of the value.
+
+VIM connection options:
+  EOS
+
+  rbvmomi_connection_opts
+
+  text <<-EOS
+
+Other options:
+  EOS
+
+  $trollop = self
+end
+
+begin
+  $vim = VIM.connect opts
+rescue Errno::EHOSTUNREACH
+  abort $!.message
+end
+
+typenames = VIM.instance_variable_get(:@typenames)
+Readline.completion_append_character = " "
+Readline.completion_proc = lambda do |word|
+  return unless word
+  prefix_regex = /^#{Regexp.escape(word)}/
+  candidates = typenames.sort
+  candidates.find_all { |e| e.match(prefix_regex) }
+end
+
+history_fn = "#{ENV['HOME']}/.rbvmomish-history"
+IO.foreach(history_fn) { |l| Readline::HISTORY << l.chomp } rescue nil
+history = File.open(history_fn, 'a')
+
+def type name
+  klass = VIM.type(name) rescue err("invalid type #{name.inspect}")
+  q = lambda { |x| x =~ /^xsd:/ ? $' : x }
+  if klass < VIM::DataObject
+    puts "Data Object #{klass}"
+    klass.full_props_desc.each do |desc|
+      puts " #{desc['name']}: #{q[desc['wsdl_type']]}#{desc['is-array'] ? '[]' : ''}"
+    end
+  elsif klass < VIM::ManagedObject
+    puts "Managed Object #{klass}"
+    puts
+    puts "Properties:"
+    klass.full_props_desc.each do |desc|
+      puts " #{desc['name']}: #{q[desc['wsdl_type']]}#{desc['is-array'] ? '[]' : ''}"
+    end
+    puts
+    puts "Methods:"
+    klass.full_methods_desc.sort_by(&:first).each do |name,desc|
+      params = desc['params']
+      puts " #{name}(#{params.map { |x| "#{x['name']} : #{q[x['wsdl_type'] || 'void']}#{x['is-array'] ? '[]' : ''}" } * ', '}) : #{q[desc['result']['wsdl_type'] || 'void']}"
+    end
+  else
+    err("cannot introspect type #{klass}")
+  end
+  nil
+end
+
+class UserError < RuntimeError; end
+def err msg
+  raise UserError.new(msg)
+end
+
+def cookie str
+  $vim.cookie = str
+end
+
+def si
+  $vim.serviceInstance
+end
+
+def help
+  $trollop.educate
+  :no_result
+end
+
+$binding = $vim.instance_eval { binding }
+
+loop do
+begin
+  input = Readline.readline("#{opts[:host]}> ", false) or break
+  input = input.strip
+  next if input.empty?
+
+  (history.puts input; Readline::HISTORY << input) unless input == Readline::HISTORY.to_a[-1]
+
+  result = eval(input, $binding)
+  if input =~ /\#$/
+    type result.class.wsdl_name
+  else
+    pp result unless result == :no_result
+  end
+rescue SystemExit, IOError
+  raise
+rescue RuntimeError, RbVmomi::Fault
+  puts "#{$!.class}: #{$!.message}"
+  puts $!.backtrace * "\n"
+rescue UserError
+  puts $!.message
+rescue Interrupt
+  puts
+rescue Exception
+  puts "#{$!.class}: #{$!.message}"
+  puts $!.backtrace * "\n"
+end
+end

data/lib/rbvmomi/vim/Datastore.rb

@@ -55,10 +55,10 @@ class RbVmomi::VIM::Datastore
   def datacenter
     return @datacenter if @datacenter
     x = parent
-    while not x.is_a? Datacenter
+    while not x.is_a? RbVmomi::VIM::Datacenter
       x = x.parent
     end
-    fail unless x.is_a? Datacenter
+    fail unless x.is_a? RbVmomi::VIM::Datacenter
     @datacenter = x
   end
 

data/lib/rbvmomi/vim/Folder.rb

@@ -26,12 +26,12 @@ class RbVmomi::VIM::Folder
     final = es.pop
 
     p = es.inject(self) do |f,e|
-      f.find(e, Folder) || (create && f.CreateFolder(:name => e)) || return
+      f.find(e, RbVmomi::VIM::Folder) || (create && f.CreateFolder(:name => e)) || return
     end
 
     if x = p.find(final, type)
       x
-    elsif create and type == Folder
+    elsif create and type == RbVmomi::VIM::Folder
       p.CreateFolder(:name => final)
     else
       nil

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 3
-  version: 1.1.3
+  - 4
+  version: 1.1.4
 platform: ruby
 authors: 
 - Rich Lane
@@ -15,7 +15,7 @@ bindir: bin
 cert_chain: []
 
 date: 2011-02-22 00:00:00 -08:00
-default_executable: 
+default_executable: rbvmomish
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -73,12 +73,13 @@ dependencies:
   version_requirements: *id004
 description: 
 email: rlane@vmware.com
-executables: []
-
+executables: 
+- rbvmomish
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
+- README.html
 - README.rdoc
 files: 
 - .yardopts
@@ -86,6 +87,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/rbvmomish
 - devel/analyze-vim-declarations.rb
 - devel/analyze-xml.rb
 - examples/create_vm-1.9.rb
@@ -125,6 +127,7 @@ files:
 - test/test_parse_response.rb
 - test/test_serialization.rb
 - vmodl.cdb
+- README.html
 has_rdoc: true
 homepage: https://github.com/rlane/rbvmomi
 licenses: []