rbvmomi 1.1.1 → 1.1.2

data/README.rdoc

@@ -63,6 +63,9 @@ A few important points:
 * Example code is included in the examples/ directory.
 * A set of helper methods for Trollop is included to speed up development of
   command line apps. See the included examples for usage.
+* If you don't have trusted SSL certificates installed on the host you're
+  connecting to, you'll get an +OpenSSL::SSL::SSLError+ "certificate verify failed".
+  You can work around this by using the +:insecure+ option to +RbVmomi::VIM.connect+.
 * This is a side project of a VMware employee and is entirely unsupported by VMware.
 
 Built-in extensions are under +lib/rbvmomi/vim/+. You are encouraged to
@@ -71,4 +74,5 @@ write something generally useful please send it to me and I'll add it in.
 
 == Development
 
-Send patches to rlane@vmware.com.
+Fork the project on Github and send me a merge request, or send a patch to
+rlane@vmware.com.

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.1.2

data/examples/create_vm-1.9.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+N = 2
+
+opts = Trollop.options do
+  banner <<-EOS
+Create and destroy a couple of VMs.
+
+Usage:
+    create_vm.rb [options]
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+VM location options:
+    EOS
+
+    rbvmomi_datacenter_opt
+
+    text <<-EOS
+
+Other options:
+  EOS
+end
+
+Trollop.die("must specify host") unless opts[:host]
+vm_name = ARGV[0] or abort "must specify VM name"
+
+vim = VIM.connect opts
+dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
+vmFolder = dc.vmFolder
+hosts = dc.hostFolder.children
+rp = hosts.first.resourcePool
+
+vm_cfg = {
+  name: vm_name,
+  guestId: 'otherGuest',
+  files: { vmPathName: '[datastore1]' },
+  numCPUs: 1,
+  memoryMB: 128,
+  deviceChange: [
+    {
+      operation: :add,
+      device: VIM.VirtualLsiLogicController(
+        key: 1000,
+        busNumber: 0,
+        sharedBus: :noSharing,
+      )
+    }, {
+      operation: :add,
+      fileOperation: :create,
+      device: VIM.VirtualDisk(
+        key: 0,
+        backing: VIM.VirtualDiskFlatVer2BackingInfo(
+          fileName: '[datastore1]',
+          diskMode: :persistent,
+          thinProvisioned: true,
+        ),
+        controllerKey: 1000,
+        unitNumber: 0,
+        capacityInKB: 4000000,
+      )
+    }, {
+      operation: :add,
+      device: VIM.VirtualE1000(
+        key: 0,
+        deviceInfo: {
+          label: 'Network Adapter 1',
+          summary: 'VM Network',
+        },
+        backing: VIM.VirtualEthernetCardNetworkBackingInfo(
+          deviceName: 'VM Network',
+        ),
+        addressType: 'generated'
+      )
+    }
+  ],
+  extraConfig: [
+    {
+      key: 'bios.bootOrder',
+      value: 'ethernet0'
+    }
+  ]
+}
+
+vmFolder.CreateVM_Task(:config => vm_cfg, :pool => rp).wait_for_completion

data/lib/rbvmomi.rb

@@ -1,4 +1,12 @@
 # Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
-module RbVmomi; end
+module RbVmomi
+
+# @private
+# @deprecated Use +RbVmomi::VIM.connect+.
+def self.connect opts
+  VIM.connect opts
+end
+
+end
 require 'rbvmomi/connection'
 require 'rbvmomi/vim'

data/lib/rbvmomi/trollop.rb

@@ -1,9 +1,29 @@
 # Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
 require 'trollop'
 
-# @todo Document
+# Convenience methods for Trollop, Ruby's premier option parser.
+# @see http://trollop.rubyforge.org/
+# @see Trollop::Parser
 module Trollop
+
+# Convenience methods for Trollop, Ruby's premier option parser.
+#
+# See the examples directory for sample code.
+# Descriptions are of the form:
+#  <key>: <options> <environment variable> (<default>)
+# @see http://trollop.rubyforge.org/
 class Parser
+  # Options used by VIM.connect
+  #
+  #  !!!plain
+  #  host: -o --host RBVMOMI_HOST
+  #  port: --port RBVMOMI_PORT (443)
+  #  no-ssl: --no-ssl RBVMOMI_SSL (false)
+  #  insecure: -k --insecure RBVMOMI_INSECURE (false)
+  #  user: -u --user RBVMOMI_USER (root)
+  #  password: -p --password RBVMOMI_PASSWORD ()
+  #  path: --path RBVMOMI_PATH (/sdk)
+  #  debug: -d --debug RBVMOMI_DEBUG (false)
   def rbvmomi_connection_opts
     opt :host, "host", :type => :string, :short => 'o', :default => ENV['RBVMOMI_HOST']
     opt :port, "port", :type => :int, :short => :none, :default => (ENV.member?('RBVMOMI_PORT') ? ENV['RBVMOMI_PORT'].to_i : 443)
@@ -12,21 +32,37 @@ class Parser
     opt :user, "username", :short => 'u', :default => (ENV['RBVMOMI_USER'] || 'root')
     opt :password, "password", :short => 'p', :default => (ENV['RBVMOMI_PASSWORD'] || '')
     opt :path, "SOAP endpoint path", :short => :none, :default => (ENV['RBVMOMI_PATH'] || '/sdk')
-    opt :debug, "Log SOAP messages", :short => 'd'
+    opt :debug, "Log SOAP messages", :short => 'd', :default => (ENV['RBVMOMI_DEBUG'] || false)
   end
 
+  # Select a datacenter
+  #
+  #  !!!plain
+  #  datacenter: -D --datacenter RBVMOMI_DATACENTER (ha-datacenter)
   def rbvmomi_datacenter_opt
     opt :datacenter, "datacenter", :type => :string, :short => "D", :default => (ENV['RBVMOMI_DATACENTER'] || 'ha-datacenter')
   end
 
+  # Select a folder
+  #
+  #  !!!plain
+  #  folder: -F --folder RBVMOMI_FOLDER ()
   def rbvmomi_folder_opt
     opt :folder, "VM folder", :type => :string, :short => "F", :default => (ENV['RBVMOMI_FOLDER'] || '')
   end
 
+  # Select a compute resource
+  #
+  #  !!!plain
+  #  computer: -R --computer RBVMOMI_COMPUTER
   def rbvmomi_computer_opt
     opt :computer, "Compute resource", :type => :string, :short => "R", :default => ENV['RBVMOMI_COMPUTER']
   end
 
+  # Select a datastore
+  #
+  #  !!!plain
+  #  datastore: -s --datastore RBVMOMI_DATASTORE (datastore1)
   def rbvmomi_datastore_opt
     opt :datastore, "Datastore", :short => 's', :default => (ENV['RBVMOMI_DATASTORE'] || 'datastore1')
   end

data/lib/rbvmomi/vim.rb

@@ -27,11 +27,13 @@ class VIM < Connection
     opts[:port] ||= (opts[:ssl] ? 443 : 80)
     opts[:path] ||= '/sdk'
     opts[:ns] ||= 'urn:vim25'
-    opts[:rev] = '4.1'
+    opts[:rev] = '4.0'
     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]
+      rev = vim.serviceContent.about.apiVersion
+      vim.rev = rev if %w(4.0 4.1).member? rev
     end
   end
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rbvmomi
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
+  prerelease: false
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Rich Lane
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 1
         - 4
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -56,7 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -70,7 +66,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -93,6 +88,7 @@ files:
 - VERSION
 - devel/analyze-vim-declarations.rb
 - devel/analyze-xml.rb
+- examples/create_vm-1.9.rb
 - examples/create_vm.rb
 - examples/extraConfig.rb
 - examples/power.rb
@@ -140,7 +136,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 49
       segments: 
       - 1
       - 9
@@ -151,18 +146,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby interface to the VMware vSphere API
 test_files: 
+- examples/create_vm-1.9.rb
 - examples/create_vm.rb
 - examples/extraConfig.rb
 - examples/power.rb