rbvmomi 1.8.2 → 2.4.1

data/lib/rbvmomi/trivial_soap.rb

@@ -1,4 +1,6 @@
-# Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
 require 'rubygems'
 require 'builder'
 require 'nokogiri'
@@ -6,7 +8,7 @@ require 'net/http'
 require 'pp'
 
 class RbVmomi::TrivialSoap
-  attr_accessor :debug, :cookie
+  attr_accessor :debug, :cookie, :operation_id
   attr_reader :http
 
   def initialize opts
@@ -15,6 +17,8 @@ class RbVmomi::TrivialSoap
     return unless @opts[:host] # for testcases
     @debug = @opts[:debug]
     @cookie = @opts[:cookie]
+    @sso = @opts[:sso]
+    @operation_id = @opts[:operation_id]
     @lock = Mutex.new
     @http = nil
     restart_http
@@ -39,17 +43,14 @@ class RbVmomi::TrivialSoap
     if @opts[:ssl]
       require 'net/https'
       @http.use_ssl = true
-      if @opts[:insecure]
-        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      else
-        @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      end
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @opts[:insecure]
+      @http.ca_file = @opts[:ca_file] if @opts[:ca_file]
       @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
@@ -62,11 +63,13 @@ class RbVmomi::TrivialSoap
     xsi = 'http://www.w3.org/2001/XMLSchema-instance'
     xml = Builder::XmlMarkup.new :indent => 0
     xml.tag!('env:Envelope', 'xmlns:xsd' => xsd, 'xmlns:env' => env, 'xmlns:xsi' => xsi) do
-      if @vcSessionCookie
+      if @vcSessionCookie || @operation_id
         xml.tag!('env:Header') do
-          xml.tag!('vcSessionCookie', @vcSessionCookie)
+          xml.tag!('vcSessionCookie', @vcSessionCookie) if @vcSessionCookie
+          xml.tag!('operationID', @operation_id) if @operation_id
         end
       end
+
       xml.tag!('env:Body') do
         yield xml if block_given?
       end
@@ -84,6 +87,11 @@ class RbVmomi::TrivialSoap
       $stderr.puts
     end
 
+    if @cookie.nil? && @sso
+      @sso.request_token unless @sso.assertion_id
+      body = @sso.sign_request(body)
+    end
+
     start_time = Time.now
     response = @lock.synchronize do
       begin

data/lib/rbvmomi/type_loader.rb

@@ -1,4 +1,6 @@
-# Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
 require 'set'
 require 'monitor'
 
@@ -93,7 +95,7 @@ class TypeLoader
 
   def load_extension name
     @extension_dirs.map { |x| File.join(x, "#{name}.rb") }.
-                    select { |x| File.exists? x }.
+                    select { |x| File.exist? x }.
                     each { |x| load x }
   end
 

data/lib/rbvmomi/utils/admission_control.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
 
 # An admission controlled resource scheduler for large scale vSphere deployments
 #
@@ -77,11 +80,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 +101,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 +115,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 +134,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 +148,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 +171,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 +205,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 +217,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 +303,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 +333,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 +398,4 @@ class AdmissionControlledResourceScheduler
     datastore = self.datastore @placement_hint
     log "Datastore: #{datastore.name}"
   end
-end
+end

data/lib/rbvmomi/utils/deploy.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
 require 'open-uri'
 require 'nokogiri'
 require 'rbvmomi'
@@ -78,18 +81,17 @@ class CachedOvfDeployer
   # it to be marked as a template. This way, the cost of uploading and keeping
   # the full size of the VM is only paid once.
   # @param ovf_url [String] URL to the OVF to be deployed. Currently only http 
-  #                         and https are supported
+  #   and https are supported.
   # @param template_name [String] Name of the template to be used. Should be the
-  #                               same name for the same URL. A cluster specific
-  #                               post-fix will automatically be added.
-  # @option opts [int]  :run_without_interruptions Whether or not to disable
-  #                                                SIGINT and SIGTERM during
-  #                                                the OVF upload.
+  #   same name for the same URL. A cluster specific post-fix will automatically
+  #   be added.
+  # @option opts [int] :run_without_interruptions Whether or not to disable
+  #   SIGINT and SIGTERM during the OVF upload.
   # @option opts [Hash] :config VM Config delta to apply after the OVF deploy is
-  #                             done. Allows the template to be customized, e.g.
-  #                             to set annotations.
+  #   done. Allows the template to be customized, e.g. to set annotations.
+  # @option opts [Boolean] :no_delta Whether or not to add a delta disk layer.
   # @return [VIM::VirtualMachine] The template as a VIM::VirtualMachine instance
-  def upload_ovf_as_template ovf_url, template_name, opts = {}
+  def upload_ovf_as_template(ovf_url, template_name, opts = {})
     # Optimization: If there happens to be a fully prepared template, then
     # there is no need to do the complicated OVF upload dance
     template = lookup_template template_name
@@ -185,10 +187,12 @@ class CachedOvfDeployer
       # prepare it for (linked) cloning and mark it as a template to signal
       # we are done.
       if !wait_for_template
-        config = opts[:config] || {}
-        config = vm.update_spec_add_delta_disk_layer_on_all_disks(config)
-        # XXX: Should we add a version that does retries?
-        vm.ReconfigVM_Task(:spec => config).wait_for_completion
+        if opts[:no_delta] != true
+          config = opts[:config] || {}
+          config = vm.update_spec_add_delta_disk_layer_on_all_disks(config)
+          # XXX: Should we add a version that does retries?
+          vm.ReconfigVM_Task(:spec => config).wait_for_completion
+        end
         vm.MarkAsTemplate
       end
     end
@@ -311,4 +315,4 @@ class CachedOvfDeployer
     
     vm
   end
-end
+end

data/lib/rbvmomi/utils/leases.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
 require 'yaml'
 
 # A class to manage VM leases
@@ -139,4 +142,4 @@ class LeaseTool
     out = Hash[out]
     out
   end
-end
+end

data/lib/rbvmomi/utils/perfdump.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
 require 'set'
 require 'yaml'
 
@@ -336,7 +339,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,6 @@
+# Copyright (c) 2016-2019 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+module RbVmomi
+  VERSION = '2.4.1'.freeze
+end

data/lib/rbvmomi/vim.rb

@@ -1,5 +1,12 @@
-# Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
-require 'rbvmomi'
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+# Win32::SSPI is part of core on Windows
+begin
+  require 'win32/sspi'
+rescue LoadError
+end
+WIN32 = (defined? Win32::SSPI)
 
 module RbVmomi
 
@@ -18,34 +25,56 @@ class VIM < Connection
   # @option opts [String]  :password Password.
   # @option opts [String]  :path (/sdk) SDK endpoint path.
   # @option opts [Boolean] :debug (false) If true, print SOAP traffic to stderr.
+  # @option opts [String]  :operation_id If set, use for operationID
+  # @option opts [Boolean] :close_on_exit (true) If true, will close connection with at_exit
+  # @option opts [RbVmomi::SSO] :sso (nil) Use SSO token to login if set
   def self.connect opts
     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
     opts[:port] ||= (opts[:ssl] ? 443 : 80)
     opts[:path] ||= '/sdk'
     opts[:ns] ||= 'urn:vim25'
-    rev_given = opts[:rev] != nil
-    opts[:rev] = '4.0' unless rev_given
+    opts[:rev] = '6.7' if opts[:rev].nil?
     opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
 
-    new(opts).tap do |vim|
+    conn = new(opts).tap do |vim|
       unless opts[:cookie]
-        vim.serviceContent.sessionManager.Login :userName => opts[:user], :password => opts[:password]
-      end
-      unless rev_given
-        rev = vim.serviceContent.about.apiVersion
-        vim.rev = [rev, '5.5'].min
+        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
+        elsif opts[:sso]
+          vim.serviceContent.sessionManager.LoginByToken
+        else
+          vim.serviceContent.sessionManager.Login :userName => opts[:user], :password => opts[:password]
+        end
       end
+      rev = vim.serviceContent.about.apiVersion
+      vim.rev = [rev, opts[:rev]].min { |a, b| Gem::Version.new(a) <=> Gem::Version.new(b) }
     end
+
+    at_exit { conn.close } if opts.fetch(:close_on_exit, true)
+    conn
   end
 
   def close
-    VIM::SessionManager(self, 'SessionManager').Logout rescue RbVmomi::Fault
+    serviceContent.sessionManager.Logout
+  rescue RbVmomi::Fault => e
+    $stderr.puts(e.message) if debug
+  ensure
     self.cookie = nil
     super
   end

data/lib/rbvmomi/vim/ComputeResource.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
 class RbVmomi::VIM::ComputeResource
   # Aggregate cluster information.
   #

data/lib/rbvmomi/vim/Datacenter.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
 class RbVmomi::VIM::Datacenter
   # Traverse the given inventory +path+ to find a ComputeResource.
   def find_compute_resource path
@@ -13,5 +16,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

@@ -1,3 +1,6 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
 # @note +download+ and +upload+ require +curl+. If +curl+ is not in your +PATH+
 #       then set the +CURL+ environment variable to point to it.
 # @todo Use an HTTP library instead of executing +curl+.
@@ -63,6 +66,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