knife-vsphere 0.9.0 → 0.9.5

data/lib/chef/knife/vsphere_vm_config.rb

@@ -0,0 +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
+
+    dcname = get_config(:vsphere_dc)
+    dc = vim.serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+    folder = find_folder(get_config(:folder)) || dc.vmFolder
+
+    vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, 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

data/lib/chef/knife/vsphere_vm_delete.rb

@@ -4,7 +4,7 @@
 #
 
 require 'chef/knife'
-require 'chef/knife/BaseVsphereCommand'
+require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 
 # These two are needed for the '--purge' deletion case
@@ -14,53 +14,53 @@ require 'chef/api_client'
 # Delete a virtual machine from vCenter
 class Chef::Knife::VsphereVmDelete < Chef::Knife::BaseVsphereCommand
 
-	banner "knife vsphere vm delete VMNAME"
+  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."
+  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
+  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
+  # 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
+  def run
+    $stdout.sync = true
 
-		vmname = @name_args[0]
+    vmname = @name_args[0]
 
-		if vmname.nil?
-			show_usage
-			fatal_exit("You must specify a virtual machine name")
-		end
+    if vmname.nil?
+      show_usage
+      fatal_exit("You must specify a virtual machine name")
+    end
 
-		vim = get_vim_connection
+    vim = get_vim_connection
 
-		baseFolder = find_folder(get_config(:folder));
+    baseFolder = find_folder(get_config(:folder));
 
-		vm = find_in_folder(baseFolder, RbVmomi::VIM::VirtualMachine, vmname) or
-		fatal_exit("VM #{vmname} not found")
+    vm = find_in_folder(baseFolder, RbVmomi::VIM::VirtualMachine, 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}"
+    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
+    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

data/lib/chef/knife/vsphere_vm_execute.rb

@@ -1,68 +1,67 @@
-
-# Author:: Ian Delahorne (<ian@delahorne.com>)
-# License:: Apache License, Version 2.0
-
-require 'chef/knife'
-require 'chef/knife/BaseVsphereCommand'
-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
-
-    dcname = get_config(:vsphere_dc)
-    dc = vim.serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
-    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"
+
+  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
+
+    dcname = get_config(:vsphere_dc)
+    dc = vim.serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+    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

data/lib/chef/knife/vsphere_vm_list.rb

@@ -3,64 +3,64 @@
 # License:: Apache License, Version 2.0
 #
 require 'chef/knife'
-require 'chef/knife/BaseVsphereCommand'
+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"
+  banner "knife vsphere vm list"
 
-	get_common_options
+  get_common_options
 
-	option :recursive,
-		:long  => "--recursive",
-		:short => "-r",
-		:description => "Recurse down through sub-folders"
+  option :recursive,
+         :long => "--recursive",
+         :short => "-r",
+         :description => "Recurse down through sub-folders"
 
-	option :only_folders,
-		:long  => "--only-folders",
-		:description => "Print only sub-folders"
+  option :only_folders,
+         :long => "--only-folders",
+         :description => "Print only sub-folders"
 
-	def traverse_folders(folder)
-		puts "#{ui.color("Folder", :cyan)}: "+(folder.path[3..-1].map{|x| x[1]}.*'/')
-		print_vms_in_folder(folder) unless get_config(:only_folders)
-		folders = find_all_in_folder(folder, RbVmomi::VIM::Folder)
-		folders.each do |child|
-			traverse_folders(child)
-		end
-	end
+  def traverse_folders(folder)
+    puts "#{ui.color("Folder", :cyan)}: "+(folder.path[3..-1].map { |x| x[1] }.* '/')
+    print_vms_in_folder(folder) unless get_config(:only_folders)
+    folders = find_all_in_folder(folder, RbVmomi::VIM::Folder)
+    folders.each do |child|
+      traverse_folders(child)
+    end
+  end
 
-	def print_vms_in_folder(folder)
-		vms = find_all_in_folder(folder, RbVmomi::VIM::VirtualMachine)
-		vms.each do |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 "#{ui.color("VM Name:", :cyan)} #{vm.name}\t#{ui.color("IP:", :magenta)} #{vm.guest.ipAddress}\t#{ui.color("RAM:", :magenta)} #{vm.summary.config.memorySizeMB}\t#{ui.color("State:", :cyan)} #{state}"
-		end
-	end
+  def print_vms_in_folder(folder)
+    vms = find_all_in_folder(folder, RbVmomi::VIM::VirtualMachine)
+    vms.each do |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 "#{ui.color("VM Name:", :cyan)} #{vm.name}\t#{ui.color("IP:", :magenta)} #{vm.guest.ipAddress}\t#{ui.color("RAM:", :magenta)} #{vm.summary.config.memorySizeMB}\t#{ui.color("State:", :cyan)} #{state}"
+    end
+  end
 
-	def print_subfolders(folder)
-		folders = find_all_in_folder(folder, RbVmomi::VIM::Folder)
+  def print_subfolders(folder)
+    folders = find_all_in_folder(folder, RbVmomi::VIM::Folder)
     folders.each do |subfolder|
       puts "#{ui.color("Folder Name", :cyan)}: #{subfolder.name}"
     end
-	end
+  end
 
-	def run
-		$stdout.sync = true
-		vim = get_vim_connection
-		baseFolder = find_folder(get_config(:folder));
-		if get_config(:recursive)
-			traverse_folders(baseFolder)
-		else
-			print_subfolders(baseFolder)
-			print_vms_in_folder(baseFolder)
-		end
-	end
+  def run
+    $stdout.sync = true
+    vim = get_vim_connection
+    baseFolder = find_folder(get_config(:folder));
+    if get_config(:recursive)
+      traverse_folders(baseFolder)
+    else
+      print_subfolders(baseFolder)
+      print_vms_in_folder(baseFolder)
+    end
+  end
 end

data/lib/chef/knife/vsphere_vm_query.rb

@@ -1,9 +1,8 @@
-
-# Author:: Ian Delahorne (<ian@delahorne.com>)
+# Author:: Brian Dupras (<bdupras@rallydev.com>)
 # License:: Apache License, Version 2.0
 
 require 'chef/knife'
-require 'chef/knife/BaseVsphereCommand'
+require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
@@ -33,7 +32,7 @@ class Chef::Knife::VsphereVmQuery < Chef::Knife::BaseVsphereCommand
     folder = find_folder(get_config(:folder)) || dc.vmFolder
 
     vm = find_in_folder(folder, RbVmomi::VIM::VirtualMachine, vmname) or
-      abort "VM #{vmname} not found"
+        abort "VM #{vmname} not found"
 
     # split QUERY by dots, and walk the object model
     query = query_string.split '.'

data/lib/chef/knife/vsphere_vm_snapshot.rb

@@ -3,7 +3,7 @@
 #
 
 require 'chef/knife'
-require 'chef/knife/BaseVsphereCommand'
+require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
@@ -16,33 +16,33 @@ class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
   get_common_options
 
   option :list,
-  :long => "--list",
-  :description => "The current tree of snapshots"
+         :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."
+         :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."
+         :long => "--remove SNAPSHOT",
+         :description => "Remove a named snapshot."
 
   option :revert_snapshot,
-  :long => "--revert SNAPSHOT",
-  :description => "Revert to a named snapshot."
+         :long => "--revert SNAPSHOT",
+         :description => "Revert to a named snapshot."
 
   option :revert_current_snapshot,
-  :long => "--revert-current",
-  :description => "Revert to current snapshot.",
-  :boolean => false
+         :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
+         :long => "--start",
+         :description => "Indicates whether to start the VM after a successful revert",
+         :boolean => false
 
   def run
-  
+
     $stdout.sync = true
 
     vmname = @name_args[0]
@@ -51,13 +51,13 @@ class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
       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"
+        abort "VM #{vmname} not found"
 
     if vm.snapshot
       snapshot_list = vm.snapshot.rootSnapshotList
@@ -67,7 +67,7 @@ class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
     if config[:list] && vm.snapshot
       puts "Current snapshot tree: "
       puts "#{vmname}"
-      snapshot_list.each{|i| puts display_node(i,current_snapshot)}
+      snapshot_list.each { |i| puts display_node(i, current_snapshot) }
     end
 
     if config[:create_new_snapshot]
@@ -75,55 +75,55 @@ class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
     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)
+      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
+      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
+      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 
-           elsif !node.childSnapshotList.empty?
-               snapshot = find_node(node.childSnapshotList,name)
-           end
-       end
-       return snapshot
+  def find_node(tree, name)
+    snapshot = nil
+    tree.each do |node|
+      if node.name == name
+        snapshot = node.snapshot
+      elsif !node.childSnapshotList.empty?
+        snapshot = find_node(node.childSnapshotList, name)
+      end
+    end
+    return snapshot
   end
 
-  def display_node(node,current,shift=1) 
+  def display_node(node, current, shift=1)
     out = ""
-    out << "+--"*shift 
+    out << "+--"*shift
     if node.snapshot == current
-        out << "#{ui.color(node.name, :cyan)}" << "\n"
-    else 
-        out << "#{node.name}" << "\n"
+      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 
+    if !node.childSnapshotList.empty?
+      node.childSnapshotList.each { |item| out << display_node(item, current, shift+1) }
+    end
+    out
+  end
 end