mkuzmin-rbvmomi 1.8.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbe53d8d48667507d93ddd16bb4a0a9bac091fa2
+  data.tar.gz: 83ed4bcbc3165548ecc23358ff86b5f467ffd51c
+SHA512:
+  metadata.gz: c7b944f9b3a7a25326888ad9a8e47130eb40953616986f5b0537d3328f3e23d45cb38a742342e987ba2d71a0a060cd5ceb65fe80dd659aeb871562b1b376b3c0
+  data.tar.gz: a09f02f93a3cf32d8e0197a1165918e45920c01312362a4984d22e7f64e9ae9c2634b20ea1290dbf32d9d0171090f664820b157f0bc5516a853e5ba3be114926

data/.yardopts

@@ -0,0 +1,6 @@
+--title "RbVmomi - a Ruby interface to the vSphere API"
+--no-private
+--readme README.rdoc
+lib/rbvmomi/vim.rb
+lib/rbvmomi/vim/*.rb
+lib/rbvmomi/trollop.rb

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
+
+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.

data/README.rdoc

@@ -0,0 +1,78 @@
+= RbVmomi
+
+== Introduction
+
+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 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].
+
+== Installation
+
+    gem install rbvmomi
+
+== Usage
+
+A simple example of turning on a VM:
+
+    require 'rbvmomi'
+    vim = RbVmomi::VIM.connect host: 'foo', user: 'bar', password: 'baz'
+    dc = vim.serviceInstance.find_datacenter("mydatacenter") or fail "datacenter not found"
+    vm = dc.find_vm("myvm") or fail "VM not found"
+    vm.PowerOnVM_Task.wait_for_completion
+
+This code uses several RbVmomi extensions to the vSphere API for concision. The
+expanded snippet below uses only standard API calls and should be familiar to
+users of the Java SDK:
+
+    require 'rbvmomi'
+    vim = RbVmomi::VIM.connect host: 'foo', user: 'bar', password: 'baz'
+    rootFolder = vim.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.PowerOnVM_Task
+    filter = vim.propertyCollector.CreateFilter(
+      spec: {
+        propSet: [{ type: 'Task', all: false, pathSet: ['info.state']}],
+        objectSet: [{ obj: task }]
+      },
+      partialUpdates: false
+    )
+    ver = ''
+    while true
+      result = vim.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'
+
+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.
+
+A few important points:
+
+* All class, method, parameter, and property names match the official documentation[http://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/index.html].
+* Properties are exposed as accessor methods.
+* Data object types can usually be inferred from context, so you may use a hash instead.
+* Enumeration values are simply strings.
+* 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
+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.
+
+== Development
+
+Fork the project on Github and send me a merge request, or send a patch to
+rlane@vmware.com. RbVmomi developers hang out in #rbvmomi on Freenode.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rake/testtask'
+require 'rdoc/task'
+require 'yard'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mkuzmin-rbvmomi"
+    gem.summary = "Ruby interface to the VMware vSphere API"
+    #gem.description = ""
+    gem.email = "mkuzmin@gmail.com"
+    gem.homepage = "https://github.com/mkuzmin/rbvmomi"
+    gem.authors = ["Rich Lane", "Christian Dickmann"]
+    gem.add_dependency 'nokogiri', '>= 1.4.1'
+    gem.add_dependency 'builder'
+    gem.add_dependency 'trollop'
+    gem.required_ruby_version = '>= 1.8.7'
+    gem.files.include 'vmodl.db'
+    gem.files.include '.yardopts'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end
+
+YARD::Rake::YardocTask.new
+
+begin
+  require 'rcov/rcovtask'
+  desc 'Measures test coverage using rcov'
+  Rcov::RcovTask.new do |rcov|
+    rcov.pattern    = 'test/test_*.rb'
+    rcov.output_dir = 'coverage'
+    rcov.verbose    = true
+    rcov.libs << "test"
+    rcov.rcov_opts << '--exclude "gems/*"'
+  end
+rescue LoadError
+  puts "Rcov not available. Install it with: gem install rcov"
+end

data/VERSION

@@ -0,0 +1 @@
+1.8.2.1

data/bin/rbvmomish

@@ -0,0 +1,138 @@
+#!/usr/bin/env ruby
+# TODO keepalive
+# TODO rc file
+# TODO proxy support?
+require 'trollop'
+require 'readline'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+
+opts = Trollop.options do
+  banner <<-EOS
+vSphere API console.
+
+Usage:
+       rbvmomish [options]
+
+Predefined methods:
+conn: Returns the VIM connection
+si: Returns the ServiceInstance
+help: Displays this text.
+
+Special syntax:
+Adding a '#' suffix to an expression displays information about the type of the
+result, including its properties and methods, instead of the value.
+
+VIM connection options:
+  EOS
+
+  rbvmomi_connection_opts
+
+  text <<-EOS
+
+Other options:
+  EOS
+
+  $trollop = self
+end
+
+begin
+  $vim = VIM.connect opts
+rescue Errno::EHOSTUNREACH
+  abort $!.message
+end
+
+typenames = VIM.loader.typenames
+Readline.completion_append_character = " "
+Readline.completion_proc = lambda do |word|
+  return unless word
+  prefix_regex = /^#{Regexp.escape(word)}/
+  candidates = typenames.sort
+  candidates.find_all { |e| e.match(prefix_regex) }
+end
+
+history_fn = "#{ENV['HOME']}/.rbvmomish-history"
+IO.foreach(history_fn) { |l| Readline::HISTORY << l.chomp } rescue nil
+history = File.open(history_fn, 'a')
+
+def type name
+  klass = VIM.type(name) rescue err("invalid type #{name.inspect}")
+  q = lambda { |x| x =~ /^xsd:/ ? $' : x }
+  if klass < VIM::DataObject
+    puts "Data Object #{klass}"
+    klass.full_props_desc.each do |desc|
+      puts " #{desc['name']}: #{q[desc['wsdl_type']]}#{desc['is-array'] ? '[]' : ''}"
+    end
+  elsif klass < VIM::ManagedObject
+    puts "Managed Object #{klass}"
+    puts
+    puts "Properties:"
+    klass.full_props_desc.each do |desc|
+      puts " #{desc['name']}: #{q[desc['wsdl_type']]}#{desc['is-array'] ? '[]' : ''}"
+    end
+    puts
+    puts "Methods:"
+    klass.full_methods_desc.sort_by(&:first).each do |name,desc|
+      params = desc['params']
+      puts " #{name}(#{params.map { |x| "#{x['name']} : #{q[x['wsdl_type'] || 'void']}#{x['is-array'] ? '[]' : ''}" } * ', '}) : #{q[desc['result']['wsdl_type'] || 'void']}"
+    end
+  else
+    err("cannot introspect type #{klass}")
+  end
+  nil
+end
+
+class UserError < RuntimeError; end
+def err msg
+  raise UserError.new(msg)
+end
+
+def cookie str
+  $vim.cookie = str
+end
+
+def conn
+  $vim
+end
+
+def si
+  $vim.serviceInstance
+end
+
+def help
+  $trollop.educate
+  :no_result
+end
+
+$binding = $vim.instance_eval { binding }
+
+loop do
+begin
+  input = Readline.readline("#{opts[:host]}> ", false) or break
+  input = input.strip
+  next if input.empty?
+
+  (history.puts input; Readline::HISTORY << input) unless input == Readline::HISTORY.to_a[-1]
+
+  result = eval(input, $binding)
+  if input =~ /\#$/
+    type result.class.wsdl_name
+  else
+    pp result unless result == :no_result
+  end
+rescue SystemExit, IOError
+  raise
+rescue RuntimeError, RbVmomi::Fault
+  puts "#{$!.class}: #{$!.message}"
+  puts $!.backtrace * "\n"
+rescue UserError
+  puts $!.message
+rescue Interrupt
+  puts
+rescue Exception
+  puts "#{$!.class}: #{$!.message}"
+  puts $!.backtrace * "\n"
+end
+end

data/devel/analyze-vim-declarations.rb

@@ -0,0 +1,213 @@
+#!/usr/bin/env ruby
+require 'nokogiri'
+require 'pp'
+# :usage => analyze-vim-declarations.rb vim-declarations.xml foo-declarations.xml vmodl.db
+
+XML_FNS = ARGV[0...-1]
+abort "must specify path to vim-declarations.xml" if XML_FNS.empty?
+OUT_FN = ARGV[-1] or abort "must specify path to output database"
+
+XML_FNS.each do |x|
+  abort "XML file #{x} does not exist" unless File.exists? x
+end
+
+TYPES = {}
+VERSIONS = []
+
+ID2NAME = Hash.new { |h,k| fail "unknown type-id #{k.inspect}" }
+
+ID2NAME.merge!({
+  'java.lang.String' => 'xsd:string',
+  'BOOLEAN' => 'xsd:boolean',
+  'BYTE' => 'xsd:byte',
+  'SHORT' => 'xsd:short',
+  'INT' => 'xsd:int',
+  'LONG' => 'xsd:long',
+  'FLOAT' => 'xsd:float',
+  'DOUBLE' => 'xsd:double',
+  'vmodl.DateTime' => 'xsd:dateTime',
+  'vmodl.Binary' => 'xsd:base64Binary',
+  'vmodl.Any' => 'xsd:anyType',
+  'vmodl.URI' => 'xsd:anyURI',
+  'void' => nil,
+})
+
+%w(DataObject ManagedObject MethodFault MethodName
+   PropertyPath RuntimeFault TypeName).each do |x|
+  ID2NAME['vmodl.' + x] = x
+end
+
+def handle_data_object node
+  if TYPES[node['name']]
+    puts "Type #{node['name']} already exists"
+    return
+  end
+
+  ID2NAME[node['type-id']] = node['name']
+  TYPES[node['name']] = {
+    'kind' => 'data',
+    'base-type-id' => node['base-type-id'],
+    'props' => node.children.select { |x| x.name == 'property' }.map do |property|
+      {
+        'name' => property['name'],
+        'type-id-ref' => property['type-id-ref'],
+        'is-optional' => property['is-optional'] ? true : false,
+        'is-array' => property['is-array'] ? true : false,
+        'version-id-ref' => property['version-id-ref'],
+      }
+    end
+  }
+end
+
+def handle_managed_object node
+  if TYPES[node['name']]
+    puts "Type #{node['name']} already exists"
+    return
+  end
+  ID2NAME[node['type-id']] = node['name']
+  TYPES[node['name']] = {
+    'kind' => 'managed',
+    'base-type-id' => node['base-type-id'],
+    'props' => node.children.select { |x| x.name == 'property' }.map do |property|
+      {
+        'name' => property['name'],
+        'type-id-ref' => property['type-id-ref'],
+        'is-optional' => property['is-optional'] ? true : false,
+        'is-array' => property['is-array'] ? true : false,
+        'version-id-ref' => property['version-id-ref'],
+      }
+    end,
+    'methods' => Hash[
+      node.children.select { |x| x.name == 'method' }.map do |method|
+        [method['is-task'] ? "#{method['name']}_Task" : method['name'],
+         {
+           'params' => method.children.select { |x| x.name == 'parameter' }.map do |param|
+             {
+               'name' => param['name'],
+               'type-id-ref' => param['type-id-ref'],
+               'is-array' => param['is-array'] ? true : false,
+               'is-optional' => param['is-optional'] ? true : false,
+               'version-id-ref' => param['version-id-ref'],
+             }
+           end,
+           'result' => {
+             'type-id-ref' => method['type-id-ref'],
+             'is-array' => method['is-array'] ? true : false,
+             'is-optional' => method['is-optional'] ? true : false,
+             'is-task' => method['is-task'] ? true : false,
+             'version-id-ref' => method['version-id-ref'],
+           }
+         }
+        ]
+      end
+    ]
+  }
+end
+
+def handle_enum node
+  if TYPES[node['name']]
+    puts "Type #{node['name']} already exists"
+    return
+  end
+
+  ID2NAME[node['type-id']] = node['name']
+  TYPES[node['name']] = {
+    'kind' => 'enum',
+    'values' => node.children.map { |child| child['name'] },
+  }
+end
+
+def handle_fault node
+  handle_data_object node
+end
+
+def handle_version x
+  attrs = %w(display-name name service-namespace type-id version-id vmodl-name)
+  h = Hash[attrs.map { |k| [k, x[k]] }]
+  h['compatible'] = x.children.select(&:element?).map { |y| y.text }
+  VERSIONS << h
+end
+
+XML_FNS.each do |fn|
+  puts "parsing #{fn} ..."
+  xml_str = File.read(fn)
+  xml_str = xml_str.gsub(/\<description-html\>(.*?)\<\/description-html\>/m, "")
+  xml = Nokogiri.parse(xml_str, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS)
+  xml.root.at('enums').children.each { |x| handle_enum x }
+  xml.root.at('managed-objects').children.each { |x| handle_managed_object x }
+  xml.root.at('data-objects').children.each { |x| handle_data_object x }
+  xml.root.at('faults').children.each { |x| handle_fault x }
+  #xml.root.at('definitions').at('version-types').children.each { |x| handle_version x }
+end
+
+#pp ID2NAME
+
+munge_fault = lambda { |x| true }
+
+TYPES.each do |k,t|
+  case t['kind']
+  when 'data'
+    t['wsdl_base'] = t['base-type-id'] ? ID2NAME[t['base-type-id']] : 'DataObject'
+    t.delete 'base-type-id'
+    t['props'].each do |x|
+      x['wsdl_type'] = ID2NAME[x['type-id-ref']]
+      x.delete 'type-id-ref'
+      munge_fault[x]
+    end
+  when 'managed'
+    t['wsdl_base'] = t['base-type-id'] ? ID2NAME[t['base-type-id']] : 'ManagedObject'
+    t.delete 'base-type-id'
+    t['props'].each do |x|
+      x['wsdl_type'] = ID2NAME[x['type-id-ref']]
+      x.delete 'type-id-ref'
+      munge_fault[x]
+    end
+    t['methods'].each do |mName,x|
+      if y = x['result']
+        begin
+          y['wsdl_type'] = ID2NAME[y['type-id-ref']]
+        rescue Exception => ex
+          pp ex
+        end
+        y.delete 'type-id-ref'
+        munge_fault[y]
+      end
+      x['params'].each do |r|
+        begin
+          r['wsdl_type'] = ID2NAME[r['type-id-ref']]
+        rescue Exception => ex
+          pp ex
+        end
+        r.delete 'type-id-ref'
+        munge_fault[r]
+      end
+    end
+  when 'enum'
+  else fail
+  end
+end
+
+db = {}
+
+TYPES.each do |k,t|
+  db[k] = t
+end
+
+db['_typenames'] = TYPES.keys
+db['_versions'] = VERSIONS
+
+File.open(OUT_FN, 'w') { |io| Marshal.dump db, io }
+
+if filename = ENV['VERSION_GRAPH']
+  File.open(filename, 'w') do |io|
+    io.puts "digraph versions\n{"
+    VERSIONS.each do |h|
+      io.puts "\"#{h['vmodl-name']}\" [label=\"#{h['vmodl-name']} (#{h['version-id']})\"]"
+      h['compatible'].each do |x|
+        x =~ /^interface / or fail x
+        io.puts "\"#{h['vmodl-name']}\" -> \"#{$'}\""
+      end
+    end
+    io.puts "}\n"
+  end
+end