rvc 1.6.0 → 1.7.0

data/lib/rvc/modules/issue.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rvc/vim'
+
 opts :show do
   summary "Show issues on the given entities"
   arg :entity, nil, :lookup => VIM::ManagedEntity, :multi => true

data/lib/rvc/modules/mark.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rvc/vim'
+
 opts :mark do
   summary "Save an object for later use"
   arg :key, "Name for this mark"
@@ -29,7 +31,7 @@ rvc_alias :mark, :m
 
 def mark key, objs
   err "invalid mark name" unless key =~ /^\w+$/
-  $shell.session.set_mark key, objs
+  shell.fs.marks[key] = objs
 end
 
 
@@ -42,7 +44,7 @@ rvc_alias :edit, :me
 
 def edit key
   editor = ENV['VISUAL'] || ENV['EDITOR'] || 'vi'
-  objs = $shell.session.get_mark(key) or err "no such mark #{key.inspect}"
+  objs = shell.fs.marks[key] or err "no such mark #{key.inspect}"
   filename = File.join(Dir.tmpdir, "rvc.#{Time.now.to_i}.#{rand(65536)}")
   File.open(filename, 'w') { |io| objs.each { |obj| io.puts(obj.rvc_path_str) } }
   begin
@@ -61,5 +63,5 @@ opts :list do
 end
 
 def list
-  $shell.session.marks.each { |x| puts x }
+  shell.fs.marks.each { |k,v| puts k }
 end

data/lib/rvc/modules/perf.rb

@@ -1,9 +1,24 @@
-begin
-  require 'gnuplot'
-  RVC::HAVE_GNUPLOT = true
-rescue LoadError
-  RVC::HAVE_GNUPLOT = false
-end
+# 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.
+
+require 'rvc/vim'
 
 TIMEFMT = '%Y-%m-%dT%H:%M:%SZ'
 
@@ -15,6 +30,39 @@ DISPLAY_TIMEFMT = {
   4 => '%Y/%m/%d',
 }
 
+def require_gnuplot
+  begin
+    require 'gnuplot'
+  rescue LoadError
+    Gem::Specification.reset
+    begin
+      require 'gnuplot'
+    rescue LoadError
+      err "The gnuplot gem is not installed"
+    end
+  end
+end
+
+def find_interval pm, start
+  now = Time.now
+  ago = now - start
+
+  if ago < 3600
+    #puts "Using realtime interval, period = 20 seconds."
+    interval_id = 20
+    display_timefmt = DISPLAY_TIMEFMT[:realtime]
+  else
+    intervals = pm.historicalInterval
+    interval = intervals.find { |x| now - x.length < start }
+    err "start time is too long ago" unless interval
+    #puts "Using historical interval #{interval.name.inspect}, period = #{interval.samplingPeriod} seconds."
+    interval_id = interval.samplingPeriod
+    display_timefmt = DISPLAY_TIMEFMT[interval.key]
+  end
+
+  return interval_id, display_timefmt
+end
+
 opts :plot do
   summary "Plot a graph of the given performance counters"
   arg :counter, "Counter name"
@@ -22,10 +70,17 @@ opts :plot do
   opt :terminal, "Display plot on terminal", :default => ENV['DISPLAY'].nil?
   opt :start, "Start time", :type => :date, :short => 's'
   opt :end, "End time", :type => :date, :short => 'e'
+  summary <<-EOS
+
+Example:
+  perf.plot cpu.usagemhz myvm myvm2 --start '20 minutes ago'
+
+See perf.counters to determine which performance counters are available.
+  EOS
 end
 
 def plot counter_name, objs, opts
-  err "The gnuplot gem is not installed" unless RVC::HAVE_GNUPLOT
+  require_gnuplot
   vim = single_connection objs
   pm = vim.serviceContent.perfManager
   group_key, counter_key, rollup_type = counter_name.split('.', 3)
@@ -35,20 +90,8 @@ def plot counter_name, objs, opts
   opts[:start] ||= opts[:end] - 1800
 
   err "end time is in the future" unless opts[:end] <= Time.now
-  ago = now - opts[:start]
 
-  if ago < 3600
-    #puts "Using realtime interval, period = 20 seconds."
-    interval_id = 20
-    display_timefmt = DISPLAY_TIMEFMT[:realtime]
-  else
-    intervals = pm.historicalInterval
-    interval = intervals.find { |x| now - x.length < opts[:start] }
-    err "start time is too long ago" unless interval
-    #puts "Using historical interval #{interval.name.inspect}, period = #{interval.samplingPeriod} seconds."
-    interval_id = interval.samplingPeriod
-    display_timefmt = DISPLAY_TIMEFMT[interval.key]
-  end
+  interval_id, display_timefmt = find_interval pm, opts[:start]
 
   all_counters = Hash[pm.perfCounter.map { |x| [x.key, x] }]
 
@@ -59,9 +102,8 @@ def plot counter_name, objs, opts
   metric = metrics.find do |metric|
     counter = all_counters[metric.counterId]
     counter.groupInfo.key == group_key &&
-      counter.nameInfo.key == counter_key &&
-      counter.rollupType == rollup_type
-  end or err "no such metric"
+      counter.nameInfo.key == counter_key
+  end or err "counter #{group_key}.#{counter_key} was not found in the #{interval_id}s interval"
   counter = all_counters[metric.counterId]
 
   specs = objs.map do |obj|
@@ -105,6 +147,10 @@ def retrieve_datasets pm, counter, specs
   results = pm.QueryPerf(:querySpec => specs)
   datasets = results.map do |result|
     times = result.sampleInfoCSV.split(',').select { |x| x['T']  }
+    if result.value.empty?
+      puts "No data for #{result.entity.name} #{counter.name}"
+      next
+    end
     data = result.value[0].value.split(',').map(&:to_i)
 
     if counter.unitInfo.key == 'percent'
@@ -123,7 +169,7 @@ def retrieve_datasets pm, counter, specs
       ds.using = '1:2'
       ds.title = result.entity.name
     end
-  end
+  end.compact
 end
 
 def with_gnuplot persist
@@ -152,7 +198,7 @@ opts :watch do
 end
 
 def watch counter_name, objs, opts
-  err "The gnuplot gem is not installed" unless RVC::HAVE_GNUPLOT
+  require_gnuplot
   with_gnuplot false do |gp|
     puts "Press Ctrl-C to stop."
     while true
@@ -181,6 +227,14 @@ def counters obj
     interval = nil
   end
 
+  active_intervals = pm.active_intervals
+  active_intervals_text = lambda do |level|
+    return '' unless level
+    xs = active_intervals[level]
+    return 'none' if xs.empty?
+    xs.map { |x| x.name.match(/Past (\w+)/)[1] } * ','
+  end
+
   metrics = pm.QueryAvailablePerfMetric(
     :entity => obj, 
     :intervalId => interval)
@@ -188,12 +242,19 @@ def counters obj
                                map { |id| pm.perfcounter_idhash[id] }
 
   groups = available_counters.group_by { |counter| counter.groupInfo }
+
+  table = Terminal::Table.new
+  table.add_row ["Name", "Description", "Unit", "Level", "Active Intervals"]
   groups.sort_by { |group,counters| group.key }.each do |group,counters|
-    puts "#{group.label}:"
-    counters.sort_by(&:pretty_name).each do |counter|
-      puts " #{counter.pretty_name}: #{counter.nameInfo.label} (#{counter.unitInfo.label})"
+    table.add_separator
+    table.add_row [{ :value => group.label, :colspan => 5}]
+    table.add_separator
+    counters.sort_by(&:name).each do |counter|
+      table.add_row [counter.name, counter.nameInfo.label, counter.unitInfo.label,
+                     counter.level, active_intervals_text[counter.level]]
     end
   end
+  puts(table)
 end
 
 
@@ -208,8 +269,7 @@ def counter counter_name, obj
   pm = vim.serviceContent.perfManager
   counter = pm.perfcounter_hash[counter_name] or err "no such counter #{counter_name.inspect}"
 
-  intervals = pm.historicalInterval
-  active_intervals = lambda { |level| intervals.select { |x| x.level >= level } }
+  active_intervals = pm.active_intervals
   active_intervals_text = lambda do |level|
     xs = active_intervals[level]
     xs.empty? ? 'none' : xs.map(&:name).map(&:inspect) * ', '
@@ -254,9 +314,15 @@ end
 
 def stats metrics, objs, opts
   metrics = metrics.split(",")
-  obj = objs.first
-  pm = obj._connection.serviceContent.perfManager
-  interval = pm.provider_summary(obj).refreshRate
+
+  vim = single_connection objs
+  pm = vim.serviceContent.perfManager
+
+  metrics.each do |x|
+    err "no such metric #{x}" unless pm.perfcounter_hash.member? x
+  end
+
+  interval = pm.provider_summary(objs.first).refreshRate
   start_time = nil
   if interval == -1
     # Object does not support real time stats

data/lib/rvc/modules/permissions.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rvc/vim'
+
 opts :get do
   summary "Display the permissions of a managed entity"
   arg :obj, nil, :lookup => VIM::ManagedEntity, :multi => true

data/lib/rvc/modules/resource_pool.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rvc/vim'
+
 opts :create do
   summary "Create a resource pool"
   arg :name, "Name of the new resource pool."

data/lib/rvc/modules/role.rb

@@ -18,8 +18,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rvc/vim'
+
 def cur_auth_mgr
-  conn = $shell.fs.cur._connection
+  conn = shell.fs.cur._connection
   conn.serviceContent.authorizationManager
 end
 

data/lib/rvc/modules/snapshot.rb

@@ -18,6 +18,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rvc/vim'
+VIM::VirtualMachine
+
 opts :create do
   summary "Snapshot a VM"
   arg :vm, nil, :lookup => VIM::VirtualMachine
@@ -71,11 +74,16 @@ end
 
 
 opts :remove do
-  summary "Remove a snapshot"
-  arg :snapshot, nil, :lookup => RVC::SnapshotFolder
+  summary "Remove snapshots"
+  arg :snapshots, nil, :multi => true, :lookup => RVC::SnapshotFolder
   opt :remove_children, "Whether to remove the snapshot's children too"
 end
 
-def remove snapshot, opts
-  tasks [snapshot.find_tree.snapshot], :RemoveSnapshot, :removeChildren => opts[:remove_children]
+def remove snapshots, opts
+  # Sort by path and use reverse_each to remove child snapshots first
+  snapshots.sort_by! {|s| s.rvc_path_str }
+
+  snapshots.reverse_each do |snapshot|
+    tasks [snapshot.find_tree.snapshot], :RemoveSnapshot, :removeChildren => opts[:remove_children]
+  end
 end

data/lib/rvc/modules/statsinterval.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rvc/vim'
+
 #see vSphere Client: Administration -> vCenter Server Settings -> Statistics -> Statistics Intervals
 
 def stats_time secs
@@ -39,19 +41,19 @@ opts :list do
 end
 
 def list
-  conn = single_connection [$shell.fs.cur]
-  perfman = conn.serviceContent.perfManager
+  conn = lookup_single('~@')
+  pm = conn.serviceContent.perfManager
 
-  columns = ["    Name      ", "Interval Duration", "Save For   ", "Statistics Level"]
-  format = columns.map {|s| "%-#{s.size}s"}.join(" | ")
-  puts sprintf format, *columns
-  puts columns.map {|s| "-" * s.size }.join("-+-")
+  table = Terminal::Table.new
+  table.add_row ["Name", "Enabled", "Interval Duration", "Save For", "Statistics Level"]
+  table.add_separator
 
-  perfman.historicalInterval.each do |interval|
-    puts sprintf format, "[#{interval.enabled ? 'x' : ' '}] #{interval.name}",
-    stats_time(interval.samplingPeriod),
-    stats_time(interval.length), interval.level.to_s
+  pm.historicalInterval.each do |interval|
+    table.add_row [interval.name, interval.enabled, stats_time(interval.samplingPeriod),
+                   stats_time(interval.length), interval.level]
   end
+
+  puts table
 end
 
 
@@ -65,7 +67,7 @@ opts :update do
 end
 
 def update name, opts
-  conn = single_connection [$shell.fs.cur]
+  conn = single_connection [shell.fs.cur]
   perfman = conn.serviceContent.perfManager
 
   interval = perfman.historicalInterval.select {|i| i.name == name or i.name == "Past #{name}" }.first

data/lib/rvc/modules/vds.rb

@@ -18,7 +18,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require "terminal-table/import"
+require 'rvc/vim'
+
+require "terminal-table"
 
 opts :summarize do
   summary ""
@@ -440,13 +442,13 @@ opts :show_running_config do
 end
 
 def show_running_config vds
-  MODULES['basic'].info vds
+  shell.cmds.basic.info vds
   portgroups = vds.children['portgroups']
   portgroups.rvc_link vds, 'portgroups'
   vds.children['portgroups'].children.each do |name, pg|
     pg.rvc_link portgroups, name
     puts '---'
-    MODULES['basic'].info pg
+    shell.cmds.basic.info pg
   end
 end
 
@@ -461,13 +463,13 @@ def show_all_portgroups path
     paths = nil
   end
 
-  vds = MODULES['find'].find_items nil, paths, ['vds']
+  vds = shell.cmds.find.find_items nil, paths, ['vds']
   pgs = []
   vds.each do |v|
     v.portgroup.each { |pg| pgs << pg}
   end
-  RVC::MODULES['basic'].table pgs, { :field => ["vds_name", "name", "vlan"],
-                                     :field_given => true }
+  shell.cmds.basic.table pgs, { :field => ["vds_name", "name", "vlan"],
+                                        :field_given => true }
 end
 
 opts :show_all_vds do
@@ -481,9 +483,9 @@ def show_all_vds path
     paths = nil
   end
 
-  vds = MODULES['find'].find_items nil, paths, ['vds']
-  RVC::MODULES['basic'].table vds, { :field => ['name', 'vlans', 'hosts'],
-                                     :field_given => true }
+  vds = shell.cmds.find.find_items nil, paths, ['vds']
+  shell.cmds.basic.table vds, { :field => ['name', 'vlans', 'hosts'],
+                                        :field_given => true }
 end
 
 opts :show_all_ports do
@@ -571,7 +573,7 @@ def show_all_ports path
     rows.each { |r| r.delete_at(2) }
   end
 
-  t = table(columns)
+  t = Terminal::Table.new(columns)
   rows.sort_by { |o| o[0] }.each { |o| t << o }
   puts t
 end
@@ -603,3 +605,58 @@ def abbrev_hostnames names
     }
   end
 end
+
+opts :add_hosts do
+  summary "Add hosts to a vDS"
+  arg :vds, nil, :lookup => VIM::DistributedVirtualSwitch
+  arg :hosts, nil, :lookup => VIM::HostSystem, :multi => true
+  opt :vmnic, "Name of vmnic (multiple allowed)", :multi => true, :type => :string
+end
+
+def add_hosts vds, hosts, opts
+  pnicSpec = opts[:vmnic].map do |x| 
+    VIM::DistributedVirtualSwitchHostMemberPnicSpec({:pnicDevice => x})
+  end
+  dvsConfig = VIM::DVSConfigSpec({
+    :configVersion => vds.config.configVersion, 
+    :host => hosts.map do |host|
+      {
+        :operation => :add, 
+        :host => host, 
+        :backing => VIM::DistributedVirtualSwitchHostMemberPnicBacking({
+          :pnicSpec => pnicSpec
+        })
+      }
+    end
+  })
+  task = vds.ReconfigureDvs_Task(:spec => dvsConfig)
+  progress([task])
+end
+
+opts :create_vmknic do
+  summary "Create a vmknic on vDS on one or more hosts. Always uses DHCP"
+  arg :portgroup, nil, :lookup => VIM::Network
+  arg :host, nil, :lookup => VIM::HostSystem, :multi => true
+end
+
+def create_vmknic portgroup, hosts, opts
+  if !portgroup.is_a?(VIM::DistributedVirtualPortgroup)
+    err "Legacy switches not supported yet"
+  end
+  hosts.each do |host|
+    ns = host.configManager.networkSystem 
+    vmknic_name = ns.AddVirtualNic(
+      :portgroup => "", 
+      :nic => {
+        :ip => {
+          :dhcp => true
+        },
+        :distributedVirtualPort => VIM::DistributedVirtualSwitchPortConnection(
+          :portgroupKey => portgroup.key, 
+          :switchUuid => portgroup.config.distributedVirtualSwitch.uuid,
+        )
+      }
+    )
+    puts "Host #{host.name}: Added vmknic #{vmknic_name}"
+  end
+end