rbvmomi 1.6.0 → 1.8.0

data/lib/rbvmomi/vim.rb

@@ -13,6 +13,7 @@ class VIM < Connection
   # @option opts [Numeric] :port (443) Port to connect to.
   # @option opts [Boolean] :ssl (true) Whether to use SSL.
   # @option opts [Boolean] :insecure (false) If true, ignore SSL certificate errors.
+  # @option opts [String]  :cookie If set, use cookie to connect instead of user/password
   # @option opts [String]  :user (root) Username.
   # @option opts [String]  :password Password.
   # @option opts [String]  :path (/sdk) SDK endpoint path.
@@ -20,6 +21,7 @@ class VIM < Connection
   def self.connect opts
     fail unless opts.is_a? Hash
     fail "host option required" unless opts[:host]
+    opts[:cookie] ||= nil
     opts[:user] ||= 'root'
     opts[:password] ||= ''
     opts[:ssl] = true unless opts.member? :ssl or opts[:"no-ssl"]
@@ -32,10 +34,12 @@ class VIM < Connection
     opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
 
     new(opts).tap do |vim|
-      vim.serviceContent.sessionManager.Login :userName => opts[:user], :password => opts[:password]
+      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.0'].min
+        vim.rev = [rev, '5.5'].min
       end
     end
   end
@@ -45,7 +49,7 @@ class VIM < Connection
     self.cookie = nil
     super
   end
-  
+
   def rev= x
     super
     @serviceContent = nil
@@ -86,6 +90,35 @@ class VIM < Connection
     pp.text "VIM(#{@opts[:host]})"
   end
 
+  def instanceUuid
+    serviceContent.about.instanceUuid
+  end
+
+  def get_log_lines logKey, lines=5, start=nil, host=nil
+    diagMgr = self.serviceContent.diagnosticManager
+    if !start
+      log = diagMgr.BrowseDiagnosticLog(host: host, key: logKey, start: 999999999)
+      lineEnd = log.lineEnd
+      start = lineEnd - lines
+    end
+    start = start < 0 ? 0 : start
+    log = diagMgr.BrowseDiagnosticLog(host: host, key: logKey, start: start)
+    if log.lineText.size > 0
+      [log.lineText.slice(-lines, log.lineText.size), log.lineEnd]
+    else
+      [log.lineText, log.lineEnd]
+    end
+  end
+
+  def get_log_keys host=nil
+    diagMgr = self.serviceContent.diagnosticManager
+    keys = []
+    diagMgr.QueryDescriptions(host: host).each do |desc|
+      keys << "#{desc.key}"
+    end
+    keys
+  end
+
   add_extension_dir File.join(File.dirname(__FILE__), "vim")
   (ENV['RBVMOMI_VIM_EXTENSION_PATH']||'').split(':').each { |dir| add_extension_dir dir }
 

data/lib/rbvmomi/vim/Folder.rb

@@ -53,6 +53,16 @@ class RbVmomi::VIM::Folder
     x if x.is_a? type
   end
 
+  # Retrieve a managed entity by inventory path.
+  # @param path [String] A path of the form "My Folder/My Datacenter/vm/Discovered VM/VM1"
+  # @return [VIM::ManagedEntity]
+  def findByInventoryPath path
+    propSpecs = {
+      :entity => self, :inventoryPath => path
+    }
+    x = _connection.searchIndex.FindByInventoryPath(propSpecs)
+  end
+
   # Alias to <tt>traverse path, type, true</tt>
   # @see #traverse
   def traverse! path, type=Object

data/lib/rbvmomi/vim/ManagedObject.rb

@@ -35,7 +35,12 @@ class RbVmomi::VIM::ManagedObject
         :type => self.class.wsdl_name
       }]
     }
-    _connection.propertyCollector.RetrieveProperties(:specSet => [spec])[0].to_hash
+    ret = _connection.propertyCollector.RetrieveProperties(:specSet => [spec])
+    if ret && ret.length > 0
+      ret[0].to_hash
+    else
+      {}
+    end
   end
 
   # Efficiently retrieve multiple properties from an object.

data/lib/rbvmomi/vim/OvfManager.rb

@@ -48,7 +48,16 @@ class RbVmomi::VIM::OvfManager
       result.warning.each{|x| puts "OVF Warning: #{x.localizedMessage.chomp}" }
     end
 
-    nfcLease = opts[:resourcePool].ImportVApp(:spec => result.importSpec,
+    importSpec = result.importSpec
+    if importSpec && importSpec.instantiationOst && importSpec.instantiationOst.child
+      importSpec.instantiationOst.child.each do |child|
+        child.section.map do |section|
+          section.xml = _handle_ost(section.xml, opts)
+        end
+      end
+    end
+    
+    nfcLease = opts[:resourcePool].ImportVApp(:spec => importSpec,
                                               :folder => opts[:vmFolder],
                                               :host => opts[:host])
 
@@ -56,9 +65,32 @@ class RbVmomi::VIM::OvfManager
     raise nfcLease.error if nfcLease.state == "error"
     begin
       nfcLease.HttpNfcLeaseProgress(:percent => 5)
+      timeout, = nfcLease.collect 'info.leaseTimeout'
+      puts "DEBUG: Timeout: #{timeout}"
+      if timeout < 4 * 60
+        puts "WARNING: OVF upload NFC lease timeout less than 4 minutes"
+      end
       progress = 5.0
       result.fileItem.each do |fileItem|
-        deviceUrl = nfcLease.info.deviceUrl.find{|x| x.importKey == fileItem.deviceId}
+        leaseInfo, leaseState, leaseError = nfcLease.collect 'info', 'state', 'error'
+        # Retry nfcLease.collect because of PR 969599:
+        # If retrying property collector works, this means there is a network
+        # or VC overloading problem.
+        retrynum = 5
+        i = 1
+        while i <= retrynum && !leaseState
+          puts "Retrying at iteration #{i}"
+          sleep 1
+          leaseInfo, leaseState, leaseError = nfcLease.collect 'info', 'state', 'error'
+          i += 1
+        end
+        if leaseState != "ready"
+          raise "NFC lease is no longer ready: #{leaseState}: #{leaseError}"
+        end
+        if leaseInfo == nil
+          raise "NFC lease disappeared?"
+        end
+        deviceUrl = leaseInfo.deviceUrl.find{|x| x.importKey == fileItem.deviceId}
         if !deviceUrl
           raise "Couldn't find deviceURL for device '#{fileItem.deviceId}'"
         end
@@ -74,12 +106,25 @@ class RbVmomi::VIM::OvfManager
 
         keepAliveThread = Thread.new do
           while true
-            sleep 2 * 60
             nfcLease.HttpNfcLeaseProgress(:percent => progress.to_i)
+            sleep 1 * 60
           end
         end
 
-        href = deviceUrl.url.gsub("*", opts[:host].config.network.vnic[0].spec.ip.ipAddress)
+        i = 1
+        ip = nil
+        begin
+          begin
+            puts "Iteration #{i}: Trying to get host's IP address ..."
+            ip = opts[:host].config.network.vnic[0].spec.ip.ipAddress
+          rescue Exception=>e
+            puts "Iteration #{i}: Couldn't get host's IP address: #{e}"
+          end
+          sleep 1
+          i += 1
+        end while i <= 5 && !ip
+        raise "Couldn't get host's IP address" unless ip
+        href = deviceUrl.url.gsub("*", ip)
         downloadCmd = "#{CURLBIN} -L '#{URI::escape(filename)}'"
         uploadCmd = "#{CURLBIN} -Ss -X #{method} --insecure -T - -H 'Content-Type: application/x-vnd.vmware-streamVmdk' '#{URI::escape(href)}'"
         # Previously we used to append "-H 'Content-Length: #{fileItem.size}'"
@@ -96,12 +141,56 @@ class RbVmomi::VIM::OvfManager
       end
 
       nfcLease.HttpNfcLeaseProgress(:percent => 100)
-      vm = nfcLease.info.entity
-      nfcLease.HttpNfcLeaseComplete
+      raise nfcLease.error if nfcLease.state == "error"
+      i = 1
+      vm = nil
+      begin
+        begin
+          puts "Iteration #{i}: Trying to access nfcLease.info.entity ..."
+          vm = nfcLease.info.entity
+        rescue Exception=>e
+          puts "Iteration #{i}: Couldn't access nfcLease.info.entity: #{e}"
+        end
+        sleep 1
+        i += 1
+      end while i <= 5 && !vm
+      raise "Couldn't access nfcLease.info.entity" unless vm
+
+      # Ignore sporadic connection errors caused by PR 1019166..
+      # Three attempts are made to execute HttpNfcLeaseComplete.
+      # Not critical if none goes through, as long as vm is obtained
+      #
+      # TODO: find the reason why HttpNfcLeaseComplete gets a wrong
+      # response (RetrievePropertiesResponse)
+      i = 0
+      begin
+        nfcLease.HttpNfcLeaseComplete
+        puts "HttpNfcLeaseComplete succeeded"
+      rescue RbVmomi::VIM::InvalidState
+        puts "HttpNfcLeaseComplete already finished.."
+      rescue Exception => e
+        puts "HttpNfcLeaseComplete failed at iteration #{i} with exception: #{e}"
+        i += 1
+        retry if i < 3
+        puts "Giving up HttpNfcLeaseComplete.."
+      end
       vm
     end
   rescue Exception
     (nfcLease.HttpNfcLeaseAbort rescue nil) if nfcLease
     raise
   end
+  
+  def _handle_ost ost, opts = {}
+    ost = Nokogiri::XML(ost)
+    if opts[:vservice] == ['com.vmware.vim.vsm:extension_vservice']
+      ost.xpath('//vmw:Annotations/vmw:Providers/vmw:Provider').each do |x|
+        x['vmw:selected'] = 'selected'
+      end
+      ost.xpath('//vmw:Annotations/vmw:Providers').each do |x|
+        x['vmw:selected'] = 'com.vmware.vim.vsm:extension_vservice'
+      end
+    end
+    ost.to_s
+  end
 end

data/lib/rbvmomi/vim/PerformanceManager.rb

@@ -46,13 +46,21 @@ class RbVmomi::VIM::PerformanceManager
       end
     end
       
-    metric_ids = metrics.map do |x| 
+    instances = opts[:instance] || '*'
+    if !instances.is_a?(Array)
+      instances = [instances]
+    end
+    metric_ids = []
+    metrics.each do |x| 
       counter = perfcounter_hash[x]
       if !counter
         pp perfcounter_hash.keys
         fail "Counter for #{x} couldn't be found"
       end
-      RbVmomi::VIM::PerfMetricId(:counterId => counter.key, :instance => '*')
+      instances.each do |instance|
+        metric_ids << RbVmomi::VIM::PerfMetricId(:counterId => counter.key, 
+                                                 :instance => instance)
+      end
     end
     query_specs = objects.map do |obj|
       RbVmomi::VIM::PerfQuerySpec({
@@ -65,19 +73,36 @@ class RbVmomi::VIM::PerformanceManager
     end
     stats = QueryPerf(:querySpec => query_specs)
     
-    Hash[stats.map do |res|
-      [
-        res.entity, 
-        {
-          :sampleInfo => res.sampleInfo,
-          :metrics => Hash[res.value.map do |metric|
-            [perfcounter_idhash[metric.id.counterId].name, metric.value]
-          end]
-        }
-      ]
-    end]
+    if !opts[:multi_instance]
+      Hash[stats.map do |res|
+        [
+          res.entity, 
+          {
+            :sampleInfo => res.sampleInfo,
+            :metrics => Hash[res.value.map do |metric|
+              metric_name = perfcounter_idhash[metric.id.counterId].name
+              [metric_name, metric.value]
+            end]
+          }
+        ]
+      end]
+    else
+      Hash[stats.map do |res|
+        [
+          res.entity, 
+          {
+            :sampleInfo => res.sampleInfo,
+            :metrics => Hash[res.value.map do |metric|
+              metric_name = perfcounter_idhash[metric.id.counterId].name
+              [[metric_name, metric.id.instance], metric.value]
+            end]
+          }
+        ]
+      end]
+    end
   end
 
+
   def active_intervals
     intervals = historicalInterval
     Hash[(1..4).map { |level| [level, intervals.select { |x| x.enabled && x.level >= level }] }]

data/lib/rbvmomi/vim/Task.rb

@@ -54,7 +54,7 @@ class RbVmomi::VIM::Task
   def child_tasks
     tm = _connection.serviceContent.taskManager
     col = tm.CreateCollectorForTasks(:filter => {
-      :rootTaskKey => self.info.key
+      :rootTaskKey => [self.info.key],
     })
     # XXX: Likely this is not enough and we need to collect pages other
     #      than the latest.

data/lib/rbvmomi/vim/VirtualMachine.rb

@@ -34,26 +34,41 @@ class RbVmomi::VIM::VirtualMachine
   def add_delta_disk_layer_on_all_disks
     devices,  = self.collect 'config.hardware.device'
     disks = devices.grep(RbVmomi::VIM::VirtualDisk)
-    # XXX: Should create a single reconfig spec instead of one per disk
+    spec = update_spec_add_delta_disk_layer_on_all_disks
+    self.ReconfigVM_Task(:spec => spec).wait_for_completion
+  end
+  
+  # Updates a passed in spec to perform the task of adding a delta disk layer
+  # on top of all disks. Does the same as add_delta_disk_layer_on_all_disks
+  # but instead of issuing the ReconfigVM_Task, it just constructs the 
+  # spec, so that the caller can batch a couple of updates into one 
+  # ReconfigVM_Task.
+  def update_spec_add_delta_disk_layer_on_all_disks spec = {}
+    devices,  = self.collect 'config.hardware.device'
+    disks = devices.grep(RbVmomi::VIM::VirtualDisk)
+    device_change = []
     disks.each do |disk|
-      spec = {
-        :deviceChange => [
-          {
-            :operation => :remove,
-            :device => disk
-          },
-          {
-            :operation => :add,
-            :fileOperation => :create,
-            :device => disk.dup.tap { |x|
-              x.backing = x.backing.dup
-              x.backing.fileName = "[#{disk.backing.datastore.name}]"
-              x.backing.parent = disk.backing
-            },
-          }
-        ]
+      device_change << {
+        :operation => :remove,
+        :device => disk
       }
-      self.ReconfigVM_Task(:spec => spec).wait_for_completion
+      device_change << {
+        :operation => :add,
+        :fileOperation => :create,
+        :device => disk.dup.tap { |x|
+          x.backing = x.backing.dup
+          x.backing.fileName = "[#{disk.backing.datastore.name}]"
+          x.backing.parent = disk.backing
+        },
+      }
+    end
+    if spec.is_a?(RbVmomi::VIM::VirtualMachineConfigSpec)
+      spec.deviceChange ||= []
+      spec.deviceChange += device_change
+    else
+      spec[:deviceChange] ||= []
+      spec[:deviceChange] += device_change
     end
+    spec
   end 
 end

data/test/test_deserialization.rb

@@ -252,11 +252,14 @@ end
       :connectionState => "connected",
       :dynamicProperty => [],
       :faultToleranceState => "notConfigured",
+      :featureMask => [],
+      :featureRequirement => [],
       :host => VIM::HostSystem(nil, "host-32"),
       :maxCpuUsage => 5612,
       :maxMemoryUsage => 3072,
       :memoryOverhead => 128671744,
       :numMksConnections => 1,
+      :offlineFeatureRequirement => [],
       :powerState => "poweredOn",
       :recordReplayState => "inactive",
       :suspendInterval => 0,

data/test/test_serialization.rb

@@ -287,9 +287,9 @@ class SerializationTest < Test::Unit::TestCase
   end
 
   def test_time
-    obj = Time.at DateTime.new(2011, 11, 16, 13, 36, 8, Rational(-8,24)).strftime("%s").to_i
+    obj = Time.at(DateTime.new(2011, 11, 16, 13, 36, 8, Rational(-8,24)).strftime("%s").to_i).getgm
     check <<-EOS, obj, 'xsd:dateTime', false
-<root>2011-11-16T13:36:08-08:00</root>
+<root>2011-11-16T21:36:08Z</root>
     EOS
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbvmomi
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -80,6 +80,7 @@ files:
 - devel/benchmark.rb
 - devel/collisions.rb
 - devel/merge-internal-vmodl.rb
+- devel/merge-manual-vmodl.rb
 - examples/annotate.rb
 - examples/cached_ovf_deploy.rb
 - examples/clone_vm.rb
@@ -102,12 +103,16 @@ files:
 - lib/rbvmomi/connection.rb
 - lib/rbvmomi/deserialization.rb
 - lib/rbvmomi/fault.rb
+- lib/rbvmomi/pbm.rb
+- lib/rbvmomi/sms.rb
+- lib/rbvmomi/sms/SmsStorageManager.rb
 - lib/rbvmomi/trivial_soap.rb
 - lib/rbvmomi/trollop.rb
 - lib/rbvmomi/type_loader.rb
 - lib/rbvmomi/utils/admission_control.rb
 - lib/rbvmomi/utils/deploy.rb
 - lib/rbvmomi/utils/leases.rb
+- lib/rbvmomi/utils/perfdump.rb
 - lib/rbvmomi/vim.rb
 - lib/rbvmomi/vim/ComputeResource.rb
 - lib/rbvmomi/vim/Datacenter.rb