rbvmomi 2.0.0 → 2.0.1

data/examples/logbundle.rb

@@ -1,66 +0,0 @@
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# @todo Retrieve ESX log bundles when run against VC.
-require 'optimist'
-require 'rbvmomi'
-require 'rbvmomi/optimist'
-
-VIM = RbVmomi::VIM
-DEFAULT_SERVER_PLACEHOLDER = '0.0.0.0'
-
-opts = Optimist.options do
-  banner <<-EOS
-Generate and retrieve a log bundle.
-
-Usage:
-    logbundle.rb [options] dest
-
-dest must be a directory.
-
-VIM connection options:
-    EOS
-
-    rbvmomi_connection_opts
-
-    text <<-EOS
-
-Other options:
-  EOS
-end
-
-Optimist.die("must specify host") unless opts[:host]
-dest = ARGV[0] or abort("must specify destination directory")
-
-abort "destination is not a directory" unless File.directory? dest
-
-vim = VIM.connect opts
-is_vc = vim.serviceContent.about.apiType == 'VirtualCenter'
-diagMgr = vim.serviceContent.diagnosticManager
-
-bundles =
-  begin
-    diagMgr.GenerateLogBundles_Task(includeDefault: true).wait_for_completion
-  rescue VIM::TaskInProgress
-    $!.task.wait_for_completion
-  end
-
-bundles.each do |b|
-  uri = URI.parse(b.url.sub('*', DEFAULT_SERVER_PLACEHOLDER))
-  dest_path = File.join(dest, File.basename(uri.path))
-  puts "downloading bundle #{b.url} to #{dest_path}"
-  if uri.host == DEFAULT_SERVER_PLACEHOLDER
-    vim.http.request_get(uri.path) do |res|
-      File.open dest_path, 'w' do |io|
-        res.read_body do |data|
-          io.write data
-          $stdout.write '.'
-          $stdout.flush
-        end
-      end
-      puts
-    end
-  else
-    puts 'not supported yet'
-  end
-end

data/examples/logtail.rb

@@ -1,63 +0,0 @@
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# Translation of example 2-2 from the vSphere SDK for Perl Programming Guide
-require 'optimist'
-require 'rbvmomi'
-require 'rbvmomi/optimist'
-
-VIM = RbVmomi::VIM
-
-opts = Optimist.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
-
-Optimist.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

@@ -1,99 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'optimist'
-require 'rbvmomi'
-require 'rbvmomi/optimist'
-
-VIM = RbVmomi::VIM
-CMDS = %w(mount unmount)
-
-opts = Optimist.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
-
-Optimist.die("must specify host") unless opts[:host]
-
-cr_path = ARGV[0] or Optimist.die("no system name given")
-cmd = ARGV[1] or Optimist.die("no command given")
-abort "invalid command" unless CMDS.member? cmd
-nfs_spec = ARGV[2] or Optimist.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

@@ -1,62 +0,0 @@
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'optimist'
-require 'rbvmomi'
-require 'rbvmomi/optimist'
-
-VIM = RbVmomi::VIM
-CMDS = %w(on off reset suspend destroy)
-
-opts = Optimist.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 Optimist.die("no command given")
-vm_name = ARGV[1] or Optimist.die("no VM name given")
-Optimist.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

@@ -1,38 +0,0 @@
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'rbvmomi'
-require 'rbvmomi/optimist'
-
-opts = Optimist.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
-
-Optimist.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

@@ -1,54 +0,0 @@
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'rbvmomi'
-require 'rbvmomi/optimist'
-
-opts = Optimist.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
-
-Optimist.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

@@ -1,41 +0,0 @@
-#!/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

@@ -1,51 +0,0 @@
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# Based on takeVMScreenshot.pl by William Lam
-require 'optimist'
-require 'rbvmomi'
-require 'rbvmomi/optimist'
-
-VIM = RbVmomi::VIM
-
-opts = Optimist.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
-
-Optimist.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