rbvmomi 1.1.6 → 1.1.8

data/README.html

@@ -0,0 +1,76 @@
+<h1>RbVmomi</h1>
+
+<h2>Introduction</h2>
+
+<p>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.</p>
+
+<h2>Usage</h2>
+
+<p>A simple example of turning on a VM:</p>
+
+<pre><code>require 'rbvmomi'
+conn = RbVmomi.connect host: 'foo', user: 'bar', password: 'baz'
+dc = conn.serviceInstance.find_datacenter("mydatacenter") or fail "datacenter not found"
+vm = dc.find_vm("myvm") or fail "VM not found"
+vm.PowerOn_Task.wait_for_completion
+</code></pre>
+
+<p>This code uses several RbVmomi extensions to the VI API for concision. The
+expanded snippet below uses only standard API calls and should be familiar to
+users of the Java SDK:</p>
+
+<pre><code>require 'rbvmomi'
+conn = RbVmomi.connect host: 'foo', user: 'bar', password: 'baz'
+rootFolder = conn.serviceInstance.content.rootFolder
+dc = rootFolder.childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == "mydatacenter" } or fail "datacenter not found"
+vm = dc.vmFolder.childEntity.grep(RbVmomi::VIM::VirtualMachine).find { |x| x.name == "myvm" } or fail "VM not found"
+task = vm.PowerOn_Task
+filter = conn.propertyCollector.CreateFilter(
+  spec: {
+    propSet: [{ type =&gt; 'Task', all: false, pathSet: ['info.state']}],
+    objectSet: [{ obj: task }]
+  },
+  partialUpdates: false
+)
+ver = ''
+while true
+  result = conn.propertyCollector.WaitForUpdates(version: ver)
+  ver = result.version
+  break if ['success', ['error'].member? task.info.state
+end
+filter.DestroyPropertyFilter
+raise task.info.error if task.info.state == 'error'
+</code></pre>
+
+<p>As you can see, the extensions RbVmomi adds can dramatically decrease the code
+needed to perform simple tasks while still letting you use the full power of
+the API when necessary. RbVmomi extensions are often more efficient than a
+naive implementation; for example, the find_vm method on VIM::Datacenter used
+in the first example uses the SearchIndex for fast lookups.</p>
+
+<p>A few important points:</p>
+
+<ul>
+<li>Ruby 1.9 is required.</li>
+<li>Properties are exposed as methods: vm.summary</li>
+<li>All class, method, parameter, and property names match the <a href="http://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/index.html">official documentation</a>.</li>
+<li>Data object types can usually be inferred from context, so you may simply use a hash instead.</li>
+<li>Enumeration values are simply strings.</li>
+<li>Example code is included in the examples/ directory.</li>
+<li>A set of helper methods for Trollop is included to speed up development of
+command line apps. See the included examples for usage.</li>
+<li>This is a side project of a VMware developer and is entirely unsupported by VMware.</li>
+</ul>
+
+<p>Built-in extensions are in lib/rbvmomi/extensions.rb. You are encouraged to
+reopen VIM classes in your applications and add extensions of your own. If you
+write something generally useful please send it to me and I'll add it in. One
+important point about extensions is that since VIM classes are lazily loaded,
+you need to trigger this loading before you can reopen the class. Putting the
+class name on a line by itself before reopening is enough.</p>
+
+<h2>Development</h2>
+
+<p>Send patches to rlane@vmware.com.</p>

data/Rakefile

@@ -15,7 +15,7 @@ begin
     gem.add_dependency 'builder'
     gem.add_dependency 'trollop'
     gem.add_dependency 'cdb-full'
-    gem.required_ruby_version = '>= 1.9.1'
+    gem.required_ruby_version = '>= 1.8.7'
     gem.files.include 'vmodl.cdb'
     gem.files.include '.yardopts'
   end

data/VERSION

@@ -1 +1 @@
-1.1.6
+1.1.8

data/lib/rbvmomi/trivial_soap.rb

@@ -35,7 +35,7 @@ class RbVmomi::TrivialSoap
       @http.key = OpenSSL::PKey::RSA.new(@opts[:key]) if @opts[:key]
     end
     @http.set_debug_output(STDERR) if $DEBUG
-    @http.read_timeout = 1000000000
+    @http.read_timeout = 1000000
     @http.open_timeout = 5
     def @http.on_connect
       @socket.io.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)

data/lib/rbvmomi/vim/Folder.rb

@@ -8,6 +8,51 @@ class RbVmomi::VIM::Folder
     x if x.is_a? type
   end
 
+  # Retrieve a virtual machine or host by DNS name
+  # @param name [String] The fully qualified domain name to find.
+  # @param type [Class] Return nil unless the found entity <tt>is_a? type</tt>.
+  # @param dc [RbVmomi::VIM::Datacenter] Restricts the query to entities in the given Datacenter.
+  # @return [VIM::ManagedEntity]
+  def findByDnsName name, type=RbVmomi::VIM::VirtualMachine, dc=nil
+    propSpecs = {
+      :entity => self, :dnsName => name,
+      :vmSearch => type == RbVmomi::VIM::VirtualMachine
+    }
+    propSpecs[:datacenter] = dc if dc
+    x = @soap.searchIndex.FindByDnsName(propSpecs)
+    x if x.is_a? type
+  end
+
+  # Retrieve a virtual machine or host by IP address
+  # @param ip [String] The IP address is in dot-decimal notation.
+  # @param type [Class] Return nil unless the found entity <tt>is_a? type</tt>.
+  # @param dc [RbVmomi::VIM::Datacenter] Restricts the query to entities in the given Datacenter.
+  # @return [VIM::ManagedEntity]
+  def findByIp ip, type=RbVmomi::VIM::VirtualMachine, dc=nil
+    propSpecs = {
+      :entity => self, :ip => ip,
+      :vmSearch => type == RbVmomi::VIM::VirtualMachine
+    }
+    propSpecs[:datacenter] = dc if dc
+    x = @soap.searchIndex.FindByIp(propSpecs)
+    x if x.is_a? type
+  end
+
+  # Retrieve a virtual machine or host by BIOS UUID.
+  # @param uuid [String] The UUID to find.
+  # @param type [Class] Return nil unless the found entity <tt>is_a? type</tt>.
+  # @param dc [RbVmomi::VIM::Datacenter] Restricts the query to entities in the given Datacenter.
+  # @return [VIM::ManagedEntity]
+  def findByUuid uuid, type=RbVmomi::VIM::VirtualMachine, dc=nil
+    propSpecs = {
+      :entity => self, :uuid => uuid, :instanceUuid => false,
+      :vmSearch => type == RbVmomi::VIM::VirtualMachine
+    }
+    propSpecs[:datacenter] = dc if dc
+    x = @soap.searchIndex.FindByUuid(propSpecs)
+    x if x.is_a? type
+  end
+
   # Alias to <tt>traverse path, type, true</tt>
   # @see #traverse
   def traverse! path, type=Object

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rbvmomi
 version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: 
-  version: 1.1.6
+  segments: 
+  - 1
+  - 1
+  - 8
+  version: 1.1.8
 platform: ruby
 authors: 
 - Rich Lane
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-28 00:00:00 -08:00
+date: 2011-03-15 00:00:00 -07:00
 default_executable: rbvmomish
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,6 +26,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 4
+        - 1
         version: 1.4.1
   type: :runtime
   version_requirements: *id001
@@ -32,6 +42,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -43,6 +56,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
@@ -54,6 +70,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id004
@@ -65,6 +84,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
+- README.html
 - README.rdoc
 files: 
 - .yardopts
@@ -114,6 +134,7 @@ files:
 - test/test_parse_response.rb
 - test/test_serialization.rb
 - vmodl.cdb
+- README.html
 has_rdoc: true
 homepage: https://github.com/rlane/rbvmomi
 licenses: []
@@ -128,17 +149,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.9.1
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: Ruby interface to the VMware vSphere API