rvc 1.6.0 → 1.7.0

data/lib/rvc/modules/vim.rb

@@ -19,41 +19,9 @@
 # THE SOFTWARE.
 
 require 'rvc/known_hosts'
+require 'rvc/vim'
 
-URI_REGEX = %r{
-  ^
-  (?:
-    ([^@:]+)
-    (?::
-     ([^@]*)
-    )?
-    @
-  )?
-  ([^@:]+)
-  (?::(\d{1,5}))?
-  (?::([0-9a-z]{64}))?
-  $
-}x
-
-class RbVmomi::VIM
-  include RVC::InventoryObject
-
-  def children
-    rootFolder.children
-  end
-
-  def self.folder?
-    true
-  end
-
-  def display_info
-    puts serviceContent.about.fullName
-  end
-
-  def _connection
-    self
-  end
-end
+RVC::SCHEMES['vim'] = lambda { |uri| connect uri, {} }
 
 opts :connect do
   summary 'Open a connection to ESX/VC'
@@ -64,14 +32,13 @@ end
 rvc_alias :connect
 
 def connect uri, opts
-  match = URI_REGEX.match uri
-  Trollop.die "invalid hostname" unless match
-
-  username = match[1] || ENV['RBVMOMI_USER']
-  password = match[2] || ENV['RBVMOMI_PASSWORD']
-  host = match[3]
-  port = match[4] || 443
-  certdigest = match[5] || opts[:certdigest]
+  uri = RVC::URIParser.parse uri unless uri.is_a? URI
+
+  username = uri.user || ENV['RBVMOMI_USER']
+  password = uri.password || ENV['RBVMOMI_PASSWORD']
+  host = uri.host
+  port = uri.port || 443
+  certdigest = opts[:certdigest] # TODO put in URI
   bad_cert = false
 
   vim = nil
@@ -114,7 +81,7 @@ def connect uri, opts
     if env_rev && env_rev.to_f == 0
       vim.rev = env_rev
     else
-      vim.rev = [rev, env_rev || '5.0'].min
+      vim.rev = [rev, env_rev || '5.1'].min
     end
   end
 
@@ -170,14 +137,10 @@ def connect uri, opts
   vim.define_singleton_method(:_host) { host }
 
   conn_name = host.dup
-  conn_name = "#{conn_name}:1" if $shell.connections.member? conn_name
-  conn_name.succ! while $shell.connections.member? conn_name
-
-  $shell.connections[conn_name] = vim
-  $shell.session.set_connection conn_name,
-    'host' => host,
-    'username' => username,
-    'rev' => opts[:rev]
+  conn_name = "#{conn_name}:1" if shell.connections.member? conn_name
+  conn_name.succ! while shell.connections.member? conn_name
+
+  shell.connections[conn_name] = vim
 end
 
 def prompt_password
@@ -242,7 +205,7 @@ opts :tasks do
 end
 
 def tasks
-  conn = single_connection [$shell.fs.cur]
+  conn = single_connection [shell.fs.cur]
 
   begin
     view = conn.serviceContent.viewManager.CreateListView
@@ -319,7 +282,10 @@ def logbundles servers, opts
   puts "#{Time.now}: Generating log bundles..."
   bundles =
     begin
-      diagMgr.GenerateLogBundles_Task(:includeDefault => include_default, :host => hosts).wait_for_completion
+      diagMgr.GenerateLogBundles_Task(
+        :includeDefault => include_default, 
+        :host => hosts
+      ).wait_for_completion
     rescue VIM::TaskInProgress
       $!.task.wait_for_completion
     end

data/lib/rvc/modules/vm.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::Datastore
+
 opts :on do
   summary "Power on VMs"
   arg :vm, nil, :multi => true, :lookup => VIM::VirtualMachine
@@ -85,9 +88,10 @@ def wait_for_shutdown vms, opts
       end
     end
     return if all_off
-    sleep [opts[:delay], finish_time - Time.now].min
+    sleep_time = [opts[:delay], finish_time - Time.now].min
+    sleep sleep_time if sleep_time > 0
   end
-  puts "WARNING: At least one VM did not shut down!"
+  err "At least one VM did not shut down!"
 end
 
 
@@ -272,7 +276,7 @@ rvc_alias :kill, :k
 def kill vms
   on_vms = vms.select { |x| x.summary.runtime.powerState == 'poweredOn' }
   off on_vms unless on_vms.empty?
-  CMD.basic.destroy vms unless vms.empty?
+  shell.cmds.basic.destroy vms unless vms.empty?
 end
 
 opts :answer do
@@ -285,9 +289,13 @@ def answer str, vms
   vms.each do |vm|
     begin
       if q = vm.runtime.question
-        choice = q.choice.choiceInfo.find { |x| x.label == str }
-        err("invalid answer") unless choice
-        vm.AnswerVM :questionId => q.id, :answerChoice => choice.key
+        choices = q.choice.choiceInfo
+        choice = choices.find { |x| x.label == str }
+        if !choice
+          puts "#{vm.name}: #{choice} invalid, choices: #{choices.map{ |x| x.label }}"
+        else
+          vm.AnswerVM :questionId => q.id, :answerChoice => choice.key
+        end
       end
     rescue
       puts "#{vm.name rescue vm}: #{$!.message}"
@@ -628,3 +636,16 @@ def vm_ip vm
     err "no IP known for this VM"
   end
 end
+
+
+opts :screenshot do
+  summary "Take a screenshot of a VM"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  arg 'local-path', "Filename on the local machine"
+end
+
+rvc_alias :screenshot
+
+def screenshot vm, local_path
+  http_download vm._connection, "/screen?id=#{vm._ref}", local_path
+end

data/lib/rvc/modules/vm_guest.rb

@@ -0,0 +1,490 @@
+opts :authenticate do
+  summary "Authenticate within guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :interactive_session, "Allow command to interact with desktop", :default => false, :type => :bool
+  opt :password, "Password in guest", :type => :string
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def authenticate vm, opts
+  auth = ((@auths ||= {})[vm] ||= {})[opts[:username]]
+
+  if opts[:password].nil? or opts[:password].empty?
+    opts[:password] = ask("password: ") { |q| q.echo = false }
+  end
+
+  auth = VIM.NamePasswordAuthentication(
+    :username => opts[:username],
+    :password => opts[:password],
+    :interactiveSession => opts[:interactive_session]
+  )
+
+  @auths[vm][opts[:username]] = auth
+  begin
+    check_auth vm, opts
+  rescue
+    clear_auth vm, opts
+    err "Could not authenticate: #{$!}"
+  end
+end
+
+
+opts :check_auth do
+  summary "Check credentials"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def check_auth vm, opts
+  auth = get_auth vm, opts
+
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :authManager
+  guestOperationsManager.authManager.ValidateCredentialsInGuest(
+    :vm => vm,
+    :auth => auth
+  )
+end
+
+
+opts :list_auth do
+  summary "List available credentials"
+  arg :vm, nil, :lookup => VIM::VirtualMachine, :required => false
+end
+
+def list_auth vm
+  if @auths.nil?
+    puts "No credentials available."
+    return
+  end
+
+  if vm.nil?
+    auth_list = @auths
+  elsif !@auths.member? vm
+    puts "No credentials available."
+    return
+  else
+    auth_list = { vm => @auths[vm] }
+  end
+
+  auth_list.each_key do |vmkey|
+    puts vmkey.rvc_path_str
+    auth_list[vmkey].each_key do |userkey|
+      puts "  #{userkey}"
+    end
+  end
+end
+
+
+opts :clear_auth do
+  summary "Clear credentials"
+  arg :vm, nil, :lookup => VIM::VirtualMachine, :required => false
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def clear_auth vm, opts
+  unless @auths.nil? or vm.nil?
+    if @auths.member? vm
+      @auths[vm].delete opts[:username]
+      @auths.delete vm if @auths[vm].empty?
+      @auths = nil if @auths.empty?
+    end
+  end
+end
+
+
+def get_auth vm, opts
+  auth = @auths.fetch(vm).fetch(opts[:username])
+ensure
+  err "No credentials found. You must authenticate before executing this command." if auth.nil?
+end
+
+
+# File commands
+opts :chmod do
+  summary "Change file attributes"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :group_id, "Group ID of file", :type => :int
+  opt :guest_path, "Path in guest to change ownership of", :required => true, :type => :string
+  opt :owner_id, "Owner ID of file", :type => :int
+  opt :permissions, "Permissions of file", :type => :string
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def chmod vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  opts[:permissions] = opts[:permissions].to_i(8) if opts[:permissions]
+
+  auth = get_auth vm, opts
+
+  fileManager.
+    ChangeFileAttributesInGuest(
+      :vm => vm,
+      :auth => auth,
+      :guestFilePath => opts[:guest_path],
+      :fileAttributes => VIM.GuestPosixFileAttributes(
+        :groupId => opts[:group_id],
+        :ownerId => opts[:owner_id],
+        :permissions => opts[:permissions]
+      )
+    )
+end
+
+
+opts :mktmpdir do
+  summary "Create temporary directory in guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :guest_path, "Path in guest to create temporary directory in", :type => :string
+  opt :prefix, "Prefix of temporary directory", :required => true, :type => :string
+  opt :suffix, "Suffix of temporary directory", :required => true, :type => :string
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def mktmpdir vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  auth = get_auth vm, opts
+
+  dirname = fileManager.
+    CreateTemporaryDirectoryInGuest(
+      :vm => vm,
+      :auth => auth,
+      :prefix => opts[:prefix],
+      :suffix => opts[:suffix],
+      :directoryPath => opts[:guest_path]
+    )
+  puts dirname
+  return dirname
+end
+
+
+opts :mktmpfile do
+  summary "Create temporary file in guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :guest_path, "Path in guest to create temporary file in", :type => :string
+  opt :prefix, "Prefix of temporary directory", :required => true, :type => :string
+  opt :suffix, "Suffix of temporary directory", :required => true, :type => :string
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def mktmpfile vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  auth = get_auth vm, opts
+
+  filename = fileManager.
+    CreateTemporaryFileInGuest(
+      :vm => vm,
+      :auth => auth,
+      :prefix => opts[:prefix],
+      :suffix => opts[:suffix],
+      :directoryPath => opts[:guest_path]
+    )
+  puts filename
+  return filename
+end
+
+
+opts :rmdir do
+  summary "Delete directory in guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :guest_path, "Path of directory in guest to delete", :required => true, :type => :string
+  opt :recursive, "Delete all subdirectories", :default => false, :type => :bool
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def rmdir vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  auth = get_auth vm, opts
+
+  fileManager.
+    DeleteDirectoryInGuest(
+      :vm => vm,
+      :auth => auth,
+      :directoryPath => opts[:guest_path],
+      :recursive => opts[:recursive]
+    )
+end
+
+
+opts :rmfile do
+  summary "Delete file in guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :guest_path, "Path of file in guest to delete", :required => true, :type => :string
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def rmfile vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  auth = get_auth vm, opts
+
+  fileManager.
+    DeleteFileInGuest(
+      :vm => vm,
+      :auth => auth,
+      :filePath => opts[:guest_path]
+    )
+end
+
+
+opts :download_file do
+  summary "Download file from guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :guest_path, "Path in guest to download from", :required => true, :type => :string
+  opt :local_path, "Local file to download to", :required => true, :type => :string
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def download_file vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  auth = get_auth vm, opts
+
+  download_url = fileManager.
+    InitiateFileTransferFromGuest(
+      :vm => vm,
+      :auth => auth,
+      :guestFilePath => opts[:guest_path]
+    ).url
+
+  download_uri = URI.parse(download_url.gsub /http(s?):\/\/\*:[0-9]*/, "")
+  download_path = "#{download_uri.path}?#{download_uri.query}"
+
+  http_download vm._connection, download_path, opts[:local_path]
+end
+
+
+opts :upload_file do
+  summary "Upload file to guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :group_id, "Group ID of file", :type => :int
+  opt :guest_path, "Path in guest to upload to", :required => true, :type => :string
+  opt :local_path, "Local file to upload", :required => true, :type => :string
+  opt :overwrite, "Overwrite file", :default => false, :type => :bool
+  opt :owner_id, "Owner ID of file", :type => :int
+  opt :permissions, "Permissions of file", :type => :string
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def upload_file vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  opts[:permissions] = opts[:permissions].to_i(8) if opts[:permissions]
+
+  auth = get_auth vm, opts
+
+  file = File.new(opts[:local_path], 'rb')
+
+  upload_url = fileManager.
+    InitiateFileTransferToGuest(
+      :vm => vm,
+      :auth => auth,
+      :guestFilePath => opts[:guest_path],
+      :fileAttributes => VIM.GuestPosixFileAttributes(
+        :groupId => opts[:group_id],
+        :ownerId => opts[:owner_id],
+        :permissions => opts[:permissions]
+      ),
+      :fileSize => file.size,
+      :overwrite => opts[:overwrite]
+    )
+
+  upload_uri = URI.parse(upload_url.gsub /http(s?):\/\/\*:[0-9]*/, "")
+  upload_path = "#{upload_uri.path}?#{upload_uri.query}"
+
+  http_upload vm._connection, opts[:local_path], upload_path
+end
+
+
+opts :ls_guest do
+  summary "List files in guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :guest_path, "Path in guest to get directory listing", :required => true, :type => :string
+  opt :index, "Which to start the list with", :type => :int, :default => nil
+  opt :match_pattern, "Filename filter (regular expression)", :type => :string
+  opt :max_results, "Maximum number of results", :type => :int, :default => nil
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def ls_guest vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  auth = get_auth vm, opts
+
+  files = fileManager.
+    ListFilesInGuest(
+      :vm => vm,
+      :auth => auth,
+      :filePath => opts[:guest_path],
+      :index => opts[:index],
+      :maxResults => opts[:max_results],
+      :matchPattern => opts[:match_pattern]
+    )
+
+  files.files.each do |file|
+    puts file.path
+  end
+
+  puts "Remaining: #{files.remaining}" unless files.remaining.zero?
+
+  return files
+end
+
+
+opts :mkdir do
+  summary "Make directory in guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :guest_path, "Path of directory in guest to create", :required => true, :type => :string
+  opt :create_parent_directories, "Create parent directories", :default => false, :type => :bool
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def mkdir vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  auth = get_auth vm, opts
+
+  fileManager.
+    MakeDirectoryInGuest(
+      :vm => vm,
+      :auth => auth,
+      :directoryPath => opts[:guest_path],
+      :createParentDirectories => opts[:create_parent_directories]
+    )
+end
+
+
+opts :mvdir do
+  summary "Move directory in guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :src_guest_path, "Path in guest to move from", :required => true, :type => :string
+  opt :dst_guest_path, "Path in guest to move to", :required => true, :type => :string
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def mvdir vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  auth = get_auth vm, opts
+
+  fileManager.
+    MoveDirectoryInGuest(
+      :vm => vm,
+      :auth => auth,
+      :srcDirectoryPath => opts[:src_guest_path],
+      :dstDirectoryPath => opts[:dst_guest_path]
+    )
+end
+
+
+opts :mvfile do
+  summary "Move file in guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :dst_guest_path, "Path in guest to move to", :required => true, :type => :string
+  opt :overwrite, "Overwrite file", :default => true, :type => :bool
+  opt :src_guest_path, "Path in guest to move from", :required => true, :type => :string
+  opt :username, "Username in guest", :default => "root", :type => :string
+end
+
+def mvfile vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :fileManager
+  fileManager = guestOperationsManager.fileManager
+
+  auth = get_auth vm, opts
+
+  fileManager.
+    MoveFileInGuest(
+      :vm => vm,
+      :auth => auth,
+      :srcFilePath => opts[:src_guest_path],
+      :dstFilePath => opts[:dst_guest_path],
+      :overwrite => opts[:overwrite]
+    )
+end
+
+
+# Process commands
+opts :start_program do
+  summary "Run program in guest"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+  opt :arguments, "Arguments of command", :default => "", :type => :string
+  opt :background, "Don't wait for process to finish", :default => false, :type => :bool
+  opt :delay, "Interval in seconds", :type => :float, :default => 5.0
+  opt :env, "Environment variable(s) to set (e.g. VAR=value)", :multi => true, :type => :string
+  opt :program_path, "Path to program in guest", :required => true, :type => :string
+  opt :timeout, "Timeout in seconds", :type => :int, :default => nil
+  opt :username, "Username in guest", :default => "root", :type => :string
+  opt :working_directory, "Working directory of the program to run", :type => :string
+  conflicts :background, :timeout
+  conflicts :background, :delay
+end
+
+def start_program vm, opts
+  guestOperationsManager = vm._connection.serviceContent.guestOperationsManager
+  err "This command requires vSphere 5 or greater" unless guestOperationsManager.respond_to? :processManager
+  processManager = guestOperationsManager.processManager
+
+  auth = get_auth vm, opts
+
+  pid = processManager.
+    StartProgramInGuest(
+      :vm => vm,
+      :auth => auth,
+      :spec => VIM.GuestProgramSpec(
+        :arguments => opts[:arguments],
+        :programPath => opts[:program_path],
+        :envVariables => opts[:env],
+        :workingDirectory => opts[:working_directory]
+      )
+    )
+
+  Timeout.timeout opts[:timeout] do
+    while true
+      processes = processManager.
+        ListProcessesInGuest(
+          :vm => vm,
+          :auth => auth,
+          :pids => [pid]
+        )
+      process = processes.first
+
+      if !process.endTime.nil?
+        if process.exitCode != 0
+          err "Process failed with exit code #{process.exitCode}"
+        end
+        break
+      elsif opts[:background]
+        break
+      end
+
+      sleep opts[:delay]
+    end
+  end
+rescue Timeout::Error
+  err "Timed out waiting for process to finish."
+end