mkuzmin-rbvmomi 1.8.2.1

data/lib/rbvmomi/vim/HostSystem.rb

@@ -0,0 +1,174 @@
+module RbVmomi
+
+class VIM::HostSystem
+  def esxcli
+    @cached_esxcli ||= VIM::EsxcliNamespace.root(self)
+  end
+
+  def dtm
+    @cached_dtm ||= begin
+        RetrieveDynamicTypeManager()
+      rescue VIM::MethodNotFound
+        if summary.config.product.version >= '4.1.0'
+          if summary.config.product.version < '5.0.0' and direct?
+            VIM::InternalDynamicTypeManager(_connection, 'ha-dynamic-type-manager')
+          else
+            raise "esxcli not supported through VC before 5.0.0"
+          end
+        else
+          raise "esxcli not supported before 4.1.0"
+        end
+      end
+  end
+
+  def dti
+    @cached_dti ||= dtm.DynamicTypeMgrQueryTypeInfo
+  end
+
+  def create_dynamic_managed_object inst
+    wsdlName = dti.managedTypeInfo.find { |x| x.name == inst.moType }.wsdlName
+    _connection.type(wsdlName).new(_connection, inst.id)
+  end
+
+  def cli_info_fetcher
+    # XXX there can be more than one
+    return @cached_cli_info_fetcher if @cached_cli_info_fetcher
+    inst = dtm.DynamicTypeMgrQueryMoInstances.find { |x| x.moType == 'vim.CLIInfo' }
+    @cached_cli_info_fetcher = create_dynamic_managed_object inst
+  end
+
+  def mme
+    @cached_mme ||= RetrieveManagedMethodExecuter()
+  end
+
+  def direct?
+    @ref == 'ha-host'
+  end
+end
+
+class VIM::EsxcliNamespace
+  ESXCLI_PREFIX = 'vim.EsxCLI.'
+
+  attr_reader :name, :parent, :host, :type, :instance, :type_info, :namespaces, :commands
+
+  def self.root host
+    type_hash = host.dti.toRbvmomiTypeHash
+    VIM.loader.add_types type_hash
+    all_instances = host.dtm.DynamicTypeMgrQueryMoInstances
+    instances = Hash[all_instances.select { |x| x.moType.start_with? ESXCLI_PREFIX }.
+                                   map { |x| [x.moType,x.id] }]
+    type_infos = Hash[host.dti.managedTypeInfo.map { |x| [x.name,x] }]
+    new('root', nil, host).tap do |root|
+      instances.each do |type,instance|
+        path = type.split('.')[2..-1]
+        ns = path.inject(root) { |b,v| b.namespaces[v] }
+        ns.realize type, instance, type_infos[type]
+      end
+    end
+  end
+
+  def initialize name, parent, host
+    @name = name
+    @parent = parent
+    @host = host
+    @type = nil
+    @instance = nil
+    @type_info = nil
+    @namespaces = Hash.new { |h,k| h[k] = self.class.new k, self, host }
+    @commands = {}
+    @cached_cli_info = nil
+  end
+
+  def realize type, instance, type_info
+    fail if @type or @instance
+    @type = type
+    @instance = instance
+    @type_info = type_info
+    @type_info.method.each do |method_type_info|
+      name = method_type_info.name
+      @commands[name] = VIM::EsxcliCommand.new self, method_type_info
+    end
+  end
+
+  def type_name
+    if @type then @type
+    elsif @parent then "#{@parent.type_name}.#{@name}"
+    else 'vim.EsxCLI'
+    end
+  end
+
+  def cli_info
+    @cached_cli_info ||=
+      if @host.direct?
+        @host.cli_info_fetcher.VimCLIInfoFetchCLIInfo(:typeName => type_name)
+      else
+        @host.mme.execute(@host.cli_info_fetcher._ref,
+                          "vim.CLIInfo.FetchCLIInfo", :typeName => type_name)
+      end
+  end
+
+  def obj
+    conn = @host._connection
+    conn.type(@type_info.wsdlName).new(conn, @instance)
+  end
+
+  def method_missing name, *args
+    name = name.to_s
+    if @namespaces.member? name and args.empty?
+      @namespaces[name]
+    elsif @commands.member? name
+      @commands[name].call *args
+    else
+      raise NoMethodError
+    end
+  end
+
+  def pretty_print q
+    q.text @name
+    q.text ' '
+    q.group 2 do
+      q.text '{'
+      q.breakable
+      items = (@namespaces.values+@commands.values).sort_by(&:name)
+      q.seplist items, nil, :each do |v|
+        if v.is_a? VIM::EsxcliNamespace
+          q.pp v
+        else
+          q.text v.name
+        end
+      end
+    end
+    q.breakable
+    q.text '}'
+  end
+end
+
+class VIM::EsxcliCommand
+  attr_reader :ns, :type_info, :cli_info
+
+  def initialize ns, type_info
+    @ns = ns
+    @type_info = type_info
+    @cached_cli_info = nil
+  end
+
+  def name
+    @type_info.name
+  end
+
+  def cli_info
+    @cached_cli_info ||= @ns.cli_info.method.find { |x| x.name == @type_info.name }
+  end
+
+  def call args={}
+    if @ns.host.direct?
+      @ns.obj._call @type_info.wsdlName, args
+    else
+      real_args = Set.new(type_info.paramTypeInfo.map(&:name))
+      args = args.reject { |k,v| !real_args.member?(k.to_s) }
+      @ns.host.mme.execute(@ns.obj._ref, "#{@ns.type_name}.#{@type_info.name}", args)
+    end
+  end
+end
+
+end

data/lib/rbvmomi/vim/ManagedEntity.rb

@@ -0,0 +1,57 @@
+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,60 @@
+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,23 @@
+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,23 @@
+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,200 @@
+# @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.
+  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 => "",
+      :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}", STDOUT => "/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