rbvmomi 1.8.5 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2971a40037e23e51c5253e553138edc469253ee05747d9761f5c158bd34c5feb
-  data.tar.gz: 24742f39140e8d8d961c6ed5248b3d86c2658795ddd7819b3ca868970c7a6461
+SHA1:
+  metadata.gz: c8e16685061414bc6f641e2a7ba8b1a2c3067ccc
+  data.tar.gz: 2d4f2ef6b5bedcc5c929548c8d0d74ac128e2434
 SHA512:
-  metadata.gz: c98371ab294a9ccc14ac0b570950eebb0415b821ad85684931ee731837cb7ab176163bc8409f72212cab9577bf0c47846287435fe9db2114bafae1cc91654070
-  data.tar.gz: d86ae7c8c6cd4ae0cf359c420f8f9cf7df0e069861cccacdd5a18fc3bf3b21bf1ffcd41ca67a5c2ca18f6dc4a2ced6b7cf333e72e704bc43865311222550f3af
+  metadata.gz: 91f7933b69a4704a508d95e709cbe49a4ae268127e7596b5b8f47fd97de8d650a88e35ef07320319a3b200fb097a0a9590f610e4daf5efddff0d86496fd70c85
+  data.tar.gz: 608f43fe7d372adc23319e2bf7dcf354c341caef54d642243b99430e3543772424cfaed78f93c26880b8d504d6029fdff8b73e68ddc6e821906231542d6ee6c6

data/.gitignore

@@ -0,0 +1,13 @@
+*.rbc
+*.swp
+*.swo
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+/.bundle/
+/.yardoc/
+/coverage/
+/doc/
+/pkg/
+/vendor/bundle/
+/vmodl/

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.2.5
+  - 2.3.1
+  - jruby-1.7.25
+  - jruby-9.1.2.0
+before_install:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.rdoc

@@ -1,12 +1,16 @@
 = RbVmomi
 
+{<img src="https://travis-ci.org/vmware/rbvmomi.svg?branch=master" alt="travis-ci">}[http://travis-ci.org/vmware/rbvmomi]
+
+This is an Open Source community supported project at VMware. It is built and maintained by programmers like you!
+
 == Introduction
 
 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 5.0 API. RbVmomi specific documentation is
 online[http://rdoc.info/github/rlane/rbvmomi/master/frames] and is meant to
-be used alongside the official documentation[http://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/index.html].
+be used alongside the official documentation[http://pubs.vmware.com/vsphere-60/topic/com.vmware.sdk.doc/GUID-19793BCA-9EAB-42E2-8B9F-F9F2129E7741.html].
 
 == Installation
 
@@ -56,7 +60,7 @@ in the first example uses the SearchIndex for fast lookups.
 
 A few important points:
 
-* All class, method, parameter, and property names match the official documentation[http://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/index.html].
+* All class, method, parameter, and property names match the official documentation[http://pubs.vmware.com/vsphere-60/topic/com.vmware.sdk.doc/GUID-19793BCA-9EAB-42E2-8B9F-F9F2129E7741.html].
 * Properties are exposed as accessor methods.
 * Data object types can usually be inferred from context, so you may use a hash instead.
 * Enumeration values are simply strings.

data/Rakefile

@@ -1,27 +1,8 @@
+require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rdoc/task'
 require 'yard'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "rbvmomi"
-    gem.summary = "Ruby interface to the VMware vSphere API"
-    #gem.description = ""
-    gem.email = "rlane@vmware.com"
-    gem.homepage = "https://github.com/vmware/rbvmomi"
-    gem.authors = ["Rich Lane", "Christian Dickmann"]
-    gem.add_dependency 'nokogiri', '>= 1.4.1'
-    gem.add_dependency 'builder'
-    gem.add_dependency 'trollop'
-    gem.required_ruby_version = '>= 1.8.7'
-    gem.files.include 'vmodl.db'
-    gem.files.include '.yardopts'
-    gem.version = '1.8.4'
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
+task(:default => :test)
 
 Rake::TestTask.new do |t|
   t.libs << "test"
@@ -30,17 +11,3 @@ Rake::TestTask.new do |t|
 end
 
 YARD::Rake::YardocTask.new
-
-begin
-  require 'rcov/rcovtask'
-  desc 'Measures test coverage using rcov'
-  Rcov::RcovTask.new do |rcov|
-    rcov.pattern    = 'test/test_*.rb'
-    rcov.output_dir = 'coverage'
-    rcov.verbose    = true
-    rcov.libs << "test"
-    rcov.rcov_opts << '--exclude "gems/*"'
-  end
-rescue LoadError
-  puts "Rcov not available. Install it with: gem install rcov"
-end

data/ext/mkrf_conf.rb

@@ -0,0 +1,24 @@
+require 'rubygems/dependency_installer'
+
+# SEE: http://en.wikibooks.org/wiki/Ruby_Programming/RubyGems#How_to_install_different_versions_of_gems_depending_on_which_version_of_ruby_the_installee_is_using
+
+di = Gem::DependencyInstaller.new
+
+begin
+  if RUBY_VERSION =~ /^1.8/
+    puts "Not installing test-unit. It is included in Ruby #{RUBY_VERSION}"
+  else
+    di.install 'test-unit', '~> 3.2'
+  end
+rescue => e
+  warn "#{$0}: #{e}"
+  
+  exit!
+end
+
+puts "Writing fake Rakefile"
+
+# Write fake Rakefile for rake since Makefile isn't used
+File.open(File.join(File.dirname(__FILE__), 'Rakefile'), 'w') do |f|
+  f.write("task :default" + $/)
+end

data/lib/rbvmomi/basic_types.rb

@@ -158,6 +158,12 @@ class DataObject < ObjectWithProperties
     q.text ')'
   end
 
+  def to_json(*args)
+    h = self.props
+    m = h.merge({ JSON.create_id => self.class.name })
+    m.to_json(*args)
+  end
+
   init
 end
 

data/lib/rbvmomi/trivial_soap.rb

@@ -1,4 +1,3 @@
-
 # Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
 require 'rubygems'
 require 'builder'
@@ -43,15 +42,14 @@ class RbVmomi::TrivialSoap
       if @opts[:insecure]
         @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       else
-        @http.cert_store = OpenSSL::X509::Store.new
-        @http.cert_store.set_default_paths
-        @http.cert_store.add_file(@opts[:cert]) if @opts[:cert]
-        @http.key = OpenSSL::PKey::RSA.new(@opts[:key]) if @opts[:key]
+        @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
       end
+      @http.cert = OpenSSL::X509::Certificate.new(@opts[:cert]) if @opts[:cert]
+      @http.key = OpenSSL::PKey::RSA.new(@opts[:key]) if @opts[:key]
     end
     @http.set_debug_output(STDERR) if $DEBUG
-    @http.read_timeout = 1000000
-    @http.open_timeout = 60
+    @http.read_timeout = @opts[:read_timeout] || 1000000
+    @http.open_timeout = @opts[:open_timeout] || 60
     def @http.on_connect
       @socket.io.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
     end

data/lib/rbvmomi/utils/admission_control.rb

@@ -77,11 +77,11 @@ class AdmissionControlledResourceScheduler
   # Returns the used VM folder. If not set yet, uses the vm_folder_path to 
   # lookup the folder. If it doesn't exist, it is created. Collisions between
   # multiple clients concurrently creating the same folder are handled.
-  # @return [VIM::Folder] The VM folder
+  # @return [RbVmomi::VIM::Folder] The VM folder
   def vm_folder 
     retries = 1
     begin
-      @vm_folder ||= datacenter.vmFolder.traverse!(@vm_folder_path, VIM::Folder)
+      @vm_folder ||= datacenter.vmFolder.traverse!(@vm_folder_path, RbVmomi::VIM::Folder)
       if !@vm_folder 
         fail "VM folder #{@vm_folder_path} not found"
       end
@@ -98,10 +98,10 @@ class AdmissionControlledResourceScheduler
 
   # Returns the used Datacenter. If not set yet, uses the datacenter_path to 
   # lookup the datacenter. 
-  # @return [VIM::Datacenter] The datacenter
+  # @return [RbVmomi::VIM::Datacenter] The datacenter
   def datacenter
     if !@datacenter
-      @datacenter = @root_folder.traverse(@datacenter_path, VIM::Datacenter) 
+      @datacenter = @root_folder.traverse(@datacenter_path, RbVmomi::VIM::Datacenter) 
       if !@datacenter 
         fail "datacenter #{@datacenter_path} not found"
       end
@@ -112,11 +112,11 @@ class AdmissionControlledResourceScheduler
   # Returns the candidate datastores. If not set yet, uses the datastore_paths 
   # to lookup the datastores under the datacenter.
   # As a side effect, also looks up properties about all the datastores 
-  # @return [Array] List of VIM::Datastore
+  # @return [Array] List of RbVmomi::VIM::Datastore
   def datastores
     if !@datastores
       @datastores = @datastore_paths.map do |path|
-        ds = datacenter.datastoreFolder.traverse(path, VIM::Datastore)
+        ds = datacenter.datastoreFolder.traverse(path, RbVmomi::VIM::Datastore)
         if !ds 
           fail "datastore #{path} not found"
         end
@@ -131,7 +131,7 @@ class AdmissionControlledResourceScheduler
 
   # Returns the candidate computers (aka clusters). If not set yet, uses the 
   # computer_names to look them up. 
-  # @return [Array] List of [VIM::ClusterComputeResource, Hash] tuples, where
+  # @return [Array] List of [RbVmomi::VIM::ClusterComputeResource, Hash] tuples, where
   #                 the Hash is a list of stats about the computer
   def computers
     if !@computers
@@ -145,7 +145,7 @@ class AdmissionControlledResourceScheduler
 
   # Returns the candidate pods. If not set, automatically computes the pods 
   # based on the list of computers (aka clusters) and datastores. 
-  # @return [Array] List of pods, where a pod is a list of VIM::ClusterComputeResource
+  # @return [Array] List of pods, where a pod is a list of RbVmomi::VIM::ClusterComputeResource
   def pods
     if !@pods
       # A pod is defined as a set of clusters (aka computers) that share the same
@@ -168,22 +168,22 @@ class AdmissionControlledResourceScheduler
   # @return [Hash] Hash of VMs as keys and their properties as values.
   def pod_vms pod
     # This function retrieves all VMs residing inside a pod
-    filterSpec = VIM.PropertyFilterSpec(
+    filterSpec = RbVmomi::VIM.PropertyFilterSpec(
       objectSet: pod.map do |computer, stats|
         {
           obj: computer.resourcePool,
           selectSet: [
-            VIM.TraversalSpec(
+            RbVmomi::VIM.TraversalSpec(
               name: 'tsFolder',
               type: 'ResourcePool',
               path: 'resourcePool',
               skip: false,
               selectSet: [
-                VIM.SelectionSpec(name: 'tsFolder'),
-                VIM.SelectionSpec(name: 'tsVM'),
+                RbVmomi::VIM.SelectionSpec(name: 'tsFolder'),
+                RbVmomi::VIM.SelectionSpec(name: 'tsVM'),
               ]
             ),
-            VIM.TraversalSpec(
+            RbVmomi::VIM.TraversalSpec(
               name: 'tsVM',
               type: 'ResourcePool',
               path: 'vm',
@@ -202,11 +202,11 @@ class AdmissionControlledResourceScheduler
     result = @vim.propertyCollector.RetrieveProperties(specSet: [filterSpec])
   
     out = result.map { |x| [x.obj, Hash[x.propSet.map { |y| [y.name, y.val] }]] }
-    out.select{|obj, props| obj.is_a?(VIM::VirtualMachine)}
+    out.select{|obj, props| obj.is_a?(RbVmomi::VIM::VirtualMachine)}
   end
   
   # Returns all candidate datastores for a given pod.
-  # @return [Array] List of VIM::Datastore
+  # @return [Array] List of RbVmomi::VIM::Datastore
   def pod_datastores pod
     pod.first.datastore & self.datastores
   end
@@ -214,7 +214,7 @@ class AdmissionControlledResourceScheduler
   # Returns the list of pods that pass admission control. If not set yet, performs
   # admission control to compute the list. If no pods passed the admission 
   # control, an exception is thrown.
-  # @return [Array] List of pods, where a pod is a list of VIM::ClusterComputeResource
+  # @return [Array] List of pods, where a pod is a list of RbVmomi::VIM::ClusterComputeResource
   def filtered_pods
     # This function applies admission control and returns those pods that have
     # passed admission control. An exception is thrown if access was denied to 
@@ -300,7 +300,7 @@ class AdmissionControlledResourceScheduler
   # Returns the computer (aka cluster) to be used for placement. If not set yet,
   # computs the least loaded cluster (using a metric that combines CPU and Memory
   # load) that passes admission control.
-  # @return [VIM::ClusterComputeResource] Chosen computer (aka cluster)
+  # @return [RbVmomi::VIM::ClusterComputeResource] Chosen computer (aka cluster)
   def pick_computer placementhint = nil
     if !@computer
       # Out of the pods to which we have been granted access, pick the cluster
@@ -330,7 +330,7 @@ class AdmissionControlledResourceScheduler
 
   # Returns the datastore to be used for placement. If not set yet, picks a
   # datastore without much intelligence, as long as it passes admission control.
-  # @return [VIM::Datastore] Chosen datastore
+  # @return [RbVmomi::VIM::Datastore] Chosen datastore
   def datastore placementHint = nil
     if @datastore
       return @datastore
@@ -395,4 +395,4 @@ class AdmissionControlledResourceScheduler
     datastore = self.datastore @placement_hint
     log "Datastore: #{datastore.name}"
   end
-end
+end

data/lib/rbvmomi/utils/perfdump.rb

@@ -336,7 +336,7 @@ class PerfAggregator
     vms_props, inventory = all_inventory_flat root_folder, prop_names
     vms = vms_props.keys
     
-    hosts_props = inventory.select{|k, v| k.is_a?(VIM::HostSystem)}
+    hosts_props = inventory.select{|k, v| k.is_a?(RbVmomi::VIM::HostSystem)}
 
     conn = root_folder._connection
     sc = conn.serviceContent

data/lib/rbvmomi/version.rb

@@ -0,0 +1,3 @@
+module RbVmomi
+  VERSION = '1.9.0'.freeze
+end

data/lib/rbvmomi/vim.rb

@@ -1,6 +1,13 @@
 # Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
 require 'rbvmomi'
 
+# Win32::SSPI is part of core on Windows
+begin
+  require 'win32/sspi'
+rescue LoadError
+end
+WIN32 = (defined? Win32::SSPI)
+
 module RbVmomi
 
 # A connection to one vSphere SDK endpoint.
@@ -22,7 +29,7 @@ class VIM < Connection
     fail unless opts.is_a? Hash
     fail "host option required" unless opts[:host]
     opts[:cookie] ||= nil
-    opts[:user] ||= 'root'
+    opts[:user] ||= (WIN32 ? ENV['USERNAME'].dup : 'root')
     opts[:password] ||= ''
     opts[:ssl] = true unless opts.member? :ssl or opts[:"no-ssl"]
     opts[:insecure] ||= false
@@ -30,16 +37,30 @@ class VIM < Connection
     opts[:path] ||= '/sdk'
     opts[:ns] ||= 'urn:vim25'
     rev_given = opts[:rev] != nil
-    opts[:rev] = '4.0' unless rev_given
+    opts[:rev] = '6.0' unless rev_given
     opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
 
     new(opts).tap do |vim|
       unless opts[:cookie]
-        vim.serviceContent.sessionManager.Login :userName => opts[:user], :password => opts[:password]
+        if WIN32 && opts[:password] == ''
+            # Attempt login by SSPI if no password specified on Windows
+            negotiation = Win32::SSPI::NegotiateAuth.new opts[:user], ENV['USERDOMAIN'].dup
+            begin
+              vim.serviceContent.sessionManager.LoginBySSPI :base64Token => negotiation.get_initial_token
+            rescue RbVmomi::Fault => fault
+              if !fault.fault.is_a?(RbVmomi::VIM::SSPIChallenge)
+                raise
+              else
+                vim.serviceContent.sessionManager.LoginBySSPI :base64Token => negotiation.complete_authentication(fault.base64Token)
+              end
+            end
+        else
+            vim.serviceContent.sessionManager.Login :userName => opts[:user], :password => opts[:password]
+        end
       end
       unless rev_given
         rev = vim.serviceContent.about.apiVersion
-        vim.rev = [rev, '5.5'].min
+        vim.rev = [rev, '6.0'].min
       end
     end
   end

data/lib/rbvmomi/vim/Datacenter.rb

@@ -13,5 +13,10 @@ class RbVmomi::VIM::Datacenter
   def find_vm path
     vmFolder.traverse path, RbVmomi::VIM::VirtualMachine
   end
+
+  # Traverse the given inventory +path+ to find a Folder.
+  def find_folder path
+    vmFolder.traverse path, RbVmomi::VIM::Folder
+  end
 end
 

data/lib/rbvmomi/vim/Datastore.rb

@@ -63,6 +63,7 @@ class RbVmomi::VIM::Datastore
   end
 
   def mkuripath path
-    "/folder/#{URI.escape path}?dcPath=#{URI.escape datacenter.name}&dsName=#{URI.escape name}"
+    datacenter_path_str = datacenter.path[1..-1].map{|elem| elem[1]}.join('/')
+    "/folder/#{URI.escape path}?dcPath=#{URI.escape datacenter_path_str }&dsName=#{URI.escape name}"
   end
 end

data/lib/rbvmomi/vim/OvfManager.rb

@@ -16,6 +16,7 @@ class RbVmomi::VIM::OvfManager
   # @option opts [String]             :diskProvisioning (thin) Disk provisioning mode.
   # @option opts [Hash]               :networkMappings Network mappings.
   # @option opts [Hash]               :propertyMappings Property mappings.
+  # @option opts [String]             :deploymentOption Deployment option key.
   def deployOVF opts
     opts = { :networkMappings => {},
              :propertyMappings => {},
@@ -29,7 +30,7 @@ class RbVmomi::VIM::OvfManager
       :hostSystem => opts[:host],
       :locale => "US",
       :entityName => opts[:vmName],
-      :deploymentOption => "",
+      :deploymentOption => opts[:deploymentOption] || "",
       :networkMapping => opts[:networkMappings].map{|from, to| RbVmomi::VIM::OvfNetworkMapping(:name => from, :network => to)},
       :propertyMapping => opts[:propertyMappings].to_a,
       :diskProvisioning => opts[:diskProvisioning]

data/lib/rbvmomi/vim/ReflectManagedMethodExecuter.rb

@@ -2,7 +2,7 @@ module RbVmomi
 
 class VIM::ReflectManagedMethodExecuter
   def fetch moid, prop
-    result = FetchSoap(:moid => moid, :version => 'urn:vim25/5.0', :prop => prop)
+    result = FetchSoap(:moid => moid, :version => 'urn:vim25/6.0', :prop => prop)
     xml = Nokogiri(result.response)
     _connection.deserializer.deserialize xml.root, nil
   end
@@ -16,7 +16,7 @@ class VIM::ReflectManagedMethodExecuter
         soap_arg.val = xml.target!
       end
     end
-    result = ExecuteSoap(:moid => moid, :version => 'urn:vim25/5.0',
+    result = ExecuteSoap(:moid => moid, :version => 'urn:vim25/6.0',
                          :method => method, :argument => soap_args)
     if result
       _connection.deserializer.deserialize Nokogiri(result.response).root, nil

data/rbvmomi.gemspec

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+require 'rbvmomi/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'rbvmomi'
+  spec.summary = 'Ruby interface to the VMware vSphere API'
+  spec.version = RbVmomi::VERSION
+
+  spec.authors  = ['Rich Lane', 'Christian Dickmann']
+  spec.email    = 'jr@garciaole.com'
+  spec.homepage = 'https://github.com/vmware/rbvmomi'
+
+  spec.bindir = 'exe'
+  spec.files  = `git ls-files -z`.split("\x0").reject { |f| f.match(/^test\//) }
+  spec.executables << 'rbvmomish'
+  spec.extensions << 'ext/mkrf_conf.rb'
+
+  spec.add_runtime_dependency('builder', '~> 3.2')
+  spec.add_runtime_dependency('json', '~> 1.8')
+  spec.add_runtime_dependency('nokogiri', '~> 1.5.11')
+  spec.add_runtime_dependency('trollop', '~> 2.1')
+
+  spec.add_development_dependency('rake', '~> 10.5')
+  spec.add_development_dependency('simplecov', '~> 0.12.0')
+  spec.add_development_dependency('yard', '~> 0.9.5')
+
+  unless RUBY_VERSION =~ /^1.8/
+    spec.add_development_dependency('test-unit', '~> 3.2')
+  end
+
+  spec.required_ruby_version = '>= 1.8.7'
+end