rvc 1.5.0 → 1.6.0

data/lib/rvc/extensions/HostSystem.rb

@@ -31,10 +31,34 @@ class RbVmomi::VIM::HostSystem
     " (host): cpu #{numCpuPkgs}*#{numCpuCores}*#{"%.2f" % (cpuMhz.to_f/1000)} GHz, memory #{"%.2f" % (memorySize/10**9)} GB"
   end
 
+  def display_info
+    summary = self.summary
+    runtime = summary.runtime
+    stats = summary.quickStats
+    hw = summary.hardware
+    puts "connection state: #{runtime.connectionState}"
+    puts "power state: #{runtime.powerState}"
+    puts "uptime: #{"%0.2f" % ((Time.now - runtime.bootTime)/(24*3600))} days" if runtime.bootTime
+    puts "in maintenance mode: #{runtime.inMaintenanceMode}"
+    puts "standby mode: #{runtime.standbyMode}" if runtime.standbyMode
+    if about = summary.config.product
+      puts "product: #{about.fullName}"
+      puts "license: #{about.licenseProductName} #{about.licenseProductVersion}" if about.licenseProductName
+    end
+    if runtime.connectionState == 'connected' and runtime.powerState == 'poweredOn'
+      overallCpu = hw.numCpuPkgs * hw.numCpuCores * hw.cpuMhz
+      puts "cpu: %d*%d*%.2f GHz = %.2f GHz" % [hw.numCpuPkgs, hw.numCpuCores, hw.cpuMhz/1e3, overallCpu/1e3]
+      puts "cpu usage: %.2f GHz (%.1f%%)" % [stats.overallCpuUsage/1e3, 100*stats.overallCpuUsage/overallCpu]
+      puts "memory: %.2f GB" % [hw.memorySize/1e9]
+      puts "memory usage: %.2f GB (%.1f%%)" % [stats.overallMemoryUsage/1e3, 100*1e6*stats.overallMemoryUsage/hw.memorySize]
+    end
+  end
+
   def children
     {
       'vms' => RVC::FakeFolder.new(self, :ls_vms),
       'datastores' => RVC::FakeFolder.new(self, :ls_datastores),
+      'networks' => RVC::FakeFolder.new(self, :ls_networks),
     }
   end
 
@@ -45,4 +69,40 @@ class RbVmomi::VIM::HostSystem
   def ls_datastores
     RVC::Util.collect_children self, :datastore
   end
+
+  def ls_networks
+    RVC::Util.collect_children self, :network
+  end
+end
+
+class VIM::EsxcliCommand
+  def option_parser
+    parser = Trollop::Parser.new
+    parser.text cli_info.help
+    cli_info.param.each do |cli_param|
+      vmodl_param = type_info.paramTypeInfo.find { |x| x.name == cli_param.name }
+      opts = trollop_type(vmodl_param.type)
+      opts[:required] = vmodl_param.annotation.find { |a| a.name == "optional"} ? false : true
+      opts[:long] = cli_param.displayName
+      #pp opts.merge(:name => cli_param.name)
+      # XXX correct short options
+      parser.opt cli_param.name, cli_param.help, opts
+    end
+    parser
+  end
+
+  def trollop_type t
+    if t[-2..-1] == '[]'
+      multi = true
+      t = t[0...-2]
+    else
+      multi = false
+    end
+    type = case t
+    when 'string', 'boolean' then t.to_sym
+    when 'long' then :int
+    else fail "unexpected esxcli type #{t.inspect}"
+    end
+    { :type => type, :multi => multi }
+  end
 end

data/lib/rvc/extensions/ManagedEntity.rb

@@ -21,6 +21,25 @@
 class RbVmomi::VIM::ManagedEntity
   include RVC::InventoryObject
 
+  field 'name' do
+    summary "Name"
+    property 'name'
+    default
+  end
+
+  field 'status' do
+    summary 'Status (green/yellow/red/gray)'
+    property 'overallStatus'
+    default
+  end
+
+  STATUS_COLORS = {
+    'gray' => [],
+    'red' => [:red],
+    'green' => [],
+    'yellow' => [:yellow],
+  }
+
   def display_info
     puts "name: #{name}"
     puts "type: #{self.class.name}"

data/lib/rvc/extensions/ParaVirtualSCSIController.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+class RbVmomi::VIM::ParaVirtualSCSIController
+  def name
+    "pvscsi-#{key}"
+  end
+end

data/lib/rvc/extensions/PerfCounterInfo.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+class RbVmomi::VIM::PerfCounterInfo
+  def name
+    "#{groupInfo.key}.#{nameInfo.key}.#{rollupType}"
+  end
+end
+

data/lib/rvc/extensions/PerformanceManager.rb

@@ -0,0 +1,83 @@
+require 'date'
+
+class Time
+  def to_datetime
+    # Convert seconds + microseconds into a fractional number of seconds
+    seconds = sec + Rational(usec, 10**6)
+
+    # Convert a UTC offset measured in minutes to one measured in a
+    # fraction of a day.
+    offset = Rational(utc_offset, 60 * 60 * 24)
+    DateTime.new(year, month, day, hour, min, seconds, offset)
+  end
+end
+
+RbVmomi::VIM::PerfCounterInfo
+class RbVmomi::VIM::PerfCounterInfo
+  def pretty_name
+    @pretty_name ||= "#{self.groupInfo.key}.#{self.nameInfo.key}.#{self.rollupType}"
+  end
+end
+
+RbVmomi::VIM::PerformanceManager
+class RbVmomi::VIM::PerformanceManager
+  def perfcounter_cached
+    @perfcounter ||= perfCounter
+  end
+  
+  def perfcounter_hash
+    @perfcounter_hash ||= Hash[perfcounter_cached.map{|x| [x.pretty_name, x]}]
+  end
+  
+  def perfcounter_idhash 
+    @perfcounter_idhash ||= Hash[perfcounter_cached.map{|x| [x.key, x]}]
+  end
+  
+  def provider_summary obj
+    @provider_summary ||= {}
+    @provider_summary[obj.class] ||= QueryPerfProviderSummary(:entity => obj)
+  end
+
+  def retrieve_stats objects, metrics, opts = {}
+    opts = opts.dup
+    max_samples = opts[:max_samples] || 1
+    realtime = false
+    if not opts[:interval]
+      provider = provider_summary objects.first
+      opts[:interval] = provider.refreshRate
+      realtime = true
+    else
+      provider = provider_summary objects.first
+      if opts[:interval] == provider.refreshRate
+        realtime = true
+      end
+    end
+      
+    metric_ids = metrics.map do |x| 
+      RbVmomi::VIM::PerfMetricId(:counterId => perfcounter_hash[x].key, :instance => '*')
+    end
+    query_specs = objects.map do |obj|
+      RbVmomi::VIM::PerfQuerySpec({
+        :maxSample => max_samples, 
+        :entity => obj, 
+        :metricId => metric_ids, 
+        :intervalId => opts[:interval],
+        :startTime => (realtime == false ? opts[:start_time].to_datetime : nil),
+      })
+    end
+    stats = QueryPerf(:querySpec => query_specs)
+    
+    Hash[stats.map do |res|
+      [
+        res.entity, 
+        {
+          :sampleInfo => res.sampleInfo,
+          :metrics => Hash[res.value.map do |metric|
+            [perfcounter_idhash[metric.id.counterId].pretty_name, metric.value]
+          end]
+        }
+      ]
+    end]
+  end
+
+end

data/lib/rvc/extensions/ResourcePool.rb

@@ -35,6 +35,27 @@ class RbVmomi::VIM::ResourcePool
     ]
   end
 
+  def display_info
+    cfg = config
+    rt = runtime
+    cpuAlloc, memAlloc = cfg.cpuAllocation, cfg.memoryAllocation
+
+
+    cpu_shares_text = cpuAlloc.shares.level == 'custom' ? cpuAlloc.shares.shares.to_s : cpuAlloc.shares.level
+    mem_shares_text = memAlloc.shares.level == 'custom' ? memAlloc.shares.shares.to_s : memAlloc.shares.level
+
+    puts "cpu:"
+    puts " reservation: %0.2f GHz" % [cpuAlloc.reservation/1e3]
+    puts " limit: %0.2f GHz" % [cpuAlloc.limit/1e3]
+    puts " shares: #{cpu_shares_text}"
+    puts " usage: %0.2f Ghz (%0.1f)%%" % [rt.cpu.overallUsage/1e3, 100.0*rt.cpu.overallUsage/rt.cpu.maxUsage]
+    puts "memory:"
+    puts " reservation: %0.2f GB" % [memAlloc.reservation/1e3]
+    puts " limit: %0.2f GB" % [memAlloc.limit/1e3]
+    puts " shares: #{mem_shares_text}"
+    puts " usage: %0.2f GB (%0.1f)%%" % [rt.memory.overallUsage/1e9, 100.0*rt.memory.overallUsage/rt.memory.maxUsage]
+  end
+
   def children
     {
       'vms' => RVC::FakeFolder.new(self, :children_vms),

data/lib/rvc/extensions/VirtualDevice.rb

@@ -0,0 +1,59 @@
+# Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+class RbVmomi::VIM::VirtualDevice
+  include RVC::InventoryObject
+  attr_accessor :rvc_vm
+
+  # Stable name based on the device key, unit number, etc.
+  # May be overridden in subclasses.
+  def name
+    self.class.to_s =~ /^(?:Virtual)?(?:Machine)?(\w+?)(?:Card|Device|Controller)?$/
+    type = $1 ? $1.downcase : 'device'
+    "#{type}-#{key}"
+  end
+
+  def ls_text r
+    tags = []
+    tags << (connectable.connected ? :connected : :disconnected) if props.member? :connectable
+    " (#{self.class}): #{deviceInfo.summary}; #{tags * ' '}"
+  end
+
+  def display_info
+    super
+    devices, = rvc_vm.collect 'config.hardware.device'
+    puts "label: #{deviceInfo.label}"
+    puts "summary: #{deviceInfo.summary}"
+    puts "key: #{key}"
+    if controllerKey
+      controller = devices.find { |x| x.key == controllerKey }
+      puts "controller: #{controller.name}" if controller
+    end
+    puts "unit number: #{unitNumber}" if unitNumber
+    if connectable
+      puts "connectivity:"
+      puts " connected: #{connectable.connected}"
+      puts " start connected: #{connectable.startConnected}"
+      puts " guest control: #{connectable.allowGuestControl}"
+      puts " status: #{connectable.status}"
+    end
+  end
+end
+

data/lib/rvc/extensions/VirtualDisk.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+class RbVmomi::VIM::VirtualDisk
+  def name
+    "disk-#{controllerKey}-#{unitNumber}"
+  end
+end

data/lib/rvc/extensions/VirtualEthernetCard.rb

@@ -0,0 +1,32 @@
+# Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+class RbVmomi::VIM::VirtualEthernetCard
+  def display_info
+    super
+    puts "address type: #{addressType}"
+    puts "MAC address: #{macAddress}"
+    puts "Wake on LAN enabled: #{wakeOnLanEnabled}"
+  end
+
+  def name
+    "ethernet-#{unitNumber-7}"
+  end
+end

data/lib/rvc/extensions/VirtualMachine.rb

@@ -19,6 +19,105 @@
 # THE SOFTWARE.
 
 class RbVmomi::VIM::VirtualMachine
+  field 'on' do
+    summary "Is the VM powered on?"
+    properties %w(runtime.powerState)
+    block { |powerState| powerState == 'poweredOn' }
+    default
+  end
+  
+  field 'storagebw' do
+    summary "Storage Bandwidth"
+    perfmetrics %w(disk.read.average disk.write.average)
+    block do |read, write| 
+      if read && write
+        io = (read.sum.to_f / read.length) + (write.sum.to_f / write.length)
+        MetricNumber.new(io * 1024, 'B/s')
+      else
+        nil
+      end
+    end
+  end
+  
+  [['', 5], ['.realtime', 1], ['.5min', 5 * 3], ['.10min', 10 * 3]].each do |label, max_samples|
+    field "storageiops#{label}" do
+      summary "Storage IOPS"
+      perfmetrics %w(disk.numberReadAveraged.average disk.numberWriteAveraged.average)
+      perfmetric_settings :max_samples => max_samples
+      block do |read, write|
+        if read && write
+          io = (read.sum.to_f / read.length) + (write.sum.to_f / write.length)
+          MetricNumber.new(io, 'IOPS')
+        else
+          nil
+        end
+      end
+    end
+  end
+
+  field 'ip' do
+    summary "The guest tools reported IP address."
+    property 'guest.ipAddress'
+  end
+
+  field 'template' do
+    summary "Is this VM a template?"
+    property 'config.template'
+  end
+
+  field 'uptime' do
+    summary "VM's uptime in seconds"
+    properties %w(runtime.bootTime)
+    block { |t| t ? TimeDiff.new(Time.now-t) : nil }
+  end
+
+  field 'storage.used' do
+    summary "Total storage used"
+    properties %w(storage)
+    block do |storage|
+      MetricNumber.new(storage.perDatastoreUsage.map(&:committed).sum, 'B')
+    end
+  end
+
+  field 'storage.unshared' do
+    summary "Total storage unshared"
+    properties %w(storage)
+    block do |storage|
+      MetricNumber.new(storage.perDatastoreUsage.map(&:unshared).sum, 'B')
+    end
+  end
+
+  field 'storage.provisioned' do
+    summary "Total storage provisioned"
+    properties %w(storage)
+    block do |storage|
+      MetricNumber.new(storage.perDatastoreUsage.map { |x| x.uncommitted + x.committed }.sum, 'B')
+    end
+  end
+
+  field 'guest.id' do
+    summary 'Guest OS identifier'
+    property 'summary.config.guestId'
+  end
+
+  field 'tools.running' do
+    summary 'Are guest tools running?'
+    properties %w(guest.toolsRunningStatus)
+    block { |status| status == 'guestToolsRunning' }
+  end
+
+  field 'tools.uptodate' do
+    summary "Are guest tools up to date?"
+    properties %w(guest.toolsVersionStatus)
+    block { |status| status == 'guestToolsCurrent' }
+  end
+
+  field 'mac' do
+    summary "Mac address"
+    properties %w(config.hardware)
+    block { |hw| hw.device.grep(VIM::VirtualEthernetCard).map(&:macAddress) }
+  end
+
   def display_info
     config, runtime, guest = collect :config, :runtime, :guest
     RVC::Util.err "Information currently unavailable" unless config and runtime and guest
@@ -51,7 +150,12 @@ class RbVmomi::VIM::VirtualMachine
         dev.backing.class.name
       end
       guest_net = guest.net.find { |x| x.macAddress == dev.macAddress }
-      puts " #{dev.deviceInfo.label}: #{backing_info} #{dev.connectable.connected ? :connected : :disconnected} #{dev.macAddress} #{guest_net ? (guest_net.ipAddress * ' ') : ''}"
+      puts " #{dev.name}: #{backing_info} #{dev.connectable.connected ? :connected : :disconnected} #{dev.macAddress} #{guest_net ? (guest_net.ipAddress * ' ') : ''}"
+    end
+
+    puts "storage:"
+    storage.perDatastoreUsage.map do |usage|
+      puts " #{usage.datastore.name}: committed=#{usage.committed.metric}B uncommitted=#{usage.uncommitted.metric}B unshared=#{usage.unshared.metric}B"
     end
   end
 
@@ -72,6 +176,7 @@ class RbVmomi::VIM::VirtualMachine
       'networks' => RVC::FakeFolder.new(self, :rvc_children_networks),
       'files' => RVC::FakeFolder.new(self, :rvc_children_files),
       'snapshots' => RVC::RootSnapshotFolder.new(self),
+      'devices' => RVC::FakeFolder.new(self, :rvc_children_devices),
     }
   end
 
@@ -96,6 +201,12 @@ class RbVmomi::VIM::VirtualMachine
       [File.basename(file.name), objs.first]
     end]
   end
+
+  def rvc_children_devices
+    devices, = collect 'config.hardware.device'
+    devices.each { |x| x.rvc_vm = self }
+    Hash[devices.map { |x| [x.name, x] }]
+  end
 end
 
 class RVC::RootSnapshotFolder