rvc 1.3.6 → 1.4.0

data/README.rdoc

@@ -47,6 +47,14 @@ example, the command to power off a VM is actually "vm.off", since it exists in
 the "vm" module, but since it is a common operation it has been aliased to
 "off".
 
+== Paths
+
+All vm operations need a full path, or relative path, rather than just the
+name of the resource. So to create a VM you would use:
+
+	/> vm.create -p /vm1/ha/host/hosta/resourcePool/pools/dev/ -d
+		/vm1/ha/datastore/datastore1 /vm1/ha/vms/newvm
+
 == Features
 
 === Tab-completion

data/Rakefile

@@ -39,3 +39,15 @@ begin
 rescue LoadError
   puts "Rcov not available. Install it with: gem install rcov"
 end
+
+begin
+  # HACK rvc needs to be installed as a gem
+  require 'rvc'
+  require 'ocra'
+  desc 'Compile into a win32 executable'
+  task :exe do
+    sh "ocra bin/rvc"
+  end
+rescue LoadError
+  puts "OCRA not available. Install it with: gem install ocra"
+end

data/TODO

@@ -1,8 +1,12 @@
 add commands for more entities
 add fake subfolders for more entities
-add fastpass authentication
+add fastpass and SSPI authentication
 
 commands:
 storage vmotion
 edit clusters
 add/remove hosts from clusters
+watch tasks
+tail -f logs
+show virtual disk tree
+consolidate delta disks

data/VERSION

@@ -1 +1 @@
-1.3.6
+1.4.0

data/bin/rvc

@@ -30,7 +30,6 @@ require 'backports'
 require 'rvc'
 
 VIM = RbVmomi::VIM
-include RVC::Util
 
 Thread.abort_on_exception = true
 
@@ -51,8 +50,6 @@ Usage:
 where [options] are:
 EOS
 
-  opt :insecure, "don't verify ssl certificate", :short => 'k', :default => (ENV['RBVMOMI_INSECURE'] == '1')
-  opt :really_insecure, "don't use ~/.rvc/known_hosts", :short => 'K', :default => (ENV['RBVMOMI_REALLY_INSECURE'] == '1')
   opt :path, "Initial directory", :short => :none, :default => ENV['RVC_PATH'], :type => :string
   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
@@ -60,13 +57,36 @@ end
 
 RVC.reload_modules false
 
-$shell = RVC::Shell.new
+session = if ENV['RVC_SESSION'] and not ENV['RVC_SESSION'].empty?
+  RVC::FilesystemSession.new ENV['RVC_SESSION']
+else
+  RVC::MemorySession.new
+end
+
+$shell = RVC::Shell.new session
+
+# Prompt for hostname if none given. Useful on win32.
+if $shell.session.connections.empty? and ARGV.empty?
+  ARGV << Readline.readline("Host to connect to (user@host): ")
+end
+
+$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}..."
+    CMD.vim.connect uri, {}
+  rescue RVC::Util::UserError
+    puts "Failed to connect to #{uri}: #{$!.message}"
+    exit 1
+  end
+end
 
 ARGV.each do |uri|
   begin
-    puts "Connecting to #{uri}..." if ARGV.size > 1
-    CMD.vim.connect uri, :insecure => $opts[:insecure], :really_insecure => $opts[:really_insecure]
-  rescue UserError
+    puts "Connecting to #{uri}..." if (ARGV+$shell.session.connections).size > 1
+    CMD.vim.connect uri, {}
+  rescue RVC::Util::UserError
     puts "Failed to connect to #{uri}: #{$!.message}"
     exit 1
   end
@@ -79,19 +99,19 @@ history = File.open(history_fn, 'a')
 
 if $opts[:path]
   begin
-    CMD.basic.cd lookup_single($opts[:path])
-  rescue UserError
+    CMD.basic.cd RVC::Util.lookup_single($opts[:path])
+  rescue RVC::Util::UserError
     raise unless $opts[:create_directory]
     parent_path = File.dirname($opts[:path])
-    lookup_single(parent_path).CreateFolder(:name => File.basename($opts[:path]))
-    CMD.basic.cd lookup_single($opts[:path])
+    RVC::Util.lookup_single(parent_path).CreateFolder(:name => File.basename($opts[:path]))
+    CMD.basic.cd RVC::Util.lookup_single($opts[:path])
   end
 elsif $shell.connections.size == 1
   conn_name, conn = $shell.connections.first
   if conn.serviceContent.about.apiType == 'VirtualCenter'
-    CMD.basic.cd lookup_single(conn_name)
+    CMD.basic.cd RVC::Util.lookup_single(conn_name)
   else
-    CMD.basic.cd lookup_single("#{conn_name}/ha-datacenter/vm")
+    CMD.basic.cd RVC::Util.lookup_single("#{conn_name}/ha-datacenter/vm")
   end
 end
 
@@ -109,7 +129,7 @@ if $shell.connections.empty?
   $stderr.puts "Use the 'connect' command to connect to an ESX or VC server."
 end
 
-CMD.basic.ls lookup_single('.')
+CMD.basic.ls RVC::Util.lookup_single('.')
 
 while true
   begin

data/lib/rvc/completion.rb

@@ -107,7 +107,7 @@ module Completion
   def self.mark_candidates word
     return [] unless word.empty? || word[0..0] == '~'
     prefix_regex = /^#{Regexp.escape(word[1..-1] || '')}/
-    $shell.fs.marks.keys.sort.grep(prefix_regex).map { |x| "~#{x}" }
+    $shell.session.marks.sort.grep(prefix_regex).map { |x| "~#{x}" }
   end
 end
 end

data/lib/rvc/extensions/VirtualMachine.rb

@@ -21,7 +21,7 @@
 class RbVmomi::VIM::VirtualMachine
   def display_info
     config, runtime, guest = collect :config, :runtime, :guest
-    err "Information currently unavailable" unless config and runtime and guest
+    RVC::Util.err "Information currently unavailable" unless config and runtime and guest
 
     puts "name: #{config.name}"
     puts "note: #{config.annotation}" if config.annotation and !config.annotation.empty?
@@ -68,6 +68,31 @@ class RbVmomi::VIM::VirtualMachine
     {
       'host' => host,
       'resourcePool' => resourcePool,
+      'datastores' => RVC::FakeFolder.new(self, :rvc_children_datastores),
+      'networks' => RVC::FakeFolder.new(self, :rvc_children_networks),
+      'files' => RVC::FakeFolder.new(self, :rvc_children_files),
     }
   end
+
+  def rvc_children_datastores
+    RVC::Util.collect_children self, :datastore
+  end
+
+  def rvc_children_networks
+    RVC::Util.collect_children self, :network
+  end
+
+  def rvc_children_files
+    files = layoutEx.file
+    datastore_map = RVC::Util.collect_children self, :datastore
+    Hash[files.map do |file|
+      file.name =~ /^\[(.+)\] (.+)$/ or fail "invalid datastore path"
+      ds = datastore_map[$1] or fail "datastore #{$1.inspect} not found"
+      arcs, = RVC::Path.parse $2
+      arcs.unshift 'files'
+      objs = $shell.fs.traverse ds, arcs
+      fail unless objs.size == 1
+      [File.basename(file.name), objs.first]
+    end]
+  end
 end

data/lib/rvc/filesystem_session.rb

@@ -0,0 +1,81 @@
+module RVC
+
+class FilesystemSession
+  def initialize name
+    fail "invalid session name" unless name =~ /^[\w-]+$/
+    @dir = File.join(ENV['HOME'], '.rvc', 'sessions', name)
+    prev_umask = File.umask 077
+    FileUtils.mkdir_p @dir
+    FileUtils.mkdir_p mark_dir
+    FileUtils.mkdir_p connection_dir
+    File.umask prev_umask
+    @priv = {}
+  end
+
+  def marks
+    Dir.entries(mark_dir).reject { |x| x == '.' || x == '..' } + @priv.keys
+  end
+
+  def get_mark key
+    if is_private_mark? key
+      @priv[key]
+    else
+      return nil unless File.exists? mark_fn(key)
+      File.readlines(mark_fn(key)).
+        map { |path| RVC::Util.lookup(path.chomp) }.
+        inject([], &:+)
+    end
+  end
+
+  def set_mark key, objs
+    if is_private_mark? key
+      if objs == nil
+        @priv.delete key
+      else
+        @priv[key] = objs
+      end
+    else
+      if objs == nil
+        File.unlink mark_fn(key)
+      else
+        File.open(mark_fn(key), 'w') do |io|
+          objs.each { |obj| io.puts obj.rvc_path_str }
+        end
+      end
+    end
+  end
+
+  def connections
+    Dir.entries(connection_dir).reject { |x| x == '.' || x == '..' }
+  end
+
+  def get_connection key
+    return nil unless File.exists? connection_fn(key)
+    File.open(connection_fn(key)) { |io| YAML.load io }
+  end
+
+  def set_connection key, conn
+    if conn == nil
+      File.unlink(connection_fn(key))
+    else
+      File.open(connection_fn(key), 'w') { |io| YAML.dump conn, io }
+    end
+  end
+
+  private
+
+  def is_private_mark? key
+    return key == '' ||
+           key == '~' ||
+           key == '@' ||
+           key =~ /^\d+$/
+  end
+
+  def mark_dir; File.join(@dir, 'marks') end
+  def mark_fn(key); File.join(mark_dir, key) end
+  def connection_dir; File.join(@dir, 'connections') end
+  def connection_fn(key); File.join(connection_dir, key) end
+end
+
+end
+

data/lib/rvc/fs.rb

@@ -21,7 +21,7 @@
 module RVC
 
 class FS
-  attr_reader :root, :cur, :marks
+  attr_reader :root, :cur
 
   MARK_PATTERN = /^~(?:([\d\w]*|~|@))$/
   REGEX_PATTERN = /^%/
@@ -31,7 +31,6 @@ class FS
     fail unless root.is_a? RVC::InventoryObject
     @root = root
     @cur = root
-    @marks = {}
   end
 
   def display_path
@@ -40,7 +39,7 @@ class FS
 
   def cd dst
     fail unless dst.is_a? RVC::InventoryObject
-    mark '~', [@cur]
+    $shell.session.set_mark '~', [@cur]
     @cur = dst
   end
 
@@ -71,7 +70,7 @@ class FS
       # XXX shouldnt be nil
       [(cur.respond_to?(:parent) && cur.parent) ? cur.parent : (cur.rvc_parent || cur)]
     when MARK_PATTERN
-      if first and objs = @marks[$1]
+      if first and objs = $shell.session.get_mark($1)
         objs
       else
         []
@@ -84,7 +83,7 @@ class FS
       cur.children.select { |k,v| k =~ regex }.map { |k,v| v.rvc_link(cur, k); v }
     else
       # XXX check for ambiguous child
-      if first and arc =~ /^\d+$/ and objs = @marks[arc]
+      if first and arc =~ /^\d+$/ and objs = $shell.session.get_mark(arc)
         objs
       else
         if child = cur.traverse_one(arc)
@@ -97,11 +96,6 @@ class FS
     end
   end
 
-  def mark key, objs
-    fail "not an array" unless objs.is_a? Array
-    @marks[key] = objs
-  end
-
 private
 
   def glob_to_regex str

data/lib/rvc/memory_session.rb

@@ -0,0 +1,39 @@
+module RVC
+
+class MemorySession
+  def initialize
+    @marks = {}
+    @connections = {}
+  end
+
+  def marks
+    @marks.keys
+  end
+
+  def get_mark key
+    @marks[key]
+  end
+
+  def set_mark key, objs
+    if objs == nil
+      @marks.delete key
+    else
+      fail "not an array" unless objs.is_a? Array
+      @marks[key] = objs
+    end
+  end
+
+  def connections
+    @connections.keys
+  end
+
+  def get_connection key
+    @connections[key]
+  end
+
+  def set_connection key, conn
+    @connections[key] = conn
+  end
+end
+
+end

data/lib/rvc/modules/basic.rb

@@ -132,9 +132,9 @@ rvc_alias :cd
 
 def cd obj
   $shell.fs.cd(obj)
-  $shell.fs.mark '', [find_ancestor(RbVmomi::VIM::Datacenter)].compact
-  $shell.fs.mark '@', [find_ancestor(RbVmomi::VIM)].compact
-  $shell.fs.marks.delete_if { |k,v| k =~ /^\d+$/ }
+  $shell.session.set_mark '', [find_ancestor(RbVmomi::VIM::Datacenter)].compact
+  $shell.session.set_mark '@', [find_ancestor(RbVmomi::VIM)].compact
+  $shell.delete_numeric_marks
 end
 
 def find_ancestor klass
@@ -159,7 +159,7 @@ def ls obj
   fake_children.each do |name,child|
     puts "#{i} #{name}#{child.ls_text(nil)}"
     child.rvc_link obj, name
-    $shell.fs.mark i.to_s, [child]
+    CMD.mark.mark i.to_s, [child]
     i += 1
   end
 
@@ -189,7 +189,7 @@ def ls obj
     realname = r['name'] if name != r['name']
     puts "#{i} #{name}#{realname && " [#{realname}]"}#{text}"
     r.obj.rvc_link obj, name
-    $shell.fs.mark i.to_s, [r.obj]
+    CMD.mark.mark i.to_s, [r.obj]
     i += 1
   end
 end
@@ -278,7 +278,9 @@ end
 rvc_alias :disconnect
 
 def disconnect connection
-  $shell.connections.delete_if { |k,v| v == connection }
+  k, = $shell.connections.find { |k,v| v == connection }
+  $shell.connections.delete k
+  $shell.session.set_connection k, nil
 end
 
 
@@ -294,3 +296,30 @@ def mkdir path
   parent = lookup_single! File.dirname(path), RbVmomi::VIM::Folder
   parent.CreateFolder(:name => File.basename(path))
 end
+
+
+opts :events do
+  summary "Show recent events"
+  arg :obj, nil, :required => false, :default => '.', :lookup => Object
+  opt :lines, "Output the last N events", :short => 'n', :type => :int, :default => 10
+end
+
+rvc_alias :events
+
+def events obj, opts
+  err "'events' not supported at this level" unless obj.respond_to?(:_connection)
+  manager = obj._connection.serviceContent.eventManager
+  @event_details ||= Hash[manager.collect("description.eventInfo").first.collect { |d| [d.key, d] }]
+
+  spec = VIM::EventFilterSpec(:entity => VIM::EventFilterSpecByEntity(:entity => obj, :recursion => "all"))
+
+  collector = manager.CreateCollectorForEvents(:filter => spec)
+  collector.SetCollectorPageSize(:maxCount => opts[:lines])
+  collector.latestPage.reverse.each do |event|
+    time = event.createdTime.localtime.strftime("%m/%d/%Y %I:%M %p")
+    category = @event_details[event.class.to_s].category
+    puts "[#{time}] [#{category}] #{event.fullFormattedMessage.strip}"
+  end
+ensure
+  collector.DestroyCollector if collector
+end

data/lib/rvc/modules/datastore.rb

@@ -20,30 +20,101 @@
 
 opts :download do
   summary "Download a file from a datastore"
-  arg 'datastore-path', "Filename on the datastore"
+  arg 'datastore-path', "Filename on the datastore", :lookup => VIM::Datastore::FakeDatastoreFile
   arg 'local-path', "Filename on the local machine"
 end
 
-def download datastore_path, local_path
-  file = lookup_single(datastore_path)
-  err "not a datastore file" unless file.is_a? RbVmomi::VIM::Datastore::FakeDatastoreFile
-  file.datastore.download file.path, local_path
+def download file, local_path
+  main_http = file.datastore._connection.http
+  http = Net::HTTP.new(main_http.address, main_http.port)
+  http.use_ssl = true
+  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  #http.set_debug_output $stderr
+  http.start
+  err "certificate mismatch" unless main_http.peer_cert.to_der == http.peer_cert.to_der
+
+  headers = { 'cookie' => file.datastore._connection.cookie }
+  path = http_path file.datastore.send(:datacenter).name, file.datastore.name, file.path
+  http.request_get(path, headers) do |res|
+    case res
+    when Net::HTTPOK
+      len = res.content_length
+      count = 0
+      File.open(local_path, 'wb') do |io|
+        res.read_body do |segment|
+          count += segment.length
+          io.write segment
+          $stdout.write "\e[0G\e[Kdownloading #{count}/#{len} bytes (#{(count*100)/len}%)"
+          $stdout.flush
+        end
+      end
+      $stdout.puts
+    else
+      err "download failed: #{res.message}"
+    end
+  end
 end
 
 
 opts :upload do
   summary "Upload a file to a datastore"
   arg 'local-path', "Filename on the local machine"
-  arg 'datastore-path', "Filename on the datastore"
+  arg 'datastore-path', "Filename on the datastore", :lookup_parent => VIM::Datastore::FakeDatastoreFolder
 end
 
-def upload local_path, datastore_path
-  datastore_dir_path = File.dirname datastore_path
-  dir = lookup_single(datastore_dir_path)
-  err "datastore directory does not exist" unless dir.is_a? RbVmomi::VIM::Datastore::FakeDatastoreFolder
+def upload local_path, dest
+  dir, datastore_filename = *dest
   err "local file does not exist" unless File.exists? local_path
-  real_datastore_path = "#{dir.path}/#{File.basename(datastore_path)}"
-  dir.datastore.upload real_datastore_path, local_path
+  real_datastore_path = "#{dir.path}/#{datastore_filename}"
+
+  main_http = dir.datastore._connection.http
+  http = Net::HTTP.new(main_http.address, main_http.port)
+  http.use_ssl = true
+  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  #http.set_debug_output $stderr
+  http.start
+  err "certificate mismatch" unless main_http.peer_cert.to_der == http.peer_cert.to_der
+
+  File.open(local_path, 'rb') do |io|
+    stream = ProgressStream.new(io, io.stat.size) do |s|
+      $stdout.write "\e[0G\e[Kuploading #{s.count}/#{s.len} bytes (#{(s.count*100)/s.len}%)"
+      $stdout.flush
+    end
+
+    headers = {
+      'cookie' => dir.datastore._connection.cookie,
+      'content-length' => io.stat.size.to_s,
+      'Content-Type' => 'application/octet-stream',
+    }
+    path = http_path dir.datastore.send(:datacenter).name, dir.datastore.name, real_datastore_path
+    request = Net::HTTP::Put.new path, headers
+    request.body_stream = stream
+    res = http.request(request)
+    $stdout.puts
+    case res
+    when Net::HTTPOK
+    else
+      err "upload failed: #{res.message}"
+    end
+  end
+end
+
+class ProgressStream
+  attr_reader :io, :len, :count
+
+  def initialize io, len, &b
+    @io = io
+    @len = len
+    @count = 0
+    @cb = b
+  end
+
+  def read n
+    io.read(n).tap do |c|
+      @count += c.length if c
+      @cb[self]
+    end
+  end
 end
 
 
@@ -75,15 +146,20 @@ rvc_alias :edit, :vi
 def edit file
   editor = ENV['VISUAL'] || ENV['EDITOR'] || 'vi'
   filename = File.join(Dir.tmpdir, "rvc.#{Time.now.to_i}.#{rand(65536)}")
-  file.datastore.download(file.path, filename) rescue err("download failed")
+  download file, filename
   begin
     pre_stat = File.stat filename
     system("#{editor} #{filename}")
     post_stat = File.stat filename
     if pre_stat != post_stat
-      file.datastore.upload(file.path, filename) rescue err("upload failed")
+      upload filename, [file.parent, File.basename(file.path)]
     end
   ensure
     File.unlink filename
   end
 end
+
+
+def http_path dc_name, ds_name, path
+  "/folder/#{URI.escape path}?dcPath=#{URI.escape dc_name}&dsName=#{URI.escape ds_name}"
+end

data/lib/rvc/modules/host.rb

@@ -119,3 +119,24 @@ def reconnect hosts, opts
   }
   tasks hosts, :ReconnectHost
 end
+
+
+opts :add_iscsi_target do
+  arg :host, nil, :lookup => VIM::HostSystem, :multi => true
+  opt :address, "Address of iSCSI server", :short => 'a', :type => :string, :required => true
+  opt :iqn, "IQN of iSCSI target", :short => 'i', :type => :string, :required => true
+end
+
+def add_iscsi_target hosts, opts
+  hosts.each do |host|
+    puts "configuring host #{host.name}"
+    storage = host.configManager.storageSystem
+    storage.UpdateSoftwareInternetScsiEnabled(enabled: true)
+    adapter = storage.storageDeviceInfo.hostBusAdapter.grep(VIM::HostInternetScsiHba)[0]
+    storage.AddInternetScsiStaticTargets(
+      iScsiHbaDevice: adapter.device,
+      targets: [ VIM::HostInternetScsiHbaStaticTarget(address: opts[:address], iScsiName: opts[:iqn]) ]
+    )
+    storage.RescanAllHba
+  end
+end

data/lib/rvc/modules/mark.rb

@@ -29,7 +29,7 @@ rvc_alias :mark, :m
 
 def mark key, objs
   err "invalid mark name" unless key =~ /^\w+$/
-  $shell.fs.mark key, objs
+  $shell.session.set_mark key, objs
 end
 
 
@@ -42,7 +42,7 @@ rvc_alias :edit, :me
 
 def edit key
   editor = ENV['VISUAL'] || ENV['EDITOR'] || 'vi'
-  objs = $shell.fs.marks[key] or err "no such mark #{key.inspect}"
+  objs = $shell.session.get_mark(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
@@ -54,3 +54,12 @@ def edit key
     File.unlink filename
   end
 end
+
+
+opts :list do
+  summary "List marks"
+end
+
+def list
+  $shell.session.marks.each { |x| puts x }
+end