rbvmomi 1.2.3 → 1.3.0

data/README.rdoc

@@ -4,7 +4,7 @@
 
 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 4.1 API. RbVmomi specific documentation is
+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].
 

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.3.0

data/examples/extraConfig.rb

@@ -49,6 +49,6 @@ case cmd
 when 'list'
   vm.config.extraConfig.each { |x| puts "#{x.key}: #{x.value}" }
 when 'set'
-  extraConfig = ARGV.map { |x| x.split("=", 2) }.map { |k,v| { :key => k, :value => v } }
+  extraConfig = ARGV[2..-1].map { |x| x.split("=", 2) }.map { |k,v| { :key => k, :value => v } }
   vm.ReconfigVM_Task(:spec => VIM.VirtualMachineConfigSpec(:extraConfig => extraConfig)).wait_for_completion
 end

data/examples/nfs_datastore.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+CMDS = %w(mount unmount)
+
+opts = Trollop.options do
+  banner <<-EOS
+Mount/Unmount an NFS datastore from a cluster or single host system.
+
+Usage:
+    nfs_datastore.rb [options] resource mount nfs-hostname:/remote/path [name]
+    nfs_datastore.rb [options] resource unmount nfs-hostname:/remote/path [name]
+
+Commands: #{CMDS * ' '}
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+VM location options:
+    EOS
+
+    rbvmomi_datacenter_opt
+
+    text <<-EOS
+
+Other options:
+  EOS
+
+  stop_on CMDS
+end
+
+Trollop.die("must specify host") unless opts[:host]
+
+cr_path = ARGV[0] or Trollop.die("no system name given")
+cmd = ARGV[1] or Trollop.die("no command given")
+abort "invalid command" unless CMDS.member? cmd
+nfs_spec = ARGV[2] or Trollop.die("no nfs path given")
+remoteHost, remotePath = nfs_spec.split(":")
+localPath = ARGV[3] || remoteHost
+mode = "readOnly" #hardcoded.
+
+vim = VIM.connect opts
+dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
+cr = dc.find_compute_resource(cr_path) || dc.hostFolder.children.find(cr_path).first
+abort "compute resource not found" unless cr
+
+case cr
+when VIM::ClusterComputeResource
+  hosts = cr.host
+when VIM::ComputeResource
+  hosts = [cr]
+else
+  abort "invalid resource"
+end
+
+hosts.each do |host|
+  hds = host.configManager.datastoreSystem
+
+  ds = hds.datastore.select {|ds|
+    ds.info.respond_to?(:nas) and
+    ds.info.name == localPath and
+    ds.info.nas.remoteHost == remoteHost and
+    ds.info.nas.remotePath == remotePath
+  }.first
+
+  case cmd
+  when 'mount'
+    if ds
+      puts "already mounted on #{host.name} as #{ds.name}"
+    else
+      ds =
+        hds.CreateNasDatastore(:spec => VIM.HostNasVolumeSpec(:remoteHost => remoteHost,
+                                                              :remotePath => remotePath,
+                                                              :localPath  => localPath,
+                                                              :accessMode => mode))
+      puts "mounted on #{host.name} as #{ds.name}"
+    end
+  when 'unmount'
+    if ds
+      hds.RemoveDatastore(:datastore => ds)
+      puts "unmounted from #{host.name}"
+    else
+      puts "not mounted on #{host.name}"
+    end
+  else
+    abort "invalid command"
+  end
+end

data/lib/rbvmomi/basic_types.rb

@@ -111,6 +111,10 @@ class DataObject < ObjectWithProperties
     @props[sym] = val
   end
 
+  def []= sym, val
+    _set_property sym, val
+  end
+
   def == o
     return false unless o.class == self.class
     keys = (props.keys + o.props.keys).uniq
@@ -165,7 +169,7 @@ class ManagedObject < ObjectWithMethods
     }])[0]
 
     if ret.propSet.empty?
-      fail if ret.missingSet.empty?
+      return nil if ret.missingSet.empty?
       raise ret.missingSet[0].fault
     else
       ret.propSet[0].val

data/lib/rbvmomi/trivial_soap.rb

@@ -20,8 +20,17 @@ class RbVmomi::TrivialSoap
     restart_http
   end
 
+  def close
+    @http.finish rescue IOError
+  end
+
   def restart_http
-    @http.finish if @http
+    begin 
+      @http.finish if @http
+    rescue Exception => ex
+      puts "WARNING: Ignoring exception: #{ex.message}"
+      puts ex.backtrace.join("\n")
+    end
     @http = Net::HTTP.new(@opts[:host], @opts[:port], @opts[:proxyHost], @opts[:proxyPort])
     if @opts[:ssl]
       require 'net/https'
@@ -77,8 +86,12 @@ class RbVmomi::TrivialSoap
       end
     end
     end_time = Time.now
+    
+    if response.is_a? Net::HTTPServiceUnavailable
+      raise "Got HTTP 503: Service unavailable"
+    end
 
-    @cookie = response['set-cookie'] if response.key? 'set-cookie'
+    self.cookie = response['set-cookie'] if response.key? 'set-cookie'
 
     nk = Nokogiri(response.body)
 

data/lib/rbvmomi/type_loader.rb

@@ -1,5 +1,6 @@
 # Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
 require 'set'
+require 'monitor'
 
 module RbVmomi
 
@@ -21,6 +22,7 @@ class TypeLoader
   def initialize target, fn
     @target = target
     @db = TypeStore.new fn
+    @lock = Monitor.new
   end
 
   def init
@@ -42,8 +44,10 @@ class TypeLoader
 
   def load_type name
     fail unless name.is_a? String
-    @target.const_set name, make_type(name)
-    load_extension name
+    @lock.synchronize do
+      @target.const_set name, make_type(name)
+      load_extension name
+    end
     nil
   end
 

data/lib/rbvmomi/vim.rb

@@ -35,11 +35,37 @@ class VIM < Connection
       vim.serviceContent.sessionManager.Login :userName => opts[:user], :password => opts[:password]
       unless rev_given
         rev = vim.serviceContent.about.apiVersion
-        vim.rev = [rev, '4.1'].min
+        vim.rev = [rev, '5.0'].min
       end
     end
   end
 
+  def close
+    VIM::SessionManager(self, 'SessionManager').Logout
+    super
+  end
+
+  def cookie= cookie
+    super
+    ObjectSpace.undefine_finalizer self
+    ObjectSpace.define_finalizer(self, self.class.finalizer(cookie,@opts))
+  end
+
+  def self.finalizer cookie, opts
+    proc do |object_id|
+      new(opts).tap do |vim|
+        vim.instance_variable_set :@cookie, cookie
+        vim.close
+      end
+      nil
+    end
+  end
+  
+  def rev= x
+    super
+    @serviceContent = nil
+  end
+
   # Return the ServiceInstance
   #
   # The ServiceInstance is the root of the vSphere inventory.
@@ -75,7 +101,7 @@ class VIM < Connection
     pp.text "VIM(#{@opts[:host]})"
   end
 
-  @extension_dirs = [File.join(File.dirname(__FILE__), "vim")]
+  @extension_dirs = [File.join(File.dirname(__FILE__), "vim")] + (ENV['RBVMOMI_VIM_EXTENSION_PATH']||'').split(':')
 
   # Directories to search for extensions
   def self.extension_dirs

data/lib/rbvmomi/vim/Folder.rb

@@ -84,6 +84,8 @@ class RbVmomi::VIM::Folder
       x
     elsif create and type == RbVmomi::VIM::Folder
       p.CreateFolder(:name => final)
+    elsif create and type == RbVmomi::VIM::Datacenter
+      p.CreateDatacenter(:name => final)
     else
       nil
     end

data/lib/rbvmomi/vim/OvfManager.rb

@@ -54,10 +54,9 @@ class RbVmomi::VIM::OvfManager
 
     nfcLease.wait_until(:state) { nfcLease.state != "initializing" }
     raise nfcLease.error if nfcLease.state == "error"
-
     begin
       nfcLease.HttpNfcLeaseProgress(:percent => 5)
-      progress = 0.0
+      progress = 5.0
       result.fileItem.each do |fileItem|
         deviceUrl = nfcLease.info.deviceUrl.find{|x| x.importKey == fileItem.deviceId}
         if !deviceUrl
@@ -73,11 +72,26 @@ class RbVmomi::VIM::OvfManager
 
         method = fileItem.create ? "PUT" : "POST"
 
+        keepAliveThread = Thread.new do
+          while true
+            sleep 2 * 60
+            nfcLease.HttpNfcLeaseProgress(:percent => progress.to_i)
+          end
+        end
+
         href = deviceUrl.url.gsub("*", opts[:host].config.network.vnic[0].spec.ip.ipAddress)
         downloadCmd = "#{CURLBIN} -L '#{URI::escape(filename)}'"
-        uploadCmd = "#{CURLBIN} -X #{method} --insecure -T - -H 'Content-Type: application/x-vnd.vmware-streamVmdk' -H 'Content-Length: #{fileItem.size}' '#{URI::escape(href)}'"
-        system("#{downloadCmd} | #{uploadCmd}")
-        progress += (95.0 / result.fileItem.length)
+        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
 

data/lib/rbvmomi/vim/PropertyCollector.rb

@@ -0,0 +1,23 @@
+class RbVmomi::VIM::PropertyCollector
+  def collectMultiple objs, *pathSet
+    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/ServiceInstance.rb

@@ -43,11 +43,13 @@ class RbVmomi::VIM::ServiceInstance
           end
         end
 
-        yield task_props
+        yield task_props if block_given?
       end
     ensure
       @soap.propertyCollector.CancelWaitForUpdates
       filter.DestroyPropertyFilter
     end
+
+    task_props
   end
 end

data/lib/rbvmomi/vim/VirtualMachine.rb

@@ -4,4 +4,10 @@ class RbVmomi::VIM::VirtualMachine
   def macs
     Hash[self.config.hardware.device.grep(RbVmomi::VIM::VirtualEthernetCard).map { |x| [x.deviceInfo.label, x.macAddress] }]
   end
+  
+  # Retrieve all virtual disk devices.
+  # @return [Array] Array of virtual disk devices.
+  def disks
+    self.config.hardware.device.grep(RbVmomi::VIM::VirtualDisk)
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: rbvmomi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors: 
 - Rich Lane
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 -07:00
+date: 2011-09-02 00:00:00 -07:00
 default_executable: rbvmomish
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,6 +72,7 @@ files:
 - examples/extraConfig.rb
 - examples/logbundle.rb
 - examples/logtail.rb
+- examples/nfs_datastore.rb
 - examples/power.rb
 - examples/readme-1.rb
 - examples/readme-2.rb
@@ -96,6 +97,7 @@ files:
 - lib/rbvmomi/vim/ObjectContent.rb
 - lib/rbvmomi/vim/ObjectUpdate.rb
 - lib/rbvmomi/vim/OvfManager.rb
+- lib/rbvmomi/vim/PropertyCollector.rb
 - lib/rbvmomi/vim/ResourcePool.rb
 - lib/rbvmomi/vim/ServiceInstance.rb
 - lib/rbvmomi/vim/Task.rb
@@ -144,6 +146,7 @@ test_files:
 - examples/extraConfig.rb
 - examples/logbundle.rb
 - examples/logtail.rb
+- examples/nfs_datastore.rb
 - examples/power.rb
 - examples/readme-1.rb
 - examples/readme-2.rb