rbvmomi 1.1.5 → 1.1.6

data/VERSION

@@ -1 +1 @@
-1.1.5
+1.1.6

data/devel/analyze-xml.rb

@@ -36,7 +36,7 @@ def print_tree tree, indent=0
     puts "#{'  '*indent}#{k}#{numsym}: #{attrs.sort.map { |a| "[#{a * ' '}]"} * ', '} {#{min},#{max}}"
     print_tree v, (indent+1)
   end
-end  
+end
 
 tree = {}
 ARGV.each do |fn|

data/examples/screenshot.rb

@@ -0,0 +1,48 @@
+# Based on takeVMScreenshot.pl by William Lam
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+
+opts = Trollop.options do
+  banner <<-EOS
+Take a screenshot.
+
+Usage:
+    screenshot.rb [options] vm filename
+
+A PNG image will be saved to the given filename.
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+VM location options:
+    EOS
+
+    rbvmomi_datacenter_opt
+
+    text <<-EOS
+
+Other options:
+  EOS
+end
+
+Trollop.die("must specify host") unless opts[:host]
+vm_name = ARGV[0] or abort("must specify VM name")
+output_path = ARGV[1] or abort("must specify output filename")
+
+vim = VIM.connect opts
+dc = vim.serviceInstance.find_datacenter(opts[:datacenter])
+vm = dc.find_vm vm_name
+abort "VM must be running" unless vm.runtime.powerState == 'poweredOn'
+remote_path = vm.CreateScreenshot_Task.wait_for_completion
+remote_path =~ /^(\/vmfs\/volumes\/[^\/]+)\// or fail
+datastore_prefix = $1
+datastore_path = $'
+datastore = vm.datastore.find { |ds| ds.info.url == datastore_prefix }
+datastore.download datastore_path, output_path

data/lib/rbvmomi/trivial_soap.rb

@@ -5,17 +5,6 @@ require 'nokogiri'
 require 'net/http'
 require 'pp'
 
-module Net
-  class HTTPGenericRequest
-    alias old_exec exec
-
-    def exec sock, ver, path
-      old_exec sock, ver, path
-      sock.io.flush
-    end
-  end
-end
-
 class RbVmomi::TrivialSoap
   attr_accessor :debug, :cookie
   attr_reader :http
@@ -48,6 +37,9 @@ class RbVmomi::TrivialSoap
     @http.set_debug_output(STDERR) if $DEBUG
     @http.read_timeout = 1000000000
     @http.open_timeout = 5
+    def @http.on_connect
+      @socket.io.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+    end
     @http.start
   end
 
@@ -68,7 +60,7 @@ class RbVmomi::TrivialSoap
     headers = { 'content-type' => 'text/xml; charset=utf-8', 'SOAPAction' => action }
     headers['cookie'] = @cookie if @cookie
     body = soap_envelope(&b).target!
-    
+
     if @debug
       $stderr.puts "Request:"
       $stderr.puts body

data/lib/rbvmomi/trollop.rb

@@ -27,7 +27,7 @@ class Parser
   def rbvmomi_connection_opts
     opt :host, "host", :type => :string, :short => 'o', :default => ENV['RBVMOMI_HOST']
     opt :port, "port", :type => :int, :short => :none, :default => (ENV.member?('RBVMOMI_PORT') ? ENV['RBVMOMI_PORT'].to_i : 443)
-    opt :"no-ssl", "don't use ssl", :short => :none, :default => (ENV['RBVMOMI_SSL'] == '0') 
+    opt :"no-ssl", "don't use ssl", :short => :none, :default => (ENV['RBVMOMI_SSL'] == '0')
     opt :insecure, "don't verify ssl certificate", :short => 'k', :default => (ENV['RBVMOMI_INSECURE'] == '1')
     opt :user, "username", :short => 'u', :default => (ENV['RBVMOMI_USER'] || 'root')
     opt :password, "password", :short => 'p', :default => (ENV['RBVMOMI_PASSWORD'] || '')

data/lib/rbvmomi/type_loader.rb

@@ -41,8 +41,10 @@ class TypeLoader
   private
 
   def load_extension name
-    path = @target.extension_path name
-    load path if File.exists? path
+    dirs = @target.extension_dirs
+    dirs.map { |x| File.join(x, "#{name}.rb") }.
+         select { |x| File.exists? x }.
+         each { |x| load x }
   end
 
   def make_type name

data/lib/rbvmomi/vim.rb

@@ -22,7 +22,7 @@ class VIM < Connection
     fail "host option required" unless opts[:host]
     opts[:user] ||= 'root'
     opts[:password] ||= ''
-    opts[:ssl] = true unless opts.member? :ssl
+    opts[:ssl] = true unless opts.member? :ssl or opts[:"no-ssl"]
     opts[:insecure] ||= false
     opts[:port] ||= (opts[:ssl] ? 443 : 80)
     opts[:path] ||= '/sdk'
@@ -67,9 +67,11 @@ class VIM < Connection
     serviceContent.searchIndex
   end
 
-  # @private
-  def self.extension_path name
-    File.join(File.dirname(__FILE__), "vim", "#{name}.rb")
+  @extension_dirs = [File.join(File.dirname(__FILE__), "vim")]
+
+  # Directories to search for extensions
+  def self.extension_dirs
+    @extension_dirs
   end
 
   load_vmodl(ENV['VMODL'] || File.join(File.dirname(__FILE__), "../../vmodl.cdb"))

data/lib/rbvmomi/vim/Folder.rb

@@ -15,13 +15,19 @@ class RbVmomi::VIM::Folder
   end
 
   # Retrieve a descendant of this Folder.
-  # @param path [String] Path delimited by '/'.
+  # @param path [String] Path delimited by '/', or an array of path elements.
   # @param type (see Folder#find)
   # @param create [Boolean] If set, create folders that don't exist.
   # @return (see Folder#find)
   # @todo Move +create+ functionality into another method.
   def traverse path, type=Object, create=false
-    es = path.split('/').reject(&:empty?)
+    if path.is_a? String
+      es = path.split('/').reject(&:empty?)
+    elsif path.is_a? Enumerable
+      es = path
+    else
+      fail "unexpected path class"
+    end
     return self if es.empty?
     final = es.pop
 

data/lib/rbvmomi/vim/OvfManager.rb

@@ -87,7 +87,7 @@ class RbVmomi::VIM::OvfManager
       vm
     end
   rescue Exception
-    nfcLease.HttpNfcLeaseAbort
+    nfcLease.HttpNfcLeaseAbort if nfcLease
     raise
   end
 end

data/test/test_deserialization.rb

@@ -91,7 +91,9 @@ def test_array2
     :vlanIds => [
       VIM::NumericRange(:dynamicProperty => [], :start => 5, :end => 7),
       VIM::NumericRange(:dynamicProperty => [], :start => 10, :end => 20),
-    ]
+    ],
+    :vmDirectPathGen2InactiveReasonNetwork => [],
+    :vmDirectPathGen2InactiveReasonOther => []
   )
 
   check <<-EOS, obj, 'DVPortStatus'
@@ -115,7 +117,9 @@ def test_empty_array
     :dynamicProperty => [],
     :linkUp => true,
     :blocked => false,
-    :vlanIds => []
+    :vlanIds => [],
+    vmDirectPathGen2InactiveReasonNetwork: [],
+    vmDirectPathGen2InactiveReasonOther: []
   )
 
   check <<-EOS, obj, 'DVPortStatus'
@@ -257,7 +261,8 @@ end
       :powerState => "poweredOn",
       :recordReplayState => "inactive",
       :suspendInterval => 0,
-      :toolsInstallerMounted => false
+      :toolsInstallerMounted => false,
+      :device => []
     )
 
     check <<-EOS, obj, 'VirtualMachineRuntimeInfo'

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: rbvmomi
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 5
-  version: 1.1.5
+  prerelease: 
+  version: 1.1.6
 platform: ruby
 authors: 
 - Rich Lane
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-22 00:00:00 -08:00
+date: 2011-02-28 00:00:00 -08:00
 default_executable: rbvmomish
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 1
         version: 1.4.1
   type: :runtime
   version_requirements: *id001
@@ -40,8 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -53,8 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
@@ -66,8 +54,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id004
@@ -79,7 +65,6 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.html
 - README.rdoc
 files: 
 - .yardopts
@@ -99,6 +84,7 @@ files:
 - examples/readme-1.rb
 - examples/readme-2.rb
 - examples/run.sh
+- examples/screenshot.rb
 - examples/vdf.rb
 - lib/rbvmomi.rb
 - lib/rbvmomi/basic_types.rb
@@ -128,7 +114,6 @@ files:
 - test/test_parse_response.rb
 - test/test_serialization.rb
 - vmodl.cdb
-- README.html
 has_rdoc: true
 homepage: https://github.com/rlane/rbvmomi
 licenses: []
@@ -143,23 +128,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 9
-      - 1
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Ruby interface to the VMware vSphere API
@@ -172,6 +151,7 @@ test_files:
 - examples/power.rb
 - examples/readme-1.rb
 - examples/readme-2.rb
+- examples/screenshot.rb
 - examples/vdf.rb
 - test/test_deserialization.rb
 - test/test_emit_request.rb

data/README.html

@@ -1,76 +0,0 @@
-<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>