mkuzmin-rbvmomi 1.8.2.1

data/examples/logtail.rb

@@ -0,0 +1,60 @@
+# Translation of example 2-2 from the vSphere SDK for Perl Programming Guide
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+
+opts = Trollop.options do
+  banner <<-EOS
+Follow a log file.
+
+Usage:
+    logtail.rb [options] [logKey]
+
+If logKey is not provided the list of available log keys will be printed and
+the program will exit.
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+Other options:
+  EOS
+end
+
+Trollop.die("must specify host") unless opts[:host]
+logKey = ARGV[0]
+
+vim = VIM.connect opts
+diagMgr = vim.serviceContent.diagnosticManager
+
+if not logKey
+  puts "Available logs:"
+  diagMgr.QueryDescriptions.each do |desc|
+    puts "#{desc.key}: #{desc.info.label}"
+  end
+  exit 0
+end
+
+# Obtain the last line of the logfile by setting an arbitrarily large
+# line number as the starting point
+log = diagMgr.BrowseDiagnosticLog(key: logKey, start: 999999999)
+lineEnd = log.lineEnd
+
+# Get the last 5 lines of the log first, and then check every 2 seconds
+# to see if the log size has increased.
+start = lineEnd - 5
+while true
+  log = diagMgr.BrowseDiagnosticLog(key: logKey, start: start)
+  if log.lineStart != 0
+    log.lineText.each do |l|
+      puts l
+    end
+  end
+  start = log.lineEnd + 1
+  sleep 2
+end

data/examples/nfs_datastore.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+CMDS = %w(mount unmount)
+
+opts = Trollop.options do
+  banner <<-EOS
+Mount/Unmount an NFS datastore from a cluster or single host system.
+
+Usage:
+    nfs_datastore.rb [options] resource mount nfs-hostname:/remote/path [name]
+    nfs_datastore.rb [options] resource unmount nfs-hostname:/remote/path [name]
+
+Commands: #{CMDS * ' '}
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+VM location options:
+    EOS
+
+    rbvmomi_datacenter_opt
+
+    text <<-EOS
+
+Other options:
+  EOS
+
+  stop_on CMDS
+end
+
+Trollop.die("must specify host") unless opts[:host]
+
+cr_path = ARGV[0] or Trollop.die("no system name given")
+cmd = ARGV[1] or Trollop.die("no command given")
+abort "invalid command" unless CMDS.member? cmd
+nfs_spec = ARGV[2] or Trollop.die("no nfs path given")
+remoteHost, remotePath = nfs_spec.split(":")
+localPath = ARGV[3] || remoteHost
+mode = "readOnly" #hardcoded.
+
+vim = VIM.connect opts
+dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
+cr = dc.find_compute_resource(cr_path) || dc.hostFolder.children.find(cr_path).first
+abort "compute resource not found" unless cr
+
+case cr
+when VIM::ClusterComputeResource
+  hosts = cr.host
+when VIM::ComputeResource
+  hosts = [cr]
+else
+  abort "invalid resource"
+end
+
+hosts.each do |host|
+  hds = host.configManager.datastoreSystem
+
+  ds = hds.datastore.select {|ds|
+    ds.info.respond_to?(:nas) and
+    ds.info.name == localPath and
+    ds.info.nas.remoteHost == remoteHost and
+    ds.info.nas.remotePath == remotePath
+  }.first
+
+  case cmd
+  when 'mount'
+    if ds
+      puts "already mounted on #{host.name} as #{ds.name}"
+    else
+      ds =
+        hds.CreateNasDatastore(:spec => VIM.HostNasVolumeSpec(:remoteHost => remoteHost,
+                                                              :remotePath => remotePath,
+                                                              :localPath  => localPath,
+                                                              :accessMode => mode))
+      puts "mounted on #{host.name} as #{ds.name}"
+    end
+  when 'unmount'
+    if ds
+      hds.RemoveDatastore(:datastore => ds)
+      puts "unmounted from #{host.name}"
+    else
+      puts "not mounted on #{host.name}"
+    end
+  else
+    abort "invalid command"
+  end
+end

data/examples/power.rb

@@ -0,0 +1,59 @@
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+CMDS = %w(on off reset suspend destroy)
+
+opts = Trollop.options do
+  banner <<-EOS
+Perform VM power operations.
+
+Usage:
+    power.rb [options] cmd VM
+
+Commands: #{CMDS * ' '}
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+VM location options:
+    EOS
+
+    rbvmomi_datacenter_opt
+
+    text <<-EOS
+
+Other options:
+  EOS
+
+  stop_on CMDS
+end
+
+cmd = ARGV[0] or Trollop.die("no command given")
+vm_name = ARGV[1] or Trollop.die("no VM name given")
+Trollop.die("must specify host") unless opts[:host]
+
+vim = VIM.connect opts
+
+dc = vim.serviceInstance.content.rootFolder.traverse(opts[:datacenter], VIM::Datacenter) or abort "datacenter not found"
+vm = dc.vmFolder.traverse(vm_name, VIM::VirtualMachine) or abort "VM not found"
+
+case cmd
+when 'on'
+  vm.PowerOnVM_Task.wait_for_completion
+when 'off'
+  vm.PowerOffVM_Task.wait_for_completion
+when 'reset'
+  vm.ResetVM_Task.wait_for_completion
+when 'suspend'
+  vm.SuspendVM_Task.wait_for_completion
+when 'destroy'
+  vm.Destroy_Task.wait_for_completion
+else
+  abort "invalid command"
+end

data/examples/readme-1.rb

@@ -0,0 +1,35 @@
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+opts = Trollop.options do
+  banner <<-EOS
+Example 1 from the README: Power on a VM.
+
+Usage:
+    readme-1.rb [options] VM name
+
+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 = RbVmomi::VIM.connect opts
+dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or fail "datacenter not found"
+vm = dc.find_vm(vm_name) or fail "VM not found"
+vm.PowerOnVM_Task.wait_for_completion

data/examples/readme-2.rb

@@ -0,0 +1,51 @@
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+opts = Trollop.options do
+  banner <<-EOS
+Example 2 from the README: Power on a VM the hard way.
+
+Usage:
+    readme-2.rb [options] VM name
+
+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 = RbVmomi::VIM.connect opts
+rootFolder = vim.serviceInstance.content.rootFolder
+dc = rootFolder.childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == opts[:datacenter] } or fail "datacenter not found"
+vm = dc.vmFolder.childEntity.grep(RbVmomi::VIM::VirtualMachine).find { |x| x.name == vm_name } 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'

data/examples/run.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+set -e
+
+if [ -z "$RBVMOMI_HOST" ]
+then
+  echo "export at least RBVMOMI_HOST"
+  exit 1
+fi
+
+EXAMPLES="$(dirname $(which $0))"
+export RUBYOPT="-I$EXAMPLES/../lib -rubygems"
+
+source "$HOME/.rvm/scripts/rvm"
+rvm use 1.8.7
+ruby -v
+RUBY=ruby
+
+echo Creating VM
+$RUBY $EXAMPLES/create_vm.rb foo
+echo Powering on VM
+$RUBY $EXAMPLES/power.rb on foo
+echo Resetting VM
+$RUBY $EXAMPLES/power.rb reset foo
+echo Powering off VM
+$RUBY $EXAMPLES/power.rb off foo
+echo "Powering on VM (1)"
+$RUBY $EXAMPLES/readme-1.rb foo
+echo Powering off VM
+$RUBY $EXAMPLES/power.rb off foo
+echo "Powering on VM (2)"
+$RUBY $EXAMPLES/readme-2.rb foo
+echo "Setting extraConfig"
+$RUBY $EXAMPLES/extraConfig.rb foo set guestinfo.bar=baz
+echo "Listing extraConfig"
+$RUBY $EXAMPLES/extraConfig.rb foo list | grep guestinfo.bar
+echo Powering off VM
+$RUBY $EXAMPLES/power.rb off foo
+echo Querying datastore utilization
+$RUBY $EXAMPLES/vdf.rb
+echo Destroying VM
+$RUBY $EXAMPLES/power.rb destroy foo

data/examples/screenshot.rb

@@ -0,0 +1,48 @@
+# Based on takeVMScreenshot.pl by William Lam
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+
+opts = Trollop.options do
+  banner <<-EOS
+Take a screenshot.
+
+Usage:
+    screenshot.rb [options] vm filename
+
+A PNG image will be saved to the given filename.
+
+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")
+output_path = ARGV[1] or abort("must specify output filename")
+
+vim = VIM.connect opts
+dc = vim.serviceInstance.find_datacenter(opts[:datacenter])
+vm = dc.find_vm vm_name
+abort "VM must be running" unless vm.runtime.powerState == 'poweredOn'
+remote_path = vm.CreateScreenshot_Task.wait_for_completion
+remote_path =~ /^(\/vmfs\/volumes\/[^\/]+)\// or fail
+datastore_prefix = $1
+datastore_path = $'
+datastore = vm.datastore.find { |ds| ds.info.url == datastore_prefix }
+datastore.download datastore_path, output_path

data/examples/vdf.rb

@@ -0,0 +1,81 @@
+# Translation of vGhetto vdf, originally by William Lam
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+
+VIM = RbVmomi::VIM
+
+opts = Trollop.options do
+  banner <<-EOS
+Display utilization of each datastore in the datacenter.
+
+Usage:
+    vdf.rb [options]
+
+VIM connection options:
+    EOS
+
+    rbvmomi_connection_opts
+
+    text <<-EOS
+
+Datacenter selection:
+    EOS
+
+    rbvmomi_datacenter_opt
+
+    text <<-EOS
+
+Other options:
+  EOS
+end
+
+Trollop.die("must specify host") unless opts[:host]
+
+vim = VIM.connect opts
+
+dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
+
+def si n
+  ['', 'K', 'M', 'G', 'T', 'P'].each_with_index do |x,i|
+    v = n.to_f/(1000**i)
+    return v,x if v < 1000 or x == 'P'
+  end
+end
+
+def unit n, u, p
+  "%.*g%s%s" % [p, si(n), u].flatten
+end
+
+def b n
+  unit(n,'B',3)
+end
+
+puts "Filesystem#{' '*53}Size     Used     Avail    Use%     Mounted on"
+fmt = "%-62s %-8s %-8s %-8s %-8s %s"
+
+if false
+  # simple version
+  dc.datastore.sort_by { |ds| ds.info.url }.each do |ds|
+    s = ds.summary
+    next unless s.accessible
+    size = s.capacity
+    free = s.freeSpace
+    used = size - free
+    pct_used = used*100.0/size
+    puts(fmt % [ds.info.url, b(size), b(used), b(free), unit(pct_used,'%',3), ds.name])
+  end
+else
+  # fast version
+  paths = %w(name info.url summary.accessible summary.capacity summary.freeSpace)
+  propSet = [{ :type => 'Datastore', :pathSet => paths }]
+  filterSpec = { :objectSet => dc.datastore.map { |ds| { :obj => ds } }, :propSet => propSet }
+  data = vim.propertyCollector.RetrieveProperties(:specSet => [filterSpec])
+  data.select { |d| d['summary.accessible'] }.sort_by { |d| d['info.url'] }.each do |d|
+    size = d['summary.capacity']
+    free = d['summary.freeSpace']
+    used = size - free
+    pct_used = used*100.0/size
+    puts(fmt % [d['info.url'], b(size), b(used), b(free), unit(pct_used,'%',3), d['name']])
+  end
+end