rbvmomi2 3.0.0

data/lib/rbvmomi/vim/ServiceInstance.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::VIM::ServiceInstance
+  # Retrieve a Datacenter.
+  # If no path is given the first datacenter will be returned.
+  # @param path (see Folder#traverse)
+  # @return [Datacenter]
+  def find_datacenter path=nil
+    if path
+      content.rootFolder.traverse path, RbVmomi::VIM::Datacenter
+    else
+      content.rootFolder.childEntity.grep(RbVmomi::VIM::Datacenter).first
+    end
+  end
+
+  # Wait for several tasks to complete.
+  # @param interested [Array] Property paths to watch for updates.
+  # @param tasks [Array] Tasks to wait on.
+  # @yield [Hash] Called when a property is updated on a task.
+  #               The parameter is a hash from tasks to hashes from
+  #               property path to value.
+  # @return [void]
+  def wait_for_multiple_tasks interested, tasks
+    version = ''
+    interested = (interested + ['info.state']).uniq
+    task_props = Hash.new { |h,k| h[k] = {} }
+
+    filter = _connection.propertyCollector.CreateFilter :spec => {
+      :propSet => [{ :type => 'Task', :all => false, :pathSet => interested }],
+      :objectSet => tasks.map { |x| { :obj => x } },
+    }, :partialUpdates => false
+
+    begin
+      until task_props.size == tasks.size and task_props.all? { |k,h| %w(success error).member? h['info.state'] }
+        result = _connection.propertyCollector.WaitForUpdates(:version => version)
+        version = result.version
+        os = result.filterSet[0].objectSet
+
+        os.each do |o|
+          changes = Hash[o.changeSet.map { |x| [x.name, x.val] }]
+
+          interested.each do |k|
+            task = tasks.find { |x| x._ref == o.obj._ref }
+            task_props[task][k] = changes[k] if changes.member? k
+          end
+        end
+
+        yield task_props if block_given?
+      end
+    ensure
+      _connection.propertyCollector.CancelWaitForUpdates
+      filter.DestroyPropertyFilter
+    end
+
+    task_props
+  end
+end

data/lib/rbvmomi/vim/Task.rb

@@ -0,0 +1,68 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::VIM::Task
+  # Wait for a task to finish.
+  # @return +info.result+ on success.
+  # @raise +info.error+ on error.
+  def wait_for_completion
+    wait_until('info.state') { %w(success error).member? info.state }
+    case info.state
+    when 'success'
+      info.result
+    when 'error'
+      raise info.error
+    end
+  end
+  
+  # Wait for all child tasks to finish. If any one child task failed,
+  # the exception of the first failing task is thrown.
+  # @return [Hash] Map of tasks to their +info.result+ on success.
+  # @raise +info.error+ on error.
+  def wait_for_childtask_completion
+    si = _connection.serviceInstance
+    tasks_props = si.wait_for_multiple_tasks(
+      ['info.state', 'info.result', 'info.error'],
+      self.child_tasks
+    )
+    Hash[tasks_props.map do |task, props|
+      case props['info.state']
+      when 'success'
+        [task, props['info.result']]
+      when 'error'
+        raise props['info.error']
+      end
+    end]
+  end
+
+  # Wait for a task to finish, with progress notifications.
+  # @return (see #wait_for_completion)
+  # @raise (see #wait_for_completion)
+  # @yield [info.progress]
+  def wait_for_progress
+    wait_until('info.state', 'info.progress') do
+      yield info.progress if block_given?
+      %w(success error).member? info.state
+    end
+    case info.state
+    when 'success'
+      info.result
+    when 'error'
+      raise info.error
+    end
+  end
+  
+  # Get child tasks of this task.
+  # @return [Array] List of VIM::Task objects
+  def child_tasks
+    tm = _connection.serviceContent.taskManager
+    col = tm.CreateCollectorForTasks(:filter => {
+      :rootTaskKey => [self.info.key],
+    })
+    # XXX: Likely this is not enough and we need to collect pages other
+    #      than the latest.
+    tasks = col.latestPage.map{|x| x.task}
+    col.DestroyCollector()
+    tasks
+  end
+end

data/lib/rbvmomi/vim/VirtualMachine.rb

@@ -0,0 +1,75 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::VIM::VirtualMachine
+  # Retrieve the MAC addresses for all virtual NICs.
+  # @return [Hash] Keyed by device label.
+  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
+
+  # Get the IP of the guest, but only if it is not stale
+  # @return [String] Current IP reported (as per VMware Tools) or nil
+  def guest_ip
+    g = self.guest
+    if g.ipAddress && (g.toolsStatus == "toolsOk" || g.toolsStatus == "toolsOld")
+      g.ipAddress
+    else
+      nil
+    end
+  end
+
+  # Add a layer of delta disks (redo logs) in front of every disk on the VM.
+  # This is similar to taking a snapshot and makes the VM a valid target for
+  # creating a linked clone.
+  #
+  # Background: The API for linked clones is quite strange. We can't create
+  # a linked straight from any VM. The disks of the VM for which we can create a
+  # linked clone need to be read-only and thus VC demands that the VM we
+  # are cloning from uses delta-disks. Only then it will allow us to
+  # share the base disk.
+  def add_delta_disk_layer_on_all_disks
+    spec = update_spec_add_delta_disk_layer_on_all_disks
+    self.ReconfigVM_Task(:spec => spec).wait_for_completion
+  end
+
+  # Updates a passed in spec to perform the task of adding a delta disk layer
+  # on top of all disks. Does the same as add_delta_disk_layer_on_all_disks
+  # but instead of issuing the ReconfigVM_Task, it just constructs the
+  # spec, so that the caller can batch a couple of updates into one
+  # ReconfigVM_Task.
+  def update_spec_add_delta_disk_layer_on_all_disks spec = {}
+    devices,  = self.collect 'config.hardware.device'
+    disks = devices.grep(RbVmomi::VIM::VirtualDisk)
+    device_change = []
+    disks.each do |disk|
+      device_change << {
+        :operation => :remove,
+        :device => disk
+      }
+      device_change << {
+        :operation => :add,
+        :fileOperation => :create,
+        :device => disk.dup.tap { |x|
+          x.backing = x.backing.dup
+          x.backing.fileName = "[#{disk.backing.datastore.name}]"
+          x.backing.parent = disk.backing
+        },
+      }
+    end
+    if spec.is_a?(RbVmomi::VIM::VirtualMachineConfigSpec)
+      spec.deviceChange ||= []
+      spec.deviceChange += device_change
+    else
+      spec[:deviceChange] ||= []
+      spec[:deviceChange] += device_change
+    end
+    spec
+  end
+end

data/lib/rbvmomi/vim.rb

@@ -0,0 +1,157 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+# 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
+  # @option opts [Boolean] :close_on_exit (true) If true, will close connection with at_exit
+  # @option opts [RbVmomi::SSO] :sso (nil) Use SSO token to login if set
+  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.7' 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
+        elsif opts[:sso]
+          vim.serviceContent.sessionManager.LoginByToken
+        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 } if opts.fetch(:close_on_exit, true)
+    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.rb

@@ -0,0 +1,16 @@
+# Copyright (c) 2010-2019 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+# RbVmomi is a Ruby interface to the vSphere management interface
+module RbVmomi
+  # @private
+  # @deprecated Use +RbVmomi::VIM.connect+.
+  def self.connect(opts)
+    VIM.connect opts
+  end
+end
+
+require_relative 'rbvmomi/connection'
+require_relative 'rbvmomi/sso'
+require_relative 'rbvmomi/version'
+require_relative 'rbvmomi/vim'

data/lib/rbvmomi2.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative './rbvmomi'

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: rbvmomi2
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Rich Lane
+- Christian Dickmann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description:
+email: jrg@vmware.com
+executables:
+- rbvmomish
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- exe/rbvmomish
+- lib/rbvmomi.rb
+- lib/rbvmomi/basic_types.rb
+- lib/rbvmomi/connection.rb
+- lib/rbvmomi/deserialization.rb
+- lib/rbvmomi/fault.rb
+- lib/rbvmomi/optimist.rb
+- lib/rbvmomi/pbm.rb
+- lib/rbvmomi/sms.rb
+- lib/rbvmomi/sms/SmsStorageManager.rb
+- lib/rbvmomi/sso.rb
+- lib/rbvmomi/trivial_soap.rb
+- lib/rbvmomi/type_loader.rb
+- lib/rbvmomi/utils/admission_control.rb
+- lib/rbvmomi/utils/deploy.rb
+- lib/rbvmomi/utils/leases.rb
+- lib/rbvmomi/utils/perfdump.rb
+- lib/rbvmomi/version.rb
+- lib/rbvmomi/vim.rb
+- lib/rbvmomi/vim/ComputeResource.rb
+- lib/rbvmomi/vim/Datacenter.rb
+- lib/rbvmomi/vim/Datastore.rb
+- lib/rbvmomi/vim/DynamicTypeMgrAllTypeInfo.rb
+- lib/rbvmomi/vim/DynamicTypeMgrDataTypeInfo.rb
+- lib/rbvmomi/vim/DynamicTypeMgrManagedTypeInfo.rb
+- lib/rbvmomi/vim/Folder.rb
+- lib/rbvmomi/vim/HostSystem.rb
+- lib/rbvmomi/vim/ManagedEntity.rb
+- lib/rbvmomi/vim/ManagedObject.rb
+- lib/rbvmomi/vim/ObjectContent.rb
+- lib/rbvmomi/vim/ObjectUpdate.rb
+- lib/rbvmomi/vim/OvfManager.rb
+- lib/rbvmomi/vim/PerfCounterInfo.rb
+- lib/rbvmomi/vim/PerformanceManager.rb
+- lib/rbvmomi/vim/PropertyCollector.rb
+- lib/rbvmomi/vim/ReflectManagedMethodExecuter.rb
+- lib/rbvmomi/vim/ResourcePool.rb
+- lib/rbvmomi/vim/ServiceInstance.rb
+- lib/rbvmomi/vim/Task.rb
+- lib/rbvmomi/vim/VirtualMachine.rb
+- lib/rbvmomi2.rb
+- vmodl.db
+homepage: https://github.com/vmware/rbvmomi
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key:
+specification_version: 4
+summary: Ruby interface to the VMware vSphere API
+test_files: []