rbvmomi 1.11.3 → 3.0.0

data/examples/clone_vm.rb

@@ -1,88 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'trollop'
-require 'rbvmomi'
-require 'rbvmomi/trollop'
-
-VIM = RbVmomi::VIM
-
-opts = Trollop.options do
-  banner <<-EOS
-Clone a VM.
-
-Usage:
-    clone_vm.rb [options] source_vm dest_vm
-
-VIM connection options:
-    EOS
-
-    rbvmomi_connection_opts
-
-    text <<-EOS
-
-VM location options:
-    EOS
-
-    rbvmomi_datacenter_opt
-
-    text <<-EOS
-
-Other options:
-  EOS
-
-  opt :linked_clone, "Use a linked clone instead of a full clone"
-end
-
-Trollop.die("must specify host") unless opts[:host]
-ARGV.size == 2 or abort "must specify VM source name and VM target name"
-vm_source = ARGV[0]
-vm_target = ARGV[1]
-
-vim = VIM.connect opts
-dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
-vm = dc.find_vm(vm_source) or abort "VM not found"
-
-if opts[:linked_clone]
-  # 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.
-  #
-  # Thus, this code first create a delta disk on top of the base disk for
-  # the to-be-cloned VM, if delta disks aren't used already.
-  disks = vm.config.hardware.device.grep(VIM::VirtualDisk)
-  disks.select { |x| x.backing.parent == nil }.each do |disk|
-    spec = {
-      :deviceChange => [
-        {
-          :operation => :remove,
-          :device => disk
-        },
-        {
-          :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
-          },
-        }
-      ]
-    }
-    vm.ReconfigVM_Task(:spec => spec).wait_for_completion
-  end
-
-  relocateSpec = VIM.VirtualMachineRelocateSpec(:diskMoveType => :moveChildMostDiskBacking)
-else
-  relocateSpec = VIM.VirtualMachineRelocateSpec
-end
-
-spec = VIM.VirtualMachineCloneSpec(:location => relocateSpec,
-                                   :powerOn => false,
-                                   :template => false)
-
-vm.CloneVM_Task(:folder => vm.parent, :name => vm_target, :spec => spec).wait_for_completion

data/examples/create_vm-1.9.rb

@@ -1,97 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'trollop'
-require 'rbvmomi'
-require 'rbvmomi/trollop'
-
-VIM = RbVmomi::VIM
-
-opts = Trollop.options do
-  banner <<-EOS
-Create a VM.
-
-Usage:
-    create_vm-1.9.rb [options]
-
-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 = VIM.connect opts
-dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
-vmFolder = dc.vmFolder
-hosts = dc.hostFolder.children
-rp = hosts.first.resourcePool
-
-vm_cfg = {
-  name: vm_name,
-  guestId: 'otherGuest',
-  files: { vmPathName: '[datastore1]' },
-  numCPUs: 1,
-  memoryMB: 128,
-  deviceChange: [
-    {
-      operation: :add,
-      device: VIM.VirtualLsiLogicController(
-        key: 1000,
-        busNumber: 0,
-        sharedBus: :noSharing,
-      )
-    }, {
-      operation: :add,
-      fileOperation: :create,
-      device: VIM.VirtualDisk(
-        key: 0,
-        backing: VIM.VirtualDiskFlatVer2BackingInfo(
-          fileName: '[datastore1]',
-          diskMode: :persistent,
-          thinProvisioned: true,
-        ),
-        controllerKey: 1000,
-        unitNumber: 0,
-        capacityInKB: 4000000,
-      )
-    }, {
-      operation: :add,
-      device: VIM.VirtualE1000(
-        key: 0,
-        deviceInfo: {
-          label: 'Network Adapter 1',
-          summary: 'VM Network',
-        },
-        backing: VIM.VirtualEthernetCardNetworkBackingInfo(
-          deviceName: 'VM Network',
-        ),
-        addressType: 'generated'
-      )
-    }
-  ],
-  extraConfig: [
-    {
-      key: 'bios.bootOrder',
-      value: 'ethernet0'
-    }
-  ]
-}
-
-vmFolder.CreateVM_Task(:config => vm_cfg, :pool => rp).wait_for_completion

data/examples/create_vm.rb

@@ -1,97 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'trollop'
-require 'rbvmomi'
-require 'rbvmomi/trollop'
-
-VIM = RbVmomi::VIM
-
-opts = Trollop.options do
-  banner <<-EOS
-Create a VM.
-
-Usage:
-    create_vm.rb [options]
-
-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 = VIM.connect opts
-dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
-vmFolder = dc.vmFolder
-hosts = dc.hostFolder.children
-rp = hosts.first.resourcePool
-
-vm_cfg = {
-  :name => vm_name,
-  :guestId => 'otherGuest',
-  :files => { :vmPathName => '[datastore1]' },
-  :numCPUs => 1,
-  :memoryMB => 128,
-  :deviceChange => [
-    {
-      :operation => :add,
-      :device => VIM.VirtualLsiLogicController(
-        :key => 1000,
-        :busNumber => 0,
-        :sharedBus => :noSharing
-      )
-    }, {
-      :operation => :add,
-      :fileOperation => :create,
-      :device => VIM.VirtualDisk(
-        :key => 0,
-        :backing => VIM.VirtualDiskFlatVer2BackingInfo(
-          :fileName => '[datastore1]',
-          :diskMode => :persistent,
-          :thinProvisioned => true
-        ),
-        :controllerKey => 1000,
-        :unitNumber => 0,
-        :capacityInKB => 4000000
-      )
-    }, {
-      :operation => :add,
-      :device => VIM.VirtualE1000(
-        :key => 0,
-        :deviceInfo => {
-          :label => 'Network Adapter 1',
-          :summary => 'VM Network'
-        },
-        :backing => VIM.VirtualEthernetCardNetworkBackingInfo(
-          :deviceName => 'VM Network'
-        ),
-        :addressType => 'generated'
-      )
-    }
-  ],
-  :extraConfig => [
-    {
-      :key => 'bios.bootOrder',
-      :value => 'ethernet0'
-    }
-  ]
-}
-
-vmFolder.CreateVM_Task(:config => vm_cfg, :pool => rp).wait_for_completion

data/examples/extraConfig.rb

@@ -1,57 +0,0 @@
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'trollop'
-require 'rbvmomi'
-require 'rbvmomi/trollop'
-
-VIM = RbVmomi::VIM
-CMDS = %w(list set)
-
-opts = Trollop.options do
-  banner <<-EOS
-View and modify VM extraConfig options.
-
-Usage:
-    extraConfig.rb [options] VM list
-    extraConfig.rb [options] VM set key=value [key=value...]
-
-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
-
-vm_name = ARGV[0] or Trollop.die("no VM name given")
-cmd = ARGV[1] or Trollop.die("no command given")
-abort "invalid command" unless CMDS.member? cmd
-Trollop.die("must specify host") unless opts[:host]
-
-vim = VIM.connect opts
-
-dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
-vm = dc.find_vm(vm_name) or abort "VM not found"
-
-case cmd
-when 'list'
-  vm.config.extraConfig.each { |x| puts "#{x.key}: #{x.value}" }
-when 'set'
-  extraConfig = ARGV[2..-1].map { |x| x.split("=", 2) }.map { |k,v| { :key => k, :value => v } }
-  vm.ReconfigVM_Task(:spec => VIM.VirtualMachineConfigSpec(:extraConfig => extraConfig)).wait_for_completion
-end

data/examples/lease_tool.rb

@@ -1,106 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'trollop'
-require 'rbvmomi'
-require 'rbvmomi/trollop'
-require 'rbvmomi/utils/leases'
-require 'yaml'
-
-VIM = RbVmomi::VIM
-CMDS = ['set_lease_on_leaseless_vms', 'show_expired_vms', 
-        'show_soon_expired_vms', 'kill_expired_vms']
-
-opts = Trollop.options do
-  banner <<-EOS
-Tool for managing leases on VMs where leases are stored in YAML on VM annotations.
-
-Usage:
-    lease_tool.rb [options] <cmd>
-
-Commands: #{CMDS * ' '}
-
-VIM connection options:
-    EOS
-
-    rbvmomi_connection_opts
-
-    text <<-EOS
-
-VM location options:
-    EOS
-
-    rbvmomi_datacenter_opt
-
-    text <<-EOS
-
-Other options:
-  EOS
-
-  opt :vm_folder_path, "Path to VM folder to deploy VM into", :type => :string
-  opt :force, "Really perform VMs. Used with kill_expired_vms"
-
-  stop_on CMDS
-end
-
-Trollop.die("must specify host") unless opts[:host]
-cmd = ARGV[0] or Trollop.die("no command given")
-Trollop.die("no vm folder path given") unless opts[:vm_folder_path]
-
-vim = VIM.connect opts
-dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
-
-root_vm_folder = dc.vmFolder
-vm_folder = root_vm_folder.traverse(opts[:vm_folder_path], VIM::Folder)
-
-lease_tool = LeaseTool.new
-vms_props_list = (['runtime.powerState'] + lease_tool.vms_props_list).uniq
-inventory = vm_folder.inventory_flat('VirtualMachine' => vms_props_list) 
-inventory = inventory.select{|obj, props| obj.is_a?(VIM::VirtualMachine)}
-case cmd
-when 'set_lease_on_leaseless_vms'
-  lease_tool.set_lease_on_leaseless_vms(
-    inventory.keys, inventory,
-    :lease_minutes => 3 * 24 * 60 * 60 # 3 days
-  )
-when 'show_expired_vms'
-  vms = lease_tool.filter_expired_vms inventory.keys, inventory
-  vms.each do |vm, time_to_expiration|
-    puts "VM '#{inventory[vm]['name']}' is expired"
-  end  
-when 'kill_expired_vms'
-  vms = lease_tool.filter_expired_vms inventory.keys, inventory
-  vms.each do |vm, time_to_expiration|
-    puts "VM '#{inventory[vm]['name']}' is expired"
-    if !opts[:force]
-      puts "NOT killing VM '#{inventory[vm]['name']}' because --force not set"
-    else
-      puts "Killing expired VM '#{inventory[vm]['name']}'"
-      # Destroying VMs is very stressful for vCenter, and we aren't in a rush
-      # so do one VM at a time
-      if inventory[vm]['runtime.powerState'] == 'poweredOn'
-        vm.PowerOffVM_Task.wait_for_completion
-      end
-      vm.Destroy_Task.wait_for_completion
-    end
-  end  
-when 'show_soon_expired_vms'
-  vms = lease_tool.filter_expired_vms(
-    inventory.keys, inventory, 
-    :time_delta => 3.5 * 24 * 60 * 60, # 3.5 days 
-  )
-  # We could send the user emails here, but for this example, just print the
-  # VMs that will expire within the next 3.5 days
-  vms.each do |vm, time_to_expiration|
-    if time_to_expiration > 0
-      hours_to_expiration = time_to_expiration / (60.0 * 60.0) 
-      puts "VM '%s' expires in %.2fh" % [inventory[vm]['name'], hours_to_expiration]
-    else
-      puts "VM '#{inventory[vm]['name']}' is expired"
-    end
-  end  
-else
-  abort "invalid command"
-end

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 'trollop'
-require 'rbvmomi'
-require 'rbvmomi/trollop'
-
-VIM = RbVmomi::VIM
-DEFAULT_SERVER_PLACEHOLDER = '0.0.0.0'
-
-opts = Trollop.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
-
-Trollop.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 '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

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