knife-vsphere 1.0.1 → 1.2.0

data/lib/chef/knife/vsphere_vm_query.rb

@@ -1,48 +1,48 @@
-# Author:: Brian Dupras (<bdupras@rallydev.com>)
-# License:: Apache License, Version 2.0
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-require 'netaddr'
-
-class Chef::Knife::VsphereVmQuery < Chef::Knife::BaseVsphereCommand
-  banner "knife vsphere vm query VMNAME QUERY.  See \"http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.VirtualMachine.html\" for allowed QUERY values."
-
-  get_common_options
-
-  def run
-    $stdout.sync = true
-    vmname = @name_args[0]
-    if vmname.nil?
-      show_usage
-      fatal_exit("You must specify a virtual machine name")
-    end
-
-    query_string = @name_args[1]
-    if query_string.nil?
-      show_usage
-      fatal_exit("You must specify a QUERY value (e.g. guest.ipAddress or network[0].name)")
-    end
-
-    vim = get_vim_connection
-
-    dc = get_datacenter
-    folder = find_folder(get_config(:folder)) || dc.vmFolder
-
-    vm = traverse_folders_for_vm(folder, vmname) or abort "VM #{vmname} not found"
-
-    # split QUERY by dots, and walk the object model
-    query = query_string.split '.'
-    result = vm
-    query.each do |part|
-      message, index = part.split(/[\[\]]/)
-      unless result.respond_to? message.to_sym
-        fatal_exit("\"#{query_string}\" not recognized.")
-      end
-
-      result = index ? result.send(message)[index.to_i] : result.send(message)
-    end
-    puts result
-  end
-end
+# Author:: Brian Dupras (<bdupras@rallydev.com>)
+# License:: Apache License, Version 2.0
+
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+require 'rbvmomi'
+require 'netaddr'
+
+class Chef::Knife::VsphereVmQuery < Chef::Knife::BaseVsphereCommand
+  banner "knife vsphere vm query VMNAME QUERY.  See \"http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.VirtualMachine.html\" for allowed QUERY values."
+
+  common_options
+
+  def run
+    $stdout.sync = true
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      fatal_exit('You must specify a virtual machine name')
+    end
+
+    query_string = @name_args[1]
+    if query_string.nil?
+      show_usage
+      fatal_exit('You must specify a QUERY value (e.g. guest.ipAddress or network[0].name)')
+    end
+
+    vim_connection
+
+    dc = datacenter
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = traverse_folders_for_vm(folder, vmname) || abort("VM #{vmname} not found")
+
+    # split QUERY by dots, and walk the object model
+    query = query_string.split '.'
+    result = vm
+    query.each do |part|
+      message, index = part.split(/[\[\]]/)
+      unless result.respond_to? message.to_sym
+        fatal_exit("\"#{query_string}\" not recognized.")
+      end
+
+      result = index ? result.send(message)[index.to_i] : result.send(message)
+    end
+    puts result
+  end
+end

data/lib/chef/knife/vsphere_vm_snapshot.rb

@@ -1,130 +1,124 @@
-#
-# License:: Apache License, Version 2.0
-#
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-require 'netaddr'
-
-
-# Manage snapshots of a virtual machine
-class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
-
-  banner "knife vsphere vm snapshot VMNAME (options)"
-
-  get_common_options
-
-  option :list,
-         :long => "--list",
-         :description => "The current tree of snapshots"
-
-  option :create_new_snapshot,
-         :long => "--create SNAPSHOT",
-         :description => "Create a new snapshot off of the current snapshot."
-
-  option :remove_named_snapshot,
-         :long => "--remove SNAPSHOT",
-         :description => "Remove a named snapshot."
-
-  option :revert_snapshot,
-         :long => "--revert SNAPSHOT",
-         :description => "Revert to a named snapshot."
-
-  option :revert_current_snapshot,
-         :long => "--revert-current",
-         :description => "Revert to current snapshot.",
-         :boolean => false
-
-  option :power,
-         :long => "--start",
-         :description => "Indicates whether to start the VM after a successful revert",
-         :boolean => false
-
-  def run
-
-    $stdout.sync = true
-
-    vmname = @name_args[0]
-    if vmname.nil?
-      show_usage
-      ui.fatal("You must specify a virtual machine name")
-      exit 1
-    end
-
-    vim = get_vim_connection
-
-    baseFolder = find_folder(get_config(:folder));
-
-    vm = find_in_folder(baseFolder, RbVmomi::VIM::VirtualMachine, vmname) or
-        abort "VM #{vmname} not found"
-
-    if vm.snapshot
-      snapshot_list = vm.snapshot.rootSnapshotList
-      current_snapshot = vm.snapshot.currentSnapshot
-    end
-
-    if config[:list] && vm.snapshot
-      puts "Current snapshot tree: "
-      puts "#{vmname}"
-      snapshot_list.each { |i| puts display_node(i, current_snapshot) }
-    end
-
-    if config[:create_new_snapshot]
-      vm.CreateSnapshot_Task(:name => config[:create_new_snapshot], :description => "", :memory => false, :quiesce => false)
-    end
-
-    if config[:remove_named_snapshot]
-      ss_name = config[:remove_named_snapshot]
-      snapshot = find_node(snapshot_list, ss_name)
-      puts "Found snapshot #{ss_name} removing."
-      snapshot.RemoveSnapshot_Task(:removeChildren => false)
-    end
-
-    if config[:revert_current_snapshot]
-      puts "Reverting to Current Snapshot"
-      vm.RevertToCurrentSnapshot_Task(:suppressPowerOn => false).wait_for_completion
-      if get_config(:power)
-        vm.PowerOnVM_Task.wait_for_completion
-        puts "Powered on virtual machine #{vmname}"
-      end
-    end
-
-    if config[:revert_snapshot]
-      ss_name = config[:revert_snapshot]
-      snapshot = find_node(snapshot_list, ss_name)
-      snapshot.RevertToSnapshot_Task(:suppressPowerOn => false).wait_for_completion
-      if get_config(:power)
-        vm.PowerOnVM_Task.wait_for_completion
-        puts "Powered on virtual machine #{vmname}"
-      end
-    end
-  end
-
-  def find_node(tree, name)
-    snapshot = nil
-    tree.each do |node|
-      if node.name == name
-        snapshot = node.snapshot
-        break
-      elsif !node.childSnapshotList.empty?
-        snapshot = find_node(node.childSnapshotList, name)
-      end
-    end
-    return snapshot
-  end
-
-  def display_node(node, current, shift=1)
-    out = ""
-    out << "+--"*shift
-    if node.snapshot == current
-      out << "#{ui.color(node.name, :cyan)}" << "\n"
-    else
-      out << "#{node.name}" << "\n"
-    end
-    if !node.childSnapshotList.empty?
-      node.childSnapshotList.each { |item| out << display_node(item, current, shift+1) }
-    end
-    out
-  end
-end
+#
+# License:: Apache License, Version 2.0
+#
+
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+require 'rbvmomi'
+require 'netaddr'
+
+# Manage snapshots of a virtual machine
+class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm snapshot VMNAME (options)'
+
+  common_options
+
+  option :list,
+         long: '--list',
+         description: 'The current tree of snapshots'
+
+  option :create_new_snapshot,
+         long: '--create SNAPSHOT',
+         description: 'Create a new snapshot off of the current snapshot.'
+
+  option :remove_named_snapshot,
+         long: '--remove SNAPSHOT',
+         description: 'Remove a named snapshot.'
+
+  option :revert_snapshot,
+         long: '--revert SNAPSHOT',
+         description: 'Revert to a named snapshot.'
+
+  option :revert_current_snapshot,
+         long: '--revert-current',
+         description: 'Revert to current snapshot.',
+         boolean: false
+
+  option :power,
+         long: '--start',
+         description: 'Indicates whether to start the VM after a successful revert',
+         boolean: false
+
+  def run
+    $stdout.sync = true
+
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      ui.fatal('You must specify a virtual machine name')
+      exit 1
+    end
+
+    vim_connection
+
+    base_folder = find_folder(get_config(:folder))
+
+    vm = find_in_folder(base_folder, RbVmomi::VIM::VirtualMachine, vmname) || abort("VM #{vmname} not found")
+
+    if vm.snapshot
+      snapshot_list = vm.snapshot.rootSnapshotList
+      current_snapshot = vm.snapshot.currentSnapshot
+    end
+
+    if config[:list] && vm.snapshot
+      puts 'Current snapshot tree: '
+      puts "#{vmname}"
+      snapshot_list.each { |i| puts display_node(i, current_snapshot) }
+    end
+
+    if config[:create_new_snapshot]
+      vm.CreateSnapshot_Task(name: config[:create_new_snapshot], description: '', memory: false, quiesce: false)
+    end
+
+    if config[:remove_named_snapshot]
+      ss_name = config[:remove_named_snapshot]
+      snapshot = find_node(snapshot_list, ss_name)
+      puts "Found snapshot #{ss_name} removing."
+      snapshot.RemoveSnapshot_Task(removeChildren: false)
+    end
+
+    if config[:revert_current_snapshot]
+      puts 'Reverting to Current Snapshot'
+      vm.RevertToCurrentSnapshot_Task(suppressPowerOn: false).wait_for_completion
+      if get_config(:power)
+        vm.PowerOnVM_Task.wait_for_completion
+        puts "Powered on virtual machine #{vmname}"
+      end
+    end
+
+    return unless config[:revert_snapshot]
+    ss_name = config[:revert_snapshot]
+    snapshot = find_node(snapshot_list, ss_name)
+    snapshot.RevertToSnapshot_Task(suppressPowerOn: false).wait_for_completion
+    return unless get_config(:power)
+    vm.PowerOnVM_Task.wait_for_completion
+    puts "Powered on virtual machine #{vmname}"
+  end
+
+  def find_node(tree, name)
+    snapshot = nil
+    tree.each do |node|
+      if node.name == name
+        snapshot = node.snapshot
+        break
+      elsif !node.childSnapshotList.empty?
+        snapshot = find_node(node.childSnapshotList, name)
+      end
+    end
+    snapshot
+  end
+
+  def display_node(node, current, shift = 1)
+    out = ''
+    out << '+--' * shift
+    if node.snapshot == current
+      out << "#{ui.color(node.name, :cyan)}" << "\n"
+    else
+      out << "#{node.name}" << "\n"
+    end
+    unless node.childSnapshotList.empty?
+      node.childSnapshotList.each { |item| out << display_node(item, current, shift + 1) }
+    end
+    out
+  end
+end

data/lib/chef/knife/vsphere_vm_state.rb

@@ -1,127 +1,122 @@
-#
-# Author:: Ezra Pagel (<ezra@cpan.org>)
-# License:: Apache License, Version 2.0
-#
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-require 'netaddr'
-
-PsOn = 'poweredOn'
-PsOff = 'poweredOff'
-PsSuspended = 'suspended'
-
-PowerStates = {
-    PsOn => 'powered on',
-    PsOff => 'powered off',
-    PsSuspended => 'suspended'
-}
-
-# Manage power state of a virtual machine
-class Chef::Knife::VsphereVmState < Chef::Knife::BaseVsphereCommand
-
-  banner "knife vsphere vm state VMNAME (options)"
-
-  get_common_options
-
-  option :state,
-         :short => "-s STATE",
-         :long => "--state STATE",
-         :description => "The power state to transition the VM into; one of on|off|suspended"
-
-  option :wait_port,
-         :short => "-w PORT",
-         :long => "--wait-port PORT",
-         :description => "Wait for VM to be accessible on a port"
-
-  option :shutdown,
-         :short => "-g",
-         :long => "--shutdown",
-         :description => "Guest OS shutdown"
-
-  option :recursive,
-         :short => "-r",
-         :long => "--recursive",
-         :description => "Search all folders"
-
-  def run
-
-    $stdout.sync = true
-
-    vmname = @name_args[0]
-    if vmname.nil?
-      show_usage
-      ui.fatal("You must specify a virtual machine name")
-      exit 1
-    end
-
-    vim = get_vim_connection
-
-	if get_config(:recursive)
-	  vms = get_vms(vmname)
-      if vms.length > 1
-	    abort "More than one VM with name #{vmname} found:\n" + vms.map{ |vm| get_path_to_object(vm) }.join("\n")
-	  end
-	  if vms.length == 0
-	    abort "VM #{vmname} not found"
-	  end
-	  vm = vms[0]
-	else
-      baseFolder = find_folder(get_config(:folder));
-
-      vm = find_in_folder(baseFolder, RbVmomi::VIM::VirtualMachine, vmname) or
-        abort "VM #{vmname} not found"
-	end
-
-    state = vm.runtime.powerState
-
-    if config[:state].nil?
-      puts "VM #{vmname} is currently " + PowerStates[vm.runtime.powerState]
-    else
-
-      case config[:state]
-        when 'on'
-          if state == PsOn
-            puts "Virtual machine #{vmname} was already powered on"
-          else
-            vm.PowerOnVM_Task.wait_for_completion
-            puts "Powered on virtual machine #{vmname}"
-          end
-        when 'off'
-          if state == PsOff
-            puts "Virtual machine #{vmname} was already powered off"
-          else
-            if get_config(:shutdown)
-              vm.ShutdownGuest
-              print "Waiting for virtual machine #{vmname} to shut down..."
-              until vm.runtime.powerState == PsOff do
-                sleep 2
-                print "."
-              end
-              puts "done"
-            else
-              vm.PowerOffVM_Task.wait_for_completion
-              puts "Powered off virtual machine #{vmname}"
-            end
-          end
-        when 'suspend'
-          if state == PowerStates['suspended']
-            puts "Virtual machine #{vmname} was already suspended"
-          else
-            vm.SuspendVM_Task.wait_for_completion
-            puts "Suspended virtual machine #{vmname}"
-          end
-        when 'reset'
-          vm.ResetVM_Task.wait_for_completion
-          puts "Reset virtual machine #{vmname}"
-      end
-
-      if get_config(:wait_port)
-        print "Waiting for port #{get_config(:wait_port)}..."
-        print "." until tcp_test_port_vm(vm, get_config(:wait_port))
-        puts "done"
-      end
-    end
-  end
-end
+#
+# Author:: Ezra Pagel (<ezra@cpan.org>)
+# License:: Apache License, Version 2.0
+#
+
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+require 'rbvmomi'
+require 'netaddr'
+
+PS_ON = 'poweredOn'
+PS_OFF = 'poweredOff'
+PS_SUSPENDED = 'suspended'
+
+POWER_STATES = {
+  PS_ON => 'powered on',
+  PS_OFF => 'powered off',
+  PS_SUSPENDED => 'suspended'
+}
+
+# Manage power state of a virtual machine
+class Chef::Knife::VsphereVmState < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm state VMNAME (options)'
+
+  common_options
+
+  option :state,
+         short: '-s STATE',
+         long: '--state STATE',
+         description: 'The power state to transition the VM into; one of on|off|suspended'
+
+  option :wait_port,
+         short: '-w PORT',
+         long: '--wait-port PORT',
+         description: 'Wait for VM to be accessible on a port'
+
+  option :shutdown,
+         short: '-g',
+         long: '--shutdown',
+         description: 'Guest OS shutdown'
+
+  option :recursive,
+         short: '-r',
+         long: '--recursive',
+         description: 'Search all folders'
+
+  def run
+    $stdout.sync = true
+
+    vmname = @name_args[0]
+    if vmname.nil?
+      show_usage
+      ui.fatal('You must specify a virtual machine name')
+      exit 1
+    end
+
+    vim_connection
+
+    if get_config(:recursive)
+      vms = get_vms(vmname)
+      if vms.length > 1
+        abort "More than one VM with name #{vmname} found:\n" + vms.map { |vm| get_path_to_object(vm) }.join("\n")
+      end
+      abort "VM #{vmname} not found" if vms.length == 0
+      vm = vms[0]
+    else
+      base_folder = find_folder(get_config(:folder))
+
+      vm = find_in_folder(base_folder, RbVmomi::VIM::VirtualMachine, vmname) || abort("VM #{vmname} not found")
+    end
+
+    state = vm.runtime.powerState
+
+    if config[:state].nil?
+      puts "VM #{vmname} is currently " + POWER_STATES[vm.runtime.powerState]
+    else
+
+      case config[:state]
+      when 'on'
+        if state == PS_ON
+          puts "Virtual machine #{vmname} was already powered on"
+        else
+          vm.PowerOnVM_Task.wait_for_completion
+          puts "Powered on virtual machine #{vmname}"
+        end
+      when 'off'
+        if state == PS_OFF
+          puts "Virtual machine #{vmname} was already powered off"
+        else
+          if get_config(:shutdown)
+            vm.ShutdownGuest
+            print "Waiting for virtual machine #{vmname} to shut down..."
+            until vm.runtime.powerState == PS_OFF
+              sleep 2
+              print '.'
+            end
+            puts 'done'
+          else
+            vm.PowerOffVM_Task.wait_for_completion
+            puts "Powered off virtual machine #{vmname}"
+          end
+        end
+      when 'suspend'
+        if state == POWER_STATES['suspended']
+          puts "Virtual machine #{vmname} was already suspended"
+        else
+          vm.SuspendVM_Task.wait_for_completion
+          puts "Suspended virtual machine #{vmname}"
+        end
+      when 'reset'
+        vm.ResetVM_Task.wait_for_completion
+        puts "Reset virtual machine #{vmname}"
+      end
+
+      if get_config(:wait_port)
+        print "Waiting for port #{get_config(:wait_port)}..."
+        print '.' until tcp_test_port_vm(vm, get_config(:wait_port))
+        puts 'done'
+      end
+    end
+  end
+end