rvc 1.5.0 → 1.6.0

data/README.rdoc

@@ -154,4 +154,4 @@ patch so everyone can use it.
 == Development
 
 Send patches to rlane@vmware.com, or fork the project on GitHub and send me a
-pull request.
+pull request. RVC developers hang out in #rvc on Freenode.

data/Rakefile

@@ -7,11 +7,12 @@ begin
     gem.email = "rlane@vmware.com"
     #gem.homepage = ""
     gem.authors = ["Rich Lane"]
-    gem.add_dependency 'rbvmomi', '>= 1.3.0'
+    gem.add_dependency 'rbvmomi', '>= 1.5.0'
     gem.add_dependency 'trollop', '>= 1.16.2'
     gem.add_dependency 'backports', '>= 1.18.2'
     gem.add_dependency 'highline', '>= 1.6.1'
     gem.add_dependency 'zip', '>= 2.0.2'
+    gem.add_dependency 'terminal-table', '>= 1.4.2'
     #gem.add_dependency 'ffi', '>= 1.0.7'
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

data/bin/rvc

@@ -28,6 +28,7 @@ require 'shellwords'
 require 'yaml'
 require 'backports'
 require 'rvc'
+require 'tempfile'
 
 VIM = RbVmomi::VIM
 
@@ -54,6 +55,7 @@ EOS
   opt :create_directory, "Create the initial directory if it doesn't exist", :short => :none
   opt :cmd, "command to evaluate", :short => 'c', :multi => true, :type => :string
   opt :script, "file to execute", :short => 's', :type => :string
+  opt :cookie, "authentication cookie file", :short => 'k', :type => :string
 end
 
 $interactive = $opts[:script].nil? and $stdin.tty?
@@ -77,20 +79,38 @@ $shell.session.connections.each do |key|
   conn = $shell.session.get_connection(key) or fail "no such connection #{key.inspect}"
   uri = "#{conn['username']}@#{conn['host']}"
   begin
-    puts "Connecting to #{uri}..."
+    puts "Connecting to #{conn['host']}..."
     CMD.vim.connect uri, {}
   rescue RVC::Util::UserError
-    puts "Failed to connect to #{uri}: #{$!.message}"
+    puts "Failed to connect to #{conn['host']}: #{$!.message}"
     exit 1
   end
 end
 
+cookies = {}
+certdigests = {}
+if $opts[:cookie]
+  File.readlines($opts[:cookie]).each do |info|
+    host, cookie, certdigest = info.chomp.split('|')
+    cookies[host] = cookie
+    certdigests[host] = certdigest
+  end
+end
+
 ARGV.each do |uri|
+  # get hostname from uri to display in "connecting to..." message
+  hostinfo = uri.split("@")
+  host = if hostinfo.length > 1
+           hostinfo[1].split(":")[0]
+         else
+           hostinfo[0].split(":")[0]
+         end
   begin
-    puts "Connecting to #{uri}..." if (ARGV+$shell.session.connections).size > 1
-    CMD.vim.connect uri, {}
+    puts "Connecting to #{host}..." if (ARGV+$shell.session.connections).size > 1
+    CMD.vim.connect uri, {:cookie => cookies[host],
+                          :certdigest => certdigests[host]}
   rescue RVC::Util::UserError
-    puts "Failed to connect to #{uri}: #{$!.message}"
+    puts "Failed to connect to #{host}: #{$!.message}"
     exit 1
   end
 end
@@ -99,7 +119,11 @@ if $interactive
   RVC::Completion.install
   history_fn = "#{ENV['HOME']}/.rvc-history"
   IO.foreach(history_fn) { |l| Readline::HISTORY << l.chomp } rescue puts "Welcome to RVC. Try the 'help' command."
-  history = File.open(history_fn, 'a')
+  begin
+    history = File.open(history_fn, 'a')
+  rescue Errno::EACCES
+    history = nil
+  end
 end
 
 if $opts[:path]
@@ -127,23 +151,43 @@ if defined? Ocra
 end
 
 if $interactive
-  $stderr.puts "VMRC is not installed. You will be unable to view virtual machine consoles. Use the vmrc.install command to install it." unless CMD.vmrc.find_vmrc 
+  if ENV['DISPLAY']
+    $stderr.puts "VMRC is not installed. You will be unable to view virtual machine consoles. Use the vmrc.install command to install it." unless CMD.vmrc.find_vmrc
+  end
   $stderr.puts "Use the 'connect' command to connect to an ESX or VC server." if $shell.connections.empty?
   CMD.basic.ls RVC::Util.lookup_single('.')
 end
 
+trap "SIGCHLD" do |sig|
+  begin
+    while pid = Process.wait(-1, Process::WNOHANG)
+    end
+  rescue Errno::ECHILD
+  end
+end
+
 if $opts[:script]
   $shell.eval_ruby File.read($opts[:script]), $opts[:script]
 else
   while true
     begin
-      input = $opts[:cmd].shift || Readline.readline($shell.prompt, false) or break
+      begin
+        input = $opts[:cmd].shift || Readline.readline($shell.prompt, false) or break
+      rescue
+        puts "\n#{$!.class} during readline: #{$!.message}"
+        $!.backtrace.each { |x| puts x } if $shell.debug
+        next
+      end
       input = input.strip
       next if input.empty?
-      (history.puts input; Readline::HISTORY << input) unless input == Readline::HISTORY.to_a[-1]
+      (history && history.puts(input); Readline::HISTORY << input) unless input == Readline::HISTORY.to_a[-1]
       $shell.eval_input input
     rescue Interrupt
       puts
     end
   end
 end
+
+$shell.connections.each do |name, conn|
+  conn.close if conn.respond_to? :close rescue puts("failed to close connection #{name.inspect}: #{$!.class}: #{$!.message}")
+end

data/lib/rvc/completion.rb

@@ -40,10 +40,16 @@ module Completion
 
   Completor = lambda do |word|
     return unless word
-    line = Readline.line_buffer if Readline.respond_to? :line_buffer
-    append_char, candidates = RVC::Completion.complete word, line
-    Readline.completion_append_character = append_char
-    candidates
+    begin
+      line = Readline.line_buffer if Readline.respond_to? :line_buffer
+      append_char, candidates = RVC::Completion.complete word, line
+      Readline.completion_append_character = append_char
+      candidates
+    rescue RVC::Util::UserError
+      puts
+      puts $!.message
+      Readline.refresh_line
+    end
   end
 
   def self.install
@@ -58,25 +64,44 @@ module Completion
   end
 
   def self.complete word, line
-    candidates = if line
-      if line[' ']
-        child_candidates(word)
-      else
-        cmd_candidates(word)
-      end
+    line ||= ''
+    first_whitespace_index = line.index(' ')
+
+    if Readline.respond_to? :point
+      do_complete_cmd = !first_whitespace_index || first_whitespace_index >= Readline.point
+      do_complete_args = !do_complete_cmd
     else
-      child_candidates(word) + cmd_candidates(word)
+      do_complete_cmd = true
+      do_complete_args = true
+    end
+
+    candidates = []
+
+    if do_complete_cmd
+      candidates.concat cmd_candidates(word)
     end
 
-    candidates += mark_candidates(word)
+    if do_complete_args
+      mod, cmd, args = Shell.parse_input line
+      if mod and mod.completor_for cmd
+        candidates.concat RVC::complete_for_cmd(line, word)
+      else
+        candidates.concat(fs_candidates(word) +
+                          long_option_candidates(mod, cmd, word))
+      end
+    end
 
-    if candidates.size == 1 and cmd_candidates(word).member?(candidates[0])
-      append_char = ' '
+    if candidates.size == 1
+      append_char = candidates[0][1]
     else
-      append_char = '/'
+      append_char = '?' # should never be displayed
     end
 
-    return append_char, candidates
+    return append_char, candidates.map(&:first)
+  end
+
+  def self.fs_candidates word
+    child_candidates(word) + mark_candidates(word)
   end
 
   def self.cmd_candidates word
@@ -86,7 +111,18 @@ module Completion
       m.commands.each { |s| ret << "#{name}.#{s}" }
     end
     ret.concat ALIASES.keys
-    ret.sort.select { |e| e.match(prefix_regex) }
+    ret.grep(prefix_regex).sort.
+        map { |x| [x, ' '] }
+  end
+
+  def self.long_option_candidates mod, cmd, word
+    return [] unless mod and cmd
+    parser = mod.opts_for cmd
+    return [] unless parser.is_a? RVC::OptionParser
+    prefix_regex = /^#{Regexp.escape(word)}/
+    parser.specs.map { |k,v| "--#{v[:long]}" }.
+                 grep(prefix_regex).sort.
+                 map { |x| [x, ' '] }
   end
 
   # TODO convert to globbing
@@ -101,13 +137,15 @@ module Completion
     children.
       select { |k,v| k.gsub(' ', '\\ ') =~ /^#{Regexp.escape(last)}/ }.
       map { |k,v| (arcs+[k])*'/' }.
-      map { |x| x.gsub ' ', '\\ ' }
+      map { |x| x.gsub ' ', '\\ ' }.
+      map { |x| [x, '/'] }
   end
 
   def self.mark_candidates word
     return [] unless word.empty? || word[0..0] == '~'
     prefix_regex = /^#{Regexp.escape(word[1..-1] || '')}/
-    $shell.session.marks.sort.grep(prefix_regex).map { |x| "~#{x}" }
+    $shell.session.marks.grep(prefix_regex).sort.
+                         map { |x| ["~#{x}", '/'] }
   end
 end
 end

data/lib/rvc/extensions/ComputeResource.rb

@@ -25,8 +25,8 @@ class RbVmomi::VIM::ComputeResource
     pct_cpu_used = 100.0*stats[:usedCPU]/stats[:totalCPU]
     pct_mem_used = 100.0*stats[:usedMem]/stats[:totalMem]
     puts "name: #{name}"
-    puts "cpu #{stats[:totalCPU]} GHz (#{pct_cpu_used.to_i}% used)"
-    puts "memory #{stats[:totalMem]} GB (#{pct_mem_used.to_i}% used)"
+    puts "cpu: #{stats[:totalCPU]/1e3} GHz (#{pct_cpu_used.to_i}% used)"
+    puts "memory: #{stats[:totalMem]/1e3} GB (#{pct_mem_used.to_i}% used)"
     puts "hosts:"
     host.each do |h|
       puts " #{h.name}"

data/lib/rvc/extensions/DVPortSetting.rb

@@ -0,0 +1,108 @@
+# 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.
+
+include RVC::Util
+
+class RbVmomi::VIM::DVPortSetting
+  def dump_config vds, prefix, show_inheritance = true, show_uplinkinfo = true
+    @show_inheritance = show_inheritance
+
+    # map network respool to human-readable name
+    if self.networkResourcePoolKey
+       poolName  = translate_respool vds, self.networkResourcePoolKey, show_inheritance
+    end
+    puts_policy "#{prefix}blocked:", self.blocked
+    puts_policy("#{prefix}vlan:", self.vlan, "", nil) { |v| translate_vlan v }
+    if self.networkResourcePoolKey
+       puts        "#{prefix}network resource pool: #{poolName}"
+    end
+    p = self.inShapingPolicy
+    if p
+       puts        "#{prefix}Rx Shaper: "
+       puts_policy "#{prefix}  enabled:", p.enabled
+       avg_bw = p.averageBandwidth
+       puts_policy("#{prefix}  average bw:", avg_bw, "b/sec"){|v|metric(v)}
+       puts_policy("#{prefix}  peak bw:", p.peakBandwidth, "b/sec"){|v|metric(v)}
+       puts_policy("#{prefix}  burst size:", p.burstSize, "B"){|v|metric(v)}
+    end
+    p = self.outShapingPolicy
+    if p
+       puts        "#{prefix}Tx Shaper:"
+       puts_policy "#{prefix}  enabled:", p.enabled
+       avg_bw = p.averageBandwidth
+       puts_policy("#{prefix}  average bw:", avg_bw, "b/sec") { |v| metric(v) }
+       puts_policy("#{prefix}  peak bw:", p.peakBandwidth, "b/sec") {|v| metric(v)}
+       puts_policy("#{prefix}  burst size:", p.burstSize, "B") {|v| metric(v)}
+    end
+    if show_uplinkinfo
+      p = self.uplinkTeamingPolicy
+      if p
+         puts        "#{prefix}Uplink Teaming Policy:"
+         puts_policy "#{prefix}  policy:", p.policy  #XXX map the strings values
+         puts_policy "#{prefix}  reverse policy:", p.reversePolicy
+         puts_policy "#{prefix}  notify switches:", p.notifySwitches
+         puts_policy "#{prefix}  rolling order:", p.rollingOrder
+         c = p.failureCriteria
+         if c
+            puts        "#{prefix}  Failure Criteria: "
+            puts_policy "#{prefix}    check speed:", c.checkSpeed
+            puts_policy("#{prefix}    speed:", c.speed, "Mb/sec")# { |v| metric(v) }
+            puts_policy "#{prefix}    check duplex:", c.checkDuplex
+            puts_policy "#{prefix}    full duplex:", c.fullDuplex
+            puts_policy "#{prefix}    check error percentage:",  c.checkErrorPercent
+            puts_policy "#{prefix}    max error percentage:", c.percentage, "%"
+            puts_policy "#{prefix}    check beacon:", c.checkBeacon
+         end
+         o = p.uplinkPortOrder
+         if o
+            puts        "#{prefix}  Uplink Port Order:"
+            puts_policy("#{prefix}    active:", o,"", :activeUplinkPort){|v|v.join(',')}
+            puts_policy("#{prefix}    standby:",o,"",:standbyUplinkPort){|v|v.join(',')}
+         end
+      end
+    end
+    p = self.securityPolicy
+    if p
+       puts        "#{prefix}Security:"
+       puts_policy "#{prefix}  allow promiscuous mode:", p.allowPromiscuous
+       puts_policy "#{prefix}  allow mac changes:", p.macChanges
+       puts_policy "#{prefix}  allow forged transmits:", p.forgedTransmits
+       puts_policy "#{prefix}enable ipfix monitoring:", self.ipfixEnabled
+       puts_policy "#{prefix}forward all tx to uplink:", self.txUplink
+    end
+  end
+
+  def puts_policy prefix, policy, suffix = "", prop = :value, &b
+    b ||= lambda { |v| v }
+    if policy
+       if prop != nil
+          v = policy.send(prop)
+       else
+          v = policy
+       end
+       print "#{prefix} #{b.call(v)}#{suffix}"
+       if @show_inheritance and policy.inherited == false
+          puts "*"
+       else
+          puts ""
+       end
+    end
+  end
+end

data/lib/rvc/extensions/Datacenter.rb

@@ -27,10 +27,25 @@ class RbVmomi::VIM::Datacenter
     vmFolder, datastoreFolder, networkFolder, hostFolder =
       collect *%w(vmFolder datastoreFolder networkFolder hostFolder)
     {
-      'vm' => vmFolder,
-      'datastore' => datastoreFolder,
-      'network' => networkFolder,
-      'host' => hostFolder,
+      'vms' => vmFolder,
+      'datastores' => datastoreFolder,
+      'networks' => networkFolder,
+      'computers' => hostFolder,
     }
   end
+
+  # For compatibility with previous RVC versions
+  def traverse_one arc
+    children = self.children
+    return children[arc] if children.member? arc
+    if arc == 'vm' then return vmFolder
+    elsif arc == 'datastore' then return datastoreFolder
+    elsif arc == 'network' then return networkFolder
+    elsif arc == 'host' then return hostFolder
+    end
+  end
+
+  def self.folder?
+    true
+  end
 end

data/lib/rvc/extensions/Datastore.rb

@@ -23,10 +23,15 @@ class RbVmomi::VIM::Datastore
     s, info, = collect :summary, :info
     puts "type: #{s.type}"
     puts "url: #{s.accessible ? s.url : '<inaccessible>'}"
-    puts "uuid: #{info.vmfs.uuid}"
     puts "multipleHostAccess: #{s.multipleHostAccess}"
     puts "capacity: %0.2fGB" % (s.capacity.to_f/10**9)
     puts "free space: %0.2fGB" % (s.freeSpace.to_f/10**9)
+    case info
+    when VIM::VmfsDatastoreInfo
+      puts "uuid: #{info.vmfs.uuid}"
+    when VIM::NasDatastoreInfo
+      puts "location: #{info.nas.remoteHost}:#{info.nas.remotePath}"
+    end
   end
 
   def self.ls_properties

data/lib/rvc/extensions/DistributedVirtualPort.rb

@@ -0,0 +1,146 @@
+# 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::DistributedVirtualPort
+  include RVC::InventoryObject
+
+  field 'ip' do
+    summary "The guest tools reported IP address."
+    property 'connectee'
+    block do |c|
+      ip = nil
+      vm = c.connectedEntity
+      if vm.is_a? VIM::VirtualMachine
+        info = vm.guest.net.reject { |info|
+          info.deviceConfigId.to_s != c.nicKey
+        }.first
+        if info != nil
+          #XXX deal with multiple ips?
+          ip = info.ipAddress[0]
+        end
+      end
+      ip
+    end
+  end
+
+  field 'mac' do
+    summary "The guest tools reported IP address."
+    property 'connectee'
+    block do |c|
+      mac = nil
+      vm = c.connectedEntity
+      if vm.is_a? VIM::VirtualMachine
+        info = vm.config.hardware.device.reject { |device|
+          !(device.class < VIM::VirtualEthernetCard &&
+            device.key.to_s == c.nicKey)
+        }.first
+        if info != nil
+          mac = info.macAddress
+        end
+      end
+      mac
+    end
+  end
+
+  def display_info
+    # if possible, get info about the connected VM
+    vm_name = ""
+    mac = ""
+    ip = ""
+    if self.connectee
+      vm = self.connectee.connectedEntity
+      if vm.class == VIM::VirtualMachine
+        vm_name = vm.name
+        mac = vm.config.hardware.device.reject { |device|
+          !(device.class < VIM::VirtualEthernetCard &&
+            device.key.to_s == self.connectee.nicKey)
+        }.first.macAddress
+        nicinfo = vm.guest.net.reject { |info|
+          info.deviceConfigId.to_s != self.connectee.nicKey.to_s
+        }.first
+
+        if nicinfo != nil
+          ip = nicinfo.ipAddress
+          if nicinfo.macAddress != nil and nicinfo.macAddress != ""
+            mac = nicinfo.macAddress
+          end
+        end
+      end
+    end
+
+    # if possible, get info about the port configuration
+    poolName = "-"
+    vlan = "-"
+    link_up = false
+    if self.state.runtimeInfo
+      vds = self.rvc_parent.config.distributedVirtualSwitch
+      poolName = translate_respool vds, self.config.setting.networkResourcePoolKey
+      vlan = translate_vlan self.state.runtimeInfo.vlanIds
+      link_up = self.state.runtimeInfo.linkUp
+    end
+
+
+    #puts "name: #{self.config.name}"
+    puts        "link up: #{link_up}"
+    #puts       "vds: #{vds.name}"
+    #puts       "portgroup: #{self.rvc_parent.name}"
+    #puts        "vlan: #{vlan}"
+    #puts        "network resource pool: #{poolName}"
+    puts        "name: #{self.config.name}"
+    puts        "description: #{self.config.description}"
+    puts        "host: #{if self.proxyHost then self.proxyHost.name end}"
+    puts        "vm: #{vm_name}"
+    puts        "mac: #{mac}"
+    puts        "ip: #{ip}"
+    puts        "Port Settings:"
+    #XXX scope?
+    self.config.setting.dump_config vds, "  ", true, false
+    if self.state
+      if self.state.stats
+        puts "Statistics:"
+        stats = self.state.stats
+        # normally, i would explicitly write this out, but in this case
+        # the stats are pretty self explanatory, and require pretty much
+        # no formatting, so we just procedurally generate them
+        stats.class.full_props_desc.map { |stat|
+          stat = stat['name']
+          num = stats.send(stat)
+          # skip uninteresting properties
+          if !num.is_a?(Integer) then next end
+          # un-camelcase the name of the stat
+          stat = stat.gsub(/[A-Z]/) { |p| ' ' + p.downcase}
+          puts "  #{stat}: #{num}"
+        }
+      end
+    end
+  end
+
+  def children
+    {
+      'vm' => self.connectee.connectedEntity,
+      'host' => self.proxyHost
+    }
+  end
+
+  def invalidate vds
+    port = vds.FetchDVPorts(:criteria => { :portKey => [self.key] }).first
+    @props = port.props
+  end
+end