class RbVmomi::VIM

A connection to one vSphere SDK endpoint. @see serviceInstance

Public Class Methods

connect(opts) click to toggle source

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.

# File lib/rbvmomi/vim.rb, line 21
def self.connect opts
  fail unless opts.is_a? Hash
  fail "host option required" unless opts[:host]
  opts[:cookie] ||= nil
  opts[:user] ||= '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'
  rev_given = opts[:rev] != nil
  opts[:rev] = '4.0' unless rev_given
  opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug

  new(opts).tap do |vim|
    unless opts[:cookie]
      vim.serviceContent.sessionManager.Login :userName => opts[:user], :password => opts[:password]
    end
    unless rev_given
      rev = vim.serviceContent.about.apiVersion
      vim.rev = [rev, '5.5'].min
    end
  end
end

Public Instance Methods

close() click to toggle source
Calls superclass method
# File lib/rbvmomi/vim.rb, line 47
def close
  VIM::SessionManager(self, 'SessionManager').Logout rescue RbVmomi::Fault
  self.cookie = nil
  super
end
get_log_keys(host=nil) click to toggle source
# File lib/rbvmomi/vim.rb, line 113
def get_log_keys host=nil
  diagMgr = self.serviceContent.diagnosticManager
  keys = []
  diagMgr.QueryDescriptions(:host => host).each do |desc|
    keys << "#{desc.key}"
  end
  keys
end
get_log_lines(logKey, lines=5, start=nil, host=nil) click to toggle source
# File lib/rbvmomi/vim.rb, line 97
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
instanceUuid() click to toggle source
# File lib/rbvmomi/vim.rb, line 93
def instanceUuid
  serviceContent.about.instanceUuid
end
pretty_print(pp) click to toggle source

@private

# File lib/rbvmomi/vim.rb, line 89
def pretty_print pp
  pp.text "VIM(#{@opts[:host]})"
end
propertyCollector() click to toggle source

Alias to serviceContent.propertyCollector

# File lib/rbvmomi/vim.rb, line 79
def propertyCollector
  serviceContent.propertyCollector
end
rev=(x) click to toggle source
Calls superclass method
# File lib/rbvmomi/vim.rb, line 53
def rev= x
  super
  @serviceContent = nil
end
root()
Alias for: rootFolder
rootFolder() click to toggle source

Alias to serviceContent.rootFolder

# File lib/rbvmomi/vim.rb, line 72
def rootFolder
  serviceContent.rootFolder
end
Also aliased as: root
searchIndex() click to toggle source

Alias to serviceContent.searchIndex

# File lib/rbvmomi/vim.rb, line 84
def searchIndex
  serviceContent.searchIndex
end
serviceContent() click to toggle source

Alias to serviceInstance.RetrieveServiceContent

# File lib/rbvmomi/vim.rb, line 67
def serviceContent
  @serviceContent ||= serviceInstance.RetrieveServiceContent
end
serviceInstance() click to toggle source

Return the ServiceInstance

The ServiceInstance is the root of the vSphere inventory. @see www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.ServiceInstance.html

# File lib/rbvmomi/vim.rb, line 62
def serviceInstance
  VIM::ServiceInstance self, 'ServiceInstance'
end