rbvmomi 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3675fb1f195476fffb958df44a667c74b347277e5fa88416de07c33093286495
-  data.tar.gz: 824a521c72865d6e8390cc8675b692d0f413d81426fb29882bb844ec97fbcb17
+  metadata.gz: ff1e2a42dc5de2b400dbc180315e922746090ee5feac055dc56d03db52ed861b
+  data.tar.gz: 957d2c4641b68cf99a0c493743ce344972093302e7939cb67d1fd7a7e70d25c6
 SHA512:
-  metadata.gz: 06ec29d563c568e02b3b6740e45560c21ca0f5752f6815add6fc3a925f92aefa6ce51c16179acaf772b9d7f3aaca338f4c62fce84ee2444d790b997b591ab41c
-  data.tar.gz: ee5baaeb14038b98e66ba57c4ef9c76a8e2fbbd83361feec5e93dcef6aef26fd4aa5d3cda77634c3d625a2c08d3fb89c38380060e21565460f9262e603d1d67e
+  metadata.gz: d586c72331490dafd93074737069b9b9526e1d4b986f0cd410ed51279897ed2d1ee046c589c393ece0db3e81cbece07d2be4f1c56004404b94db9c045bd31378
+  data.tar.gz: cdaecffc1a9fa2c4de85ebaf684bf5e1e51aac843e6c27cae9eaaefc15b36969c936cc76360ac4d27184efdaf528af67b1d9fb93a015e36f73df55a745e5bc3f

data/lib/rbvmomi/#vim.rb#

@@ -0,0 +1,155 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+require 'rbvmomi'
+
+# Win32::SSPI is part of core on Windows
+begin
+  require 'win32/sspi'
+rescue LoadError
+end
+WIN32 = (defined? Win32::SSPI)
+
+module RbVmomi
+
+# A connection to one vSphere SDK endpoint.
+# @see #serviceInstance
+class VIM < Connection
+  # Connect to a vSphere SDK endpoint
+  #
+  # @param [Hash] opts The options hash.
+  # @option opts [String]  :host Host to connect to.
+  # @option opts [Numeric] :port (443) Port to connect to.
+  # @option opts [Boolean] :ssl (true) Whether to use SSL.
+  # @option opts [Boolean] :insecure (false) If true, ignore SSL certificate errors.
+  # @option opts [String]  :cookie If set, use cookie to connect instead of user/password
+  # @option opts [String]  :user (root) Username.
+  # @option opts [String]  :password Password.
+  # @option opts [String]  :path (/sdk) SDK endpoint path.
+  # @option opts [Boolean] :debug (false) If true, print SOAP traffic to stderr.
+  # @option opts [String]  :operation_id If set, use for operationID
+  def self.connect opts
+    fail unless opts.is_a? Hash
+    fail "host option required" unless opts[:host]
+    opts[:cookie] ||= nil
+    opts[:user] ||= (WIN32 ? ENV['USERNAME'].dup : 'root')
+    opts[:password] ||= ''
+    opts[:ssl] = true unless opts.member? :ssl or opts[:"no-ssl"]
+    opts[:insecure] ||= false
+    opts[:port] ||= (opts[:ssl] ? 443 : 80)
+    opts[:path] ||= '/sdk'
+    opts[:ns] ||= 'urn:vim25'
+    opts[:rev] = '6.5' if opts[:rev].nil?
+    opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
+
+    conn = new(opts).tap do |vim|
+      unless opts[:cookie]
+        if WIN32 && opts[:password] == ''
+            # Attempt login by SSPI if no password specified on Windows
+            negotiation = Win32::SSPI::NegotiateAuth.new opts[:user], ENV['USERDOMAIN'].dup
+            begin
+              vim.serviceContent.sessionManager.LoginBySSPI :base64Token => negotiation.get_initial_token
+            rescue RbVmomi::Fault => fault
+              if !fault.fault.is_a?(RbVmomi::VIM::SSPIChallenge)
+                raise
+              else
+                vim.serviceContent.sessionManager.LoginBySSPI :base64Token => negotiation.complete_authentication(fault.base64Token)
+              end
+            end
+        else
+            vim.serviceContent.sessionManager.Login :userName => opts[:user], :password => opts[:password]
+        end
+      end
+      rev = vim.serviceContent.about.apiVersion
+      vim.rev = [rev, opts[:rev]].min { |a, b| Gem::Version.new(a) <=> Gem::Version.new(b) }
+    end
+
+    at_exit { conn.close }
+    conn
+  end
+
+  def close
+    serviceContent.sessionManager.Logout
+  rescue RbVmomi::Fault => e
+    $stderr.puts(e.message) if debug
+  ensure
+    self.cookie = nil
+    super
+  end
+
+  def rev= x
+    super
+    @serviceContent = nil
+  end
+
+  # Return the ServiceInstance
+  #
+  # The ServiceInstance is the root of the vSphere inventory.
+  # @see http://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.ServiceInstance.html
+  def serviceInstance
+    VIM::ServiceInstance self, 'ServiceInstance'
+  end
+
+  # Alias to serviceInstance.RetrieveServiceContent
+  def serviceContent
+    @serviceContent ||= serviceInstance.RetrieveServiceContent
+  end
+
+  # Alias to serviceContent.rootFolder
+  def rootFolder
+    serviceContent.rootFolder
+  end
+
+  alias root rootFolder
+
+  # Alias to serviceContent.propertyCollector
+  def propertyCollector
+    serviceContent.propertyCollector
+  end
+
+  # Alias to serviceContent.searchIndex
+  def searchIndex
+    serviceContent.searchIndex
+  end
+
+  # @private
+  def pretty_print pp
+    pp.text "VIM(#{@opts[:host]})"
+  end
+
+  def instanceUuid
+    serviceContent.about.instanceUuid
+  end
+
+  def get_log_lines logKey, lines=5, start=nil, host=nil
+    diagMgr = self.serviceContent.diagnosticManager
+    if !start
+      log = diagMgr.BrowseDiagnosticLog(:host => host, :key => logKey, :start => 999999999)
+      lineEnd = log.lineEnd
+      start = lineEnd - lines
+    end
+    start = start < 0 ? 0 : start
+    log = diagMgr.BrowseDiagnosticLog(:host => host, :key => logKey, :start => start)
+    if log.lineText.size > 0
+      [log.lineText.slice(-lines, log.lineText.size), log.lineEnd]
+    else
+      [log.lineText, log.lineEnd]
+    end
+  end
+
+  def get_log_keys host=nil
+    diagMgr = self.serviceContent.diagnosticManager
+    keys = []
+    diagMgr.QueryDescriptions(:host => host).each do |desc|
+      keys << "#{desc.key}"
+    end
+    keys
+  end
+
+  add_extension_dir File.join(File.dirname(__FILE__), "vim")
+  (ENV['RBVMOMI_VIM_EXTENSION_PATH']||'').split(':').each { |dir| add_extension_dir dir }
+
+  load_vmodl(ENV['VMODL'] || File.join(File.dirname(__FILE__), "../../vmodl.db"))
+end
+
+end

data/lib/rbvmomi/version.rb

@@ -2,5 +2,5 @@
 # SPDX-License-Identifier: MIT
 
 module RbVmomi
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/lib/rbvmomi/vmodl.rb

@@ -0,0 +1,49 @@
+require 'hashdiff'
+
+module RbVmomi
+  # Utility class for VMware Managed Object Designed Language
+  #
+  # @author J.R. Garcia <jrg@vmware.com>
+  # @since 2.0.1
+  class VMODL
+    # Create a VMODL object from a marshaled file
+    #
+    # @author J.R. Garcia <jrg@vmware.com>
+    #
+    # @since 2.0.1
+    #
+    # @param [String] file the path to create the VMODL object from
+    #
+    # @return [VMODL] the created VMODL
+    def self.from_file(file = '')
+      raise ArgumentError, "'#{file}' doesn't exist" unless File.exist?(file)
+      new.tap { |o| o.instance_variable_set(:@file, file) }
+    end
+
+    # Translate a VMODL object to a Hash
+    #
+    # @author J.R. Garcia <jrg@vmware.com>
+    #
+    # @since 2.0.1
+    #
+    # @return [Hash] a Hash representation of the VMODL
+    def to_h
+      Marshal.load(IO.read(@file))
+    end
+
+    # Diff this VMODL with another VMODL
+    #
+    # @author J.R. Garcia <jrg@vmware.com>
+    #
+    # @since 2.0.1
+    #
+    # @return a diff of the VMODLs
+    def diff(other)
+      HashDiff.diff(self.to_h, other.to_h)
+    end
+
+    private
+
+    attr_accessor :file
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbvmomi
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Rich Lane
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -130,40 +130,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
-- CONTRIBUTORS.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- devel/analyze-vim-declarations.rb
-- devel/analyze-xml.rb
-- devel/benchmark.rb
-- devel/collisions.rb
-- devel/merge-internal-vmodl.rb
-- devel/merge-manual-vmodl.rb
-- examples/annotate.rb
-- examples/cached_ovf_deploy.rb
-- examples/clone_vm.rb
-- examples/create_vm-1.9.rb
-- examples/create_vm.rb
-- examples/delete_disk_from_vm.rb
-- examples/extraConfig.rb
-- examples/lease_tool.rb
-- examples/logbundle.rb
-- examples/logtail.rb
-- examples/nfs_datastore.rb
-- examples/power.rb
-- examples/readme-1.rb
-- examples/readme-2.rb
-- examples/run.sh
-- examples/screenshot.rb
-- examples/vdf.rb
-- examples/vm_drs_behavior.rb
 - exe/rbvmomish
 - lib/rbvmomi.rb
+- lib/rbvmomi/#vim.rb#
 - lib/rbvmomi/basic_types.rb
 - lib/rbvmomi/connection.rb
 - lib/rbvmomi/deserialization.rb
@@ -201,7 +172,7 @@ files:
 - lib/rbvmomi/vim/ServiceInstance.rb
 - lib/rbvmomi/vim/Task.rb
 - lib/rbvmomi/vim/VirtualMachine.rb
-- rbvmomi.gemspec
+- lib/rbvmomi/vmodl.rb
 - vmodl.db
 homepage: https://github.com/vmware/rbvmomi
 licenses:
@@ -222,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Ruby interface to the VMware vSphere API

data/.gitignore

@@ -1,13 +0,0 @@
-*.rbc
-*.swp
-*.swo
-.ruby-version
-.ruby-gemset
-Gemfile.lock
-/.bundle/
-/.yardoc/
-/coverage/
-/doc/
-/pkg/
-/vendor/bundle/
-/vmodl/

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 1.8.7
-  - 1.9.3
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-  - jruby-1.7.26
-  - jruby-9.1.8.0
-before_install:
-  - gem install bundler

data/.yardopts

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

data/CONTRIBUTORS.md

@@ -1,44 +0,0 @@
-* Adam Grare <agrare@redhat.com>
-* Anurag Uniyal <auniyal@vmware.com>
-* Benjamin Bytheway <ben.bytheway@imail.org>
-* Christian Dickmann <cdickmann@ubuntu.(none)>
-* Christian Dickmann <cdickmann@vmware.com>
-* Colin O'Byrne and Martin Marinov <cobyrne@vmware.com>
-* Colin O'Byrne and Nick Coelius <cobyrne@vmware.com>
-* Daniel Rife <daniel.rife@rightscale.com>
-* Dave Hewitt <43970119+davehewitt@users.noreply.github.com>
-* Dominic Cleal <dcleal@redhat.com>
-* Dominic Cleal <dominic@cleal.org>
-* Doug MacEachern <dougm@vmware.com>
-* E Arvidson <earvidso@users.noreply.github.com>
-* Erik Peterson <erik@subwindow.com>
-* Fabio Rapposelli <fabio@rapposelli.org>
-* Giuliano <giuliano@108.bz>
-* Guido Günther <agx@sigxcpu.org>
-* Hari Krishnamurthy <hkrishna@vmware.com>
-* J.R. Garcia <jr@garciaole.com>
-* Jacob Evans <jacob@dekz.net>
-* Justin <justin@labs.epiuse.com>
-* Kevin Menard <nirvdrum@gmail.com>
-* Lalitha Sripada <lsripada@vmware.com>
-* Martin Englund <martin@englund.nu>
-* Nan Liu <nan.liu@gmail.com>
-* Omar Baba <obaba@infinio.com>
-* Peter <peter.adkins@kernelpicnic.net>
-* Puneet Katyal <pkatyal@vmware.com>
-* Randy Robertson <rmrobert@vmware.com>
-* Rich Lane <lanerl@gmail.com>
-* Rich Lane <rlane@club.cc.cmu.edu>
-* Rich Lane <rlane@vmware.com>
-* Scott J. Goldman <scottjg@vmware.com>
-* Shawn Hartsock <hartsock@users.noreply.github.com>
-* Shawn Hartsock <hartsocks@vmware.com>
-* Shawn Hartsock <shawn.hartsock@gmail.com>
-* Soner Sevinc <sevincs@vmware.com>
-* Tom Bortels <bortels@gmail.com>
-* Tu Hoang <rebyn@me.com>
-* administrator <administrator@cdickmann-mbpro.gateway.2wire.net>
-* cdickmann <christian.dickmann@gmail.com>
-* howels <howels@users.noreply.github.com>
-* kumabuchi.kenji <k.kumabuchi+github@gmail.com>
-* thanhngn <thanhngn@users.noreply.github.com>

data/Gemfile

@@ -1,10 +0,0 @@
-# Copyright (c) 2016-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'json', '< 2' if RUBY_VERSION.start_with?('1.')
-gem 'nokogiri', '< 1.6' if RUBY_VERSION.start_with?('1.8.')
-gem 'test-unit', '~> 2.5' if RUBY_VERSION.start_with?('1.8.')

data/Rakefile

@@ -1,16 +0,0 @@
-# Copyright (c) 2010-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'yard'
-
-task(:default => :test)
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test_*.rb']
-  t.verbose = true
-end
-
-YARD::Rake::YardocTask.new

data/devel/analyze-vim-declarations.rb

@@ -1,217 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2010-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-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