rbvmomi2 3.0.0

data/lib/rbvmomi/vim/ManagedEntity.rb

@@ -0,0 +1,60 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::VIM::ManagedEntity
+  # Retrieve the ancestors of the entity.
+  # @return [Array] Ancestors of this entity, starting with the root.
+  def path
+    self.class.paths([self])[self]
+  end
+  
+  # Retrieve the ancestors of a list of entries.
+  # @return [Hash] Object-indexed hash of ancestors of entities, starting with the root.
+  def self.paths objs
+    filterSpec = RbVmomi::VIM.PropertyFilterSpec(
+      :objectSet => objs.map do |obj|
+        RbVmomi::VIM.ObjectSpec(
+          :obj => obj,
+          :selectSet => [
+            RbVmomi::VIM.TraversalSpec(
+              :name => "tsME",
+              :type => 'ManagedEntity',
+              :path => 'parent',
+              :skip => false,
+              :selectSet => [
+                RbVmomi::VIM.SelectionSpec(:name => "tsME")
+              ]
+            )
+          ]
+        )
+      end,
+      :propSet => [{
+        :pathSet => %w(name parent),
+        :type => 'ManagedEntity'
+      }]
+    )
+
+    propCollector = objs.first._connection.propertyCollector
+    result = propCollector.RetrieveProperties(:specSet => [filterSpec])
+
+    Hash[objs.map do |obj|
+      tree = {}
+      result.each { |x| tree[x.obj] = [x['parent'], x['name']] }
+      a = []
+      cur = obj
+      while cur
+        parent, name = *tree[cur]
+        a << [cur, name]
+        cur = parent
+      end
+      [obj, a.reverse]
+    end]
+  end
+
+  # Return a string representation of +path+ suitable for display.
+  # @return [String]
+  # @see #path
+  def pretty_path
+    path[1..-1].map { |x| x[1] } * '/'
+  end
+end

data/lib/rbvmomi/vim/ManagedObject.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::VIM::ManagedObject
+  # Wait for updates on an object until a condition becomes true.
+  #
+  # @param pathSet [Array] Property paths to wait for updates to.
+  # @yield Called when an update to a subscribed property occurs.
+  # @yieldreturn [Boolean] Whether to stop waiting.
+  #
+  # @todo Pass the current property values to the block.
+  def wait_until *pathSet, &b
+    all = pathSet.empty?
+    filter = _connection.propertyCollector.CreateFilter :spec => {
+      :propSet => [{ :type => self.class.wsdl_name, :all => all, :pathSet => pathSet }],
+      :objectSet => [{ :obj => self }],
+    }, :partialUpdates => false
+    ver = ''
+    loop do
+      result = _connection.propertyCollector.WaitForUpdates(:version => ver)
+      ver = result.version
+      if x = b.call
+        return x
+      end
+    end
+  ensure
+    filter.DestroyPropertyFilter if filter
+  end
+
+  # Efficiently retrieve multiple properties from an object.
+  # @param pathSet [Array] Properties to return.
+  # @return [Hash] Hash from property paths to values.
+  def collect! *pathSet
+    spec = {
+      :objectSet => [{ :obj => self }],
+      :propSet => [{
+        :pathSet => pathSet,
+        :type => self.class.wsdl_name
+      }]
+    }
+    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.
+  # @param pathSet (see #collect!)
+  # @yield [*values] Property values in same order as +pathSet+.
+  # @return [Array] Property values in same order as +pathSet+, or the return
+  #                 value from the block if it is given.
+  def collect *pathSet
+    h = collect!(*pathSet)
+    a = pathSet.map { |k| h[k.to_s] }
+    if block_given?
+      yield a
+    else
+      a
+    end
+  end
+end

data/lib/rbvmomi/vim/ObjectContent.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::VIM::ObjectContent
+  # Represent this ObjectContent as a hash.
+  # @return [Hash] A hash from property paths to values.
+  def to_hash
+    @cached_hash ||= to_hash_uncached
+  end
+
+  # Alias for +to_hash[k]+.
+  def [](k)
+    to_hash[k]
+  end
+
+  private
+
+  def to_hash_uncached
+    h = {}
+    propSet.each do |x|
+      fail if h.member? x.name
+      h[x.name] = x.val
+    end
+    h
+  end
+end

data/lib/rbvmomi/vim/ObjectUpdate.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::VIM::ObjectUpdate
+  # Represent this ObjectUpdate as a hash.
+  # @return [Hash] A hash from property paths to values.
+  def to_hash
+    @cached_hash ||= to_hash_uncached
+  end
+
+  # Alias for +to_hash[k]+.
+  def [](k)
+    to_hash[k]
+  end
+
+  private
+
+  def to_hash_uncached
+    h = {}
+    changeSet.each do |x|
+      fail if h.member? x.name
+      h[x.name] = x.val
+    end
+    h
+  end
+end

data/lib/rbvmomi/vim/OvfManager.rb

@@ -0,0 +1,204 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+# @note +deployOVF+ and requires +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+.
+class RbVmomi::VIM::OvfManager
+  CURLBIN = ENV['CURL'] || "curl" #@private
+
+  # Deploy an OVF.
+  #
+  # @param [Hash] opts The options hash.
+  # @option opts [String]             :uri Location of the OVF.
+  # @option opts [String]             :vmName Name of the new VM.
+  # @option opts [VIM::Folder]        :vmFolder Folder to place the VM in.
+  # @option opts [VIM::HostSystem]    :host Host to use.
+  # @option opts [VIM::ResourcePool]  :resourcePool Resource pool to use.
+  # @option opts [VIM::Datastore]     :datastore Datastore to use.
+  # @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 => {},
+             :diskProvisioning => :thin }.merge opts
+
+    %w(uri vmName vmFolder host resourcePool datastore).each do |k|
+      fail "parameter #{k} required" unless opts[k.to_sym]
+    end
+
+    ovfImportSpec = RbVmomi::VIM::OvfCreateImportSpecParams(
+      :hostSystem => opts[:host],
+      :locale => "US",
+      :entityName => opts[:vmName],
+      :deploymentOption => opts[:deploymentOption] || "",
+      :networkMapping => opts[:networkMappings].map{|from, to| RbVmomi::VIM::OvfNetworkMapping(:name => from, :network => to)},
+      :propertyMapping => opts[:propertyMappings].to_a,
+      :diskProvisioning => opts[:diskProvisioning]
+    )
+
+    result = CreateImportSpec(
+      :ovfDescriptor => open(opts[:uri]).read,
+      :resourcePool => opts[:resourcePool],
+      :datastore => opts[:datastore],
+      :cisp => ovfImportSpec
+    )
+
+    raise result.error[0].localizedMessage if result.error && !result.error.empty?
+
+    if result.warning
+      result.warning.each{|x| puts "OVF Warning: #{x.localizedMessage.chomp}" }
+    end
+
+    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])
+
+    nfcLease.wait_until(:state) { nfcLease.state != "initializing" }
+    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|
+        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
+
+        ovfFilename = opts[:uri].to_s
+        tmp = ovfFilename.split(/\//)
+        tmp.pop
+        tmp << fileItem.path
+        filename = tmp.join("/")
+
+        # If filename doesn't have a URI scheme, we're considering it a local file
+        if URI(filename).scheme.nil?
+          filename = "file://" + filename
+        end
+
+        method = fileItem.create ? "PUT" : "POST"
+
+        keepAliveThread = Thread.new do
+          while true
+            nfcLease.HttpNfcLeaseProgress(:percent => progress.to_i)
+            sleep 1 * 60
+          end
+        end
+
+        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}'"
+        # to the uploadCmd. It is not clear to me why, but that leads to 
+        # trucation of the uploaded disk. Without this option curl can't tell
+        # the progress, but who cares
+        system("#{downloadCmd} | #{uploadCmd}", :out => "/dev/null")
+        
+        keepAliveThread.kill
+        keepAliveThread.join
+        
+        progress += (90.0 / result.fileItem.length)
+        nfcLease.HttpNfcLeaseProgress(:percent => progress.to_i)
+      end
+
+      nfcLease.HttpNfcLeaseProgress(:percent => 100)
+      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/PerfCounterInfo.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+class RbVmomi::VIM::PerfCounterInfo
+  def name
+    "#{groupInfo.key}.#{nameInfo.key}"
+  end
+end
+

data/lib/rbvmomi/vim/PerformanceManager.rb

@@ -0,0 +1,113 @@
+# Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+require 'date'
+
+class Time
+  def to_datetime
+    # Convert seconds + microseconds into a fractional number of seconds
+    seconds = sec + Rational(usec, 10**6)
+
+    # Convert a UTC offset measured in minutes to one measured in a
+    # fraction of a day.
+    offset = Rational(utc_offset, 60 * 60 * 24)
+    DateTime.new(year, month, day, hour, min, seconds, offset)
+  end
+end
+
+RbVmomi::VIM::PerformanceManager
+class RbVmomi::VIM::PerformanceManager
+  def perfcounter_cached
+    @perfcounter ||= perfCounter
+  end
+  
+  def perfcounter_hash
+    @perfcounter_hash ||= Hash[perfcounter_cached.map{|x| [x.name, x]}]
+  end
+  
+  def perfcounter_idhash 
+    @perfcounter_idhash ||= Hash[perfcounter_cached.map{|x| [x.key, x]}]
+  end
+  
+  def provider_summary obj
+    @provider_summary ||= {}
+    @provider_summary[obj.class] ||= QueryPerfProviderSummary(:entity => obj)
+  end
+
+  def retrieve_stats objects, metrics, opts = {}
+    opts = opts.dup
+    max_samples = opts[:max_samples] || 1
+    realtime = false
+    if not opts[:interval]
+      provider = provider_summary objects.first
+      opts[:interval] = provider.refreshRate
+      realtime = true
+    else
+      provider = provider_summary objects.first
+      if opts[:interval] == provider.refreshRate
+        realtime = true
+      end
+    end
+      
+    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
+      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({
+        :maxSample => max_samples, 
+        :entity => obj, 
+        :metricId => metric_ids, 
+        :intervalId => opts[:interval],
+        :startTime => (realtime == false ? opts[:start_time].to_datetime : nil),
+      })
+    end
+    stats = QueryPerf(:querySpec => query_specs)
+    
+    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 }] }]
+  end
+end

data/lib/rbvmomi/vim/PropertyCollector.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::VIM::PropertyCollector
+  def collectMultiple objs, *pathSet
+    return {} if objs.empty?
+
+    klasses = objs.map{|x| x.class}.uniq 
+    klass = if klasses.length > 1
+      # common superclass
+      klasses.map(&:ancestors).inject(&:&)[0]
+    else
+      klasses.first
+    end
+
+    spec = {
+      :objectSet => objs.map{|x| { :obj => x }},
+      :propSet => [{
+        :pathSet => pathSet,
+        :type => klass.wsdl_name
+      }]
+    }
+    res = RetrieveProperties(:specSet => [spec])
+    Hash[res.map do |x|
+      [x.obj, x.to_hash]
+    end]
+  end
+end

data/lib/rbvmomi/vim/ReflectManagedMethodExecuter.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+module RbVmomi
+
+class VIM::ReflectManagedMethodExecuter
+  def fetch moid, prop
+    result = FetchSoap(:moid => moid, :version => 'urn:vim25/6.5', :prop => prop)
+    xml = Nokogiri(result.response)
+    _connection.deserializer.deserialize xml.root, nil
+  end
+
+  def execute moid, method, args
+    soap_args = args.map do |k,v|
+      VIM::ReflectManagedMethodExecuterSoapArgument.new.tap do |soap_arg|
+        soap_arg.name = k
+        xml = Builder::XmlMarkup.new :indent => 0
+        _connection.obj2xml xml, k, :anyType, false, v
+        soap_arg.val = xml.target!
+      end
+    end
+    result = ExecuteSoap(:moid => moid, :version => 'urn:vim25/6.5',
+                         :method => method, :argument => soap_args)
+    if result
+      _connection.deserializer.deserialize Nokogiri(result.response).root, nil
+    else
+      nil
+    end
+  end
+end
+
+end
+

data/lib/rbvmomi/vim/ResourcePool.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::VIM::ResourcePool
+  # Retrieve a child ResourcePool.
+  # @param name [String] Name of the child.
+  # @return [VIM::ResourcePool]
+  def find name
+    _connection.searchIndex.FindChild(:entity => self, :name => name)
+  end
+
+  # Retrieve a descendant of this ResourcePool.
+  # @param path [String] Path delimited by '/'.
+  # @return [VIM::ResourcePool]
+  def traverse path
+    es = path.split('/').reject(&:empty?)
+    es.inject(self) do |f,e|
+      f.find(e) || return
+    end
+  end
+
+  def resourcePoolSubTree fields = []
+    self.class.resourcePoolSubTree [self], fields
+  end
+  
+  def self.resourcePoolSubTree objs, fields = []
+    fields = (fields + ['name', 'resourcePool']).uniq
+    filterSpec = RbVmomi::VIM.PropertyFilterSpec(
+      :objectSet => objs.map do |obj|
+        RbVmomi::VIM.ObjectSpec(
+          :obj => obj,
+          :selectSet => [
+            RbVmomi::VIM.TraversalSpec(
+              :name => "tsRP",
+              :type => 'ResourcePool',
+              :path => 'resourcePool',
+              :skip => false,
+              :selectSet => [
+                RbVmomi::VIM.SelectionSpec(:name => "tsRP")
+              ]
+            )
+          ]
+        )
+      end,
+      :propSet => [{
+        :pathSet => fields,
+        :type => 'ResourcePool'
+      }]
+    )
+  
+    propCollector = objs.first._connection.propertyCollector
+    result = propCollector.RetrieveProperties(:specSet => [filterSpec])
+    
+    Hash[result.map do |x|
+      [x.obj, x.to_hash]
+    end]
+  end
+end