knife-vsphere 1.0.1 → 1.2.0

data/lib/chef/knife/vsphere_vm_config.rb

@@ -1,46 +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::VsphereVmConfig < Chef::Knife::BaseVsphereCommand
-  banner "knife vsphere vm config VMNAME PROPERTY VALUE.  See \"http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.vm.ConfigSpec.html\" for allowed ATTRIBUTE values (any property of type xs:string is supported)."
-
-  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
-
-    property_name = @name_args[1]
-    if property_name.nil?
-      show_usage
-      fatal_exit("You must specify a PROPERTY name (e.g. annotation)")
-    end
-    property_name = property_name.to_sym
-
-    property_value = @name_args[2]
-    if property_value.nil?
-      show_usage
-      fatal_exit("You must specify a PROPERTY value")
-    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"
-
-    properties = {}
-    properties[property_name] = property_value
-    vm.ReconfigVM_Task(:spec => RbVmomi::VIM.VirtualMachineConfigSpec(properties)).wait_for_completion
-  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::VsphereVmConfig < Chef::Knife::BaseVsphereCommand
+  banner "knife vsphere vm config VMNAME PROPERTY VALUE.
+          See \"http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.vm.ConfigSpec.html\"
+          for allowed ATTRIBUTE values (any property of type xs:string is supported)."
+
+  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
+
+    property_name = @name_args[1]
+    if property_name.nil?
+      show_usage
+      fatal_exit('You must specify a PROPERTY name (e.g. annotation)')
+    end
+    property_name = property_name.to_sym
+
+    property_value = @name_args[2]
+    if property_value.nil?
+      show_usage
+      fatal_exit('You must specify a PROPERTY value')
+    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")
+
+    properties = {}
+    properties[property_name] = property_value
+    vm.ReconfigVM_Task(spec: RbVmomi::VIM.VirtualMachineConfigSpec(properties)).wait_for_completion
+  end
+end

data/lib/chef/knife/vsphere_vm_delete.rb

@@ -1,66 +1,70 @@
-#
-# Author:: Ezra Pagel (<ezra@cpan.org>)
-# License:: Apache License, Version 2.0
-#
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-
-# These two are needed for the '--purge' deletion case
-require 'chef/node'
-require 'chef/api_client'
-
-# Delete a virtual machine from vCenter
-class Chef::Knife::VsphereVmDelete < Chef::Knife::BaseVsphereCommand
-
-  banner "knife vsphere vm delete VMNAME"
-
-  option :purge,
-         :short => "-P",
-         :long => "--purge",
-         :boolean => true,
-         :description => "Destroy corresponding node and client on the Chef Server, in addition to destroying the VM itself."
-
-  get_common_options
-
-  # Extracted from Chef::Knife.delete_object, because it has a
-  # confirmation step built in... By specifying the '--purge'
-  # flag (and also explicitly confirming the server destruction!)
-  # the user is already making their intent known. It is not
-  # necessary to make them confirm two more times.
-  def destroy_item(itemClass, name, type_name)
-    object = itemClass.load(name)
-    object.destroy
-    puts "Deleted #{type_name} #{name}"
-  end
-
-  def run
-    $stdout.sync = true
-
-    vmname = @name_args[0]
-
-    if vmname.nil?
-      show_usage
-      fatal_exit("You must specify a virtual machine name")
-    end
-
-    vim = get_vim_connection
-
-    baseFolder = find_folder(get_config(:folder));
-
-    vm = traverse_folders_for_vm(baseFolder, vmname) or
-        fatal_exit("VM #{vmname} not found")
-
-    vm.PowerOffVM_Task.wait_for_completion unless vm.runtime.powerState == "poweredOff"
-    vm.Destroy_Task
-    puts "Deleted virtual machine #{vmname}"
-
-    if config[:purge]
-      destroy_item(Chef::Node, vmname, "node")
-      destroy_item(Chef::ApiClient, vmname, "client")
-    else
-      puts "Corresponding node and client for the #{vmname} server were not deleted and remain registered with the Chef Server"
-    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'
+
+# These two are needed for the '--purge' deletion case
+require 'chef/node'
+require 'chef/api_client'
+
+# Delete a virtual machine from vCenter
+class Chef::Knife::VsphereVmDelete < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm delete VMNAME (options)'
+
+  option :purge,
+         short: '-P',
+         long: '--purge',
+         boolean: true,
+         description: 'Destroy corresponding node and client on the Chef Server, in addition to destroying the VM itself.'
+
+  option :chef_node_name,
+         short: '-N NAME',
+         long: '--node-name NAME',
+         description: 'Use this option if the Chef node name is different from the VM name'
+
+  common_options
+
+  # Extracted from Chef::Knife.delete_object, because it has a
+  # confirmation step built in... By specifying the '--purge'
+  # flag (and also explicitly confirming the server destruction!)
+  # the user is already making their intent known. It is not
+  # necessary to make them confirm two more times.
+  def destroy_item(itemClass, name, type_name)
+    object = itemClass.load(name)
+    object.destroy
+    puts "Deleted #{type_name} #{name}"
+  end
+
+  def run
+    $stdout.sync = true
+
+    vmname = @name_args[0]
+
+    if vmname.nil?
+      show_usage
+      fatal_exit('You must specify a virtual machine name')
+    end
+
+    vim_connection
+
+    base_folder = find_folder(get_config(:folder))
+
+    vm = traverse_folders_for_vm(base_folder, vmname) || fatal_exit("VM #{vmname} not found")
+
+    vm.PowerOffVM_Task.wait_for_completion unless vm.runtime.powerState == 'poweredOff'
+    vm.Destroy_Task.wait_for_completion
+    puts "Deleted virtual machine #{vmname}"
+
+    if config[:purge]
+      vmname = config[:chef_node_name] if config[:chef_node_name]
+      destroy_item(Chef::Node, vmname, 'node')
+      destroy_item(Chef::ApiClient, vmname, 'client')
+    else
+      puts "Corresponding node and client for the #{vmname} server were not deleted and remain registered with the Chef Server"
+    end
+  end
+end

data/lib/chef/knife/vsphere_vm_execute.rb

@@ -1,66 +1,62 @@
-# Author:: Ian Delahorne (<ian@delahorne.com>)
-# License:: Apache License, Version 2.0
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-require 'netaddr'
-
-class Chef::Knife::VsphereVmExecute < Chef::Knife::BaseVsphereCommand
-  banner "knife vsphere vm execute VMNAME COMMAND ARGS"
-
-  option :exec_user,
-         :long => "--exec-user USER",
-         :description => "User to execute as",
-         :required => true
-
-  option :exec_passwd,
-         :long => "--exec-passwd PASSWORD",
-         :description => "Password for execute user",
-         :required => true
-
-  option :exec_dir,
-         :long => "--exec-dir DIRECTORY",
-         :description => "Working directory to execute in"
-
-  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
-    command = @name_args[1]
-    if command.nil?
-      show_usage
-      fatal_exit("You must specify a command to execute")
-    end
-
-    args = @name_args[2]
-    if args.nil?
-      args = ""
-    end
-
-    vim = get_vim_connection
-
-    dc = get_datacenter
-    folder = find_folder(get_config(:folder)) || dc.vmFolder
-
-    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) or
-        abort "VM #{vmname} not found"
-
-    gom = vim.serviceContent.guestOperationsManager
-
-    guest_auth = RbVmomi::VIM::NamePasswordAuthentication(:interactiveSession => false,
-                                                          :username => config[:exec_user],
-                                                          :password => config[:exec_passwd])
-    prog_spec = RbVmomi::VIM::GuestProgramSpec(:programPath => command,
-                                               :arguments => args,
-                                               :workingDirectory => get_config(:exec_dir))
-
-    gom.processManager.StartProgramInGuest(:vm => vm, :auth => guest_auth, :spec => prog_spec)
-
-  end
-end
+# Author:: Ian Delahorne (<ian@delahorne.com>)
+# License:: Apache License, Version 2.0
+
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+require 'rbvmomi'
+require 'netaddr'
+
+class Chef::Knife::VsphereVmExecute < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm execute VMNAME COMMAND ARGS'
+
+  option :exec_user,
+         long: '--exec-user USER',
+         description: 'User to execute as',
+         required: true
+
+  option :exec_passwd,
+         long: '--exec-passwd PASSWORD',
+         description: 'Password for execute user',
+         required: true
+
+  option :exec_dir,
+         long: '--exec-dir DIRECTORY',
+         description: 'Working directory to execute in'
+
+  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
+    command = @name_args[1]
+    if command.nil?
+      show_usage
+      fatal_exit('You must specify a command to execute')
+    end
+
+    args = @name_args[2]
+    args = '' if args.nil?
+
+    vim = vim_connection
+
+    dc = datacenter
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) || abort("VM #{vmname} not found")
+
+    gom = vim.serviceContent.guestOperationsManager
+
+    guest_auth = RbVmomi::VIM::NamePasswordAuthentication(interactiveSession: false,
+                                                          username: config[:exec_user],
+                                                          password: config[:exec_passwd])
+    prog_spec = RbVmomi::VIM::GuestProgramSpec(programPath: command,
+                                               arguments: args,
+                                               workingDirectory: get_config(:exec_dir))
+
+    gom.processManager.StartProgramInGuest(vm: vm, auth: guest_auth, spec: prog_spec)
+  end
+end

data/lib/chef/knife/vsphere_vm_list.rb

@@ -1,61 +1,57 @@
-#
-# Author:: Ezra Pagel (<ezra@cpan.org>)
-# License:: Apache License, Version 2.0
-#
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-
-# Lists all known virtual machines in the configured datacenter
-class Chef::Knife::VsphereVmList < Chef::Knife::BaseVsphereCommand
-
-  banner "knife vsphere vm list"
-
-  get_common_options
-
-  option :recursive,
-         :long => "--recursive",
-         :short => "-r",
-         :description => "Recurse into sub-folders"
-
-  def traverse_folders(folder, is_top = false, recurse = false)
-
-    vms = find_all_in_folder(folder, RbVmomi::VIM::VirtualMachine).select {|v| v.config && !v.config.template }
-    if vms.any?
-      puts "#{ui.color("Folder", :cyan)}: "+(folder.path[3..-1].map { |x| x[1] }.* '/')
-      vms.each { |v|  print_vm(v) }
-    elsif is_top
-      puts "#{ui.color("No VMs", :cyan)}"
-    end
-
-    if (recurse)
-      folders = find_all_in_folder(folder, RbVmomi::VIM::Folder)
-      folders.each do |child|
-        traverse_folders(child, false, recurse)
-      end
-    end
-
-  end
-
-  def print_vm(vm)
-    state = case vm.runtime.powerState
-            when PsOn
-              ui.color("on", :green)
-            when PsOff
-              ui.color("off", :red)
-            when PsSuspended
-              ui.color("suspended", :yellow)
-            end
-    puts "\t#{ui.color("VM Name:", :cyan)} #{vm.name}"
-         "\t\t#{ui.color("IP:", :magenta)} #{vm.guest.ipAddress}"
-         "\t\t#{ui.color("RAM:", :magenta)} #{vm.summary.config.memorySizeMB}"
-         "\t\t#{ui.color("State:", :cyan)} #{state}"
-  end
-
-  def run
-    vim = get_vim_connection
-    baseFolder = find_folder(get_config(:folder));
-    recurse =  get_config(:recursive)
-    is_top = true
-    traverse_folders(baseFolder, is_top, recurse)
-  end
-end
+#
+# Author:: Ezra Pagel (<ezra@cpan.org>)
+# License:: Apache License, Version 2.0
+#
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+
+# Lists all known virtual machines in the configured datacenter
+class Chef::Knife::VsphereVmList < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere vm list'
+
+  common_options
+
+  option :recursive,
+         long: '--recursive',
+         short: '-r',
+         description: 'Recurse into sub-folders'
+
+  def traverse_folders(folder, is_top = false, recurse = false)
+    vms = find_all_in_folder(folder, RbVmomi::VIM::VirtualMachine).select { |v| v.config && !v.config.template }
+    if vms.any?
+      puts "#{ui.color('Folder', :cyan)}: " + (folder.path[3..-1].map { |x| x[1] }.* '/')
+      vms.each { |v|  print_vm(v) }
+    elsif is_top
+      puts "#{ui.color('No VMs', :cyan)}"
+    end
+
+    return unless recurse
+    folders = find_all_in_folder(folder, RbVmomi::VIM::Folder)
+    folders.each do |child|
+      traverse_folders(child, false, recurse)
+    end
+  end
+
+  def print_vm(vm)
+    state = case vm.runtime.powerState
+            when PS_ON
+              ui.color('on', :green)
+            when PS_OFF
+              ui.color('off', :red)
+            when PS_SUSPENDED
+              ui.color('suspended', :yellow)
+            end
+    puts "\t#{ui.color('VM Name:', :cyan)} #{vm.name}"
+    puts "\t\t#{ui.color('IP:', :magenta)} #{vm.guest.ipAddress}"
+    puts "\t\t#{ui.color('RAM:', :magenta)} #{vm.summary.config.memorySizeMB}"
+    puts "\t\t#{ui.color('State:', :magenta)} #{state}"
+  end
+
+  def run
+    vim_connection
+    base_folder = find_folder(get_config(:folder))
+    recurse =  get_config(:recursive)
+    is_top = true
+    traverse_folders(base_folder, is_top, recurse)
+  end
+end