knife-vsphere 1.0.1 → 1.2.0

data/lib/chef/knife/customization_helper.rb

@@ -0,0 +1,40 @@
+#
+# Author:: Malte Heidenreich (https://github.com/mheidenr)
+# License:: Apache License, Version 2.0
+#
+
+require 'rbvmomi'
+
+module CustomizationHelper
+  def self.wait_for_sysprep(vm, vim_connection, timeout, sleep_time)
+    vem = vim_connection.serviceContent.eventManager
+
+    wait = true
+    waited_seconds = 0
+
+    print 'Waiting for sysprep...'
+    while wait
+      events = query_customization_succeeded(vm, vem)
+
+      if events.size > 0
+        events.each do |e|
+          puts "\n#{e.fullFormattedMessage}"
+        end
+        wait = false
+      elsif waited_seconds >= timeout
+        abort "\nCustomization of VM #{vm.name} not succeeded within #{timeout} seconds."
+      else
+        print '.'
+        sleep(sleep_time)
+        waited_seconds += sleep_time
+      end
+    end
+  end
+
+  def self.query_customization_succeeded(vm, vem)
+    vem.QueryEvents(filter:
+        RbVmomi::VIM::EventFilterSpec(entity:
+        RbVmomi::VIM::EventFilterSpecByEntity(entity: vm, recursion:
+        RbVmomi::VIM::EventFilterSpecRecursionOption(:self)), eventTypeId: ['CustomizationSucceeded']))
+  end
+end

data/lib/chef/knife/vsphere_cluster_list.rb

@@ -0,0 +1,47 @@
+#
+# Author:: Jesse Campbell (<hikeit@gmail.com>)
+# Contributor:: Dennis Pattmann (https://github.com/DennisBP)
+# License:: Apache License, Version 2.0
+#
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+
+# Lists all known clusters in the configured datacenter
+class Chef::Knife::VsphereClusterList < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere cluster list'
+
+  common_options
+
+  def traverse_folders(folder)
+    return if folder.is_a? RbVmomi::VIM::VirtualApp
+
+    if folder.is_a? RbVmomi::VIM::ClusterComputeResource
+      clusters = folder.path[3..-1].reject { |p| p.last == 'ClusterComputeResource' }
+      puts "#{ui.color('Cluster', :cyan)}: " + clusters.map(&:last).join('/')
+    end
+
+    folders = find_all_in_folder(folder, RbVmomi::VIM::ManagedObject) || []
+    folders.each do |child|
+      traverse_folders(child)
+    end
+  end
+
+  def find_cluster_folder(folderName)
+    dc = datacenter
+    base_entity = dc.hostFolder
+    entity_array = folderName.split('/')
+    entity_array.each do |entityArrItem|
+      if entityArrItem != ''
+        base_entity = base_entity.childEntity.grep(RbVmomi::VIM::ManagedObject).find { |f| f.name == entityArrItem } ||
+                      abort("no such folder #{folderName} while looking for #{entityArrItem}")
+      end
+    end
+    base_entity
+  end
+
+  def run
+    vim_connection
+    base_folder = find_cluster_folder(get_config(:folder))
+    traverse_folders(base_folder)
+  end
+end

data/lib/chef/knife/vsphere_cpu_ratio.rb

@@ -1,45 +1,41 @@
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-
-class Chef::Knife::VsphereCpuRatio < Chef::Knife::BaseVsphereCommand
-  banner 'knife vsphere cpu ratio [CLUSTER] [HOST]'
-
-  get_common_options
-
-  def run
-    $stdout.sync = true
-
-    cluster_name = @name_args[0]
-    host_name = @name_args[1]
-
-    get_vim_connection
-
-    dc = get_datacenter
-    hf = dc.hostFolder
-
-    cluster = cluster_name.nil? ? hf.childEntity : hf.childEntity.select { |c| c.name == cluster_name }
-
-    if cluster.empty?
-      fatal_exit("Cluster #{cluster_name} not found.")
-    end
-
-    cluster.each { |c|
-      host = host_name.nil? ? c.host : c.host.select { |h| h.name == host_name }
-      if host.empty?
-        fatal_exit("Host not found in cluster #{c.name}.")
-      end
-
-      puts "### Cluster #{c.name} ###"
-
-      host.each { |h|
-        v_cpu = h.vm.inject(0) { |sum, vm| sum + vm.config.hardware.numCPU }
-        p_cpu = h.summary.hardware.numCpuThreads
-
-        ratio = 1.0 * v_cpu/p_cpu
-
-        puts "#{h.name}: #{ratio}"
-      }
-      puts ''
-    }
-  end
-end
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+
+class Chef::Knife::VsphereCpuRatio < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere cpu ratio [CLUSTER] [HOST]'
+
+  common_options
+
+  def run
+    $stdout.sync = true
+
+    cluster_name = @name_args[0]
+    host_name = @name_args[1]
+
+    vim_connection
+
+    dc = datacenter
+    hf = dc.hostFolder
+
+    cluster = cluster_name.nil? ? hf.childEntity : hf.childEntity.select { |c| c.name == cluster_name }
+
+    fatal_exit("Cluster #{cluster_name} not found.") if cluster.empty?
+
+    cluster.each do |c|
+      host = host_name.nil? ? c.host : c.host.select { |h| h.name == host_name }
+      fatal_exit("Host not found in cluster #{c.name}.") if host.empty?
+
+      puts "### Cluster #{c.name} ###"
+
+      host.each do |h|
+        v_cpu = h.vm.inject(0) { |a, e| a + e.config.hardware.numCPU }
+        p_cpu = h.summary.hardware.numCpuThreads
+
+        ratio = 1.0 * v_cpu / p_cpu
+
+        puts "#{h.name}: #{ratio}"
+      end
+      puts ''
+    end
+  end
+end

data/lib/chef/knife/vsphere_customization_list.rb

@@ -1,29 +1,24 @@
-#
-# Author:: Ezra Pagel (<ezra@cpan.org>)
-# License:: Apache License, Version 2.0
-#
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-
-# Lists all customization specifications in the configured datacenter
-class Chef::Knife::VsphereCustomizationList < Chef::Knife::BaseVsphereCommand
-
-  banner "knife vsphere customization list"
-
-  get_common_options
-
-  def run
-
-    $stdout.sync = true
-
-    vim = get_vim_connection
-
-    csm = vim.serviceContent.customizationSpecManager
-    csm.info.each do |c|
-      puts "#{ui.color("Customization Name", :cyan)}: #{c.name}"
-
-    end
-
-  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 customization specifications in the configured datacenter
+class Chef::Knife::VsphereCustomizationList < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere customization list'
+
+  common_options
+
+  def run
+    $stdout.sync = true
+
+    vim = vim_connection
+
+    csm = vim.serviceContent.customizationSpecManager
+    csm.info.each do |c|
+      puts "#{ui.color('Customization Name', :cyan)}: #{c.name}"
+    end
+  end
+end

data/lib/chef/knife/vsphere_datastore_list.rb

@@ -1,72 +1,68 @@
-# Copyright (C) 2012, SCM Ventures AB
-# Author: Ian Delahorne <ian@scmventures.se>
-#
-# Permission to use, copy, modify, and/or distribute this software for
-# any purpose with or without fee is hereby granted, provided that the
-# above copyright notice and this permission notice appear in all
-# copies.
-#
-# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
-# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
-# DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
-# OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
-# TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-# PERFORMANCE OF THIS SOFTWARE
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-
-def number_to_human_size(number)
-  number = number.to_f
-  storage_units_fmt = ["byte", "kB", "MB", "GB", "TB"]
-  base = 1024
-  if number.to_i < base
-    unit = storage_units_fmt[0]
-  else
-    max_exp = storage_units_fmt.size - 1
-    exponent = (Math.log(number) / Math.log(base)).to_i # Convert to base
-    exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
-    number /= base ** exponent
-    unit = storage_units_fmt[exponent]
-  end
-
-  return sprintf("%0.2f %s", number, unit)
-end
-
-
-# Lists all known data stores in datacenter with sizes
-class Chef::Knife::VsphereDatastoreList < Chef::Knife::BaseVsphereCommand
-
-  banner "knife vsphere datastore list"
-
-  get_common_options
-
-  option :list,
-	 :long => "--list",
-	 :short => "-L",
-	 :description => "Indicates whether to list VM's in datastore",
-	 :boolean => true
-
-  def run
-    $stdout.sync = true
-
-    vim = get_vim_connection
-    dc = get_datacenter
-    dc.datastore.each do |store|
-      avail = number_to_human_size(store.summary[:freeSpace])
-      cap = number_to_human_size(store.summary[:capacity])
-      puts "#{ui.color("Datastore", :cyan)}: #{store.name} (#{avail} / #{cap})"
-      if get_config(:list)
-        store.vm.each do |vms|
-	  hostName = vms.guest[:hostName]
-	  guestFullName = vms.guest[:guestFullName]
-	  guestState = vms.guest[:guestState]
-	  puts "#{ui.color("VM Name:", :green)} #{hostName} #{ui.color("OS:", :magenta)} #{guestFullName} #{ui.color("State:", :cyan)} #{guestState}"
-        end
-      end
-    end
-  end
-end
-
+# Copyright (C) 2012, SCM Ventures AB
+# Author: Ian Delahorne <ian@scmventures.se>
+#
+# Permission to use, copy, modify, and/or distribute this software for
+# any purpose with or without fee is hereby granted, provided that the
+# above copyright notice and this permission notice appear in all
+# copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+# DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
+# OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+# TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+# PERFORMANCE OF THIS SOFTWARE
+
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+
+def number_to_human_size(number)
+  number = number.to_f
+  storage_units_fmt = %w(byte kB MB GB TB)
+  base = 1024
+  if number.to_i < base
+    unit = storage_units_fmt[0]
+  else
+    max_exp = storage_units_fmt.size - 1
+    exponent = (Math.log(number) / Math.log(base)).to_i # Convert to base
+    exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
+    number /= base**exponent
+    unit = storage_units_fmt[exponent]
+  end
+
+  format('%0.2f %s', number, unit)
+end
+
+# Lists all known data stores in datacenter with sizes
+class Chef::Knife::VsphereDatastoreList < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere datastore list'
+
+  common_options
+
+  option :list,
+         long: '--list',
+         short: '-L',
+         description: "Indicates whether to list VM's in datastore",
+         boolean: true
+
+  def run
+    $stdout.sync = true
+
+    vim_connection
+    dc = datacenter
+    dc.datastore.each do |store|
+      avail = number_to_human_size(store.summary[:freeSpace])
+      cap = number_to_human_size(store.summary[:capacity])
+      puts "#{ui.color('Datastore', :cyan)}: #{store.name} (#{avail} / #{cap})"
+      next unless get_config(:list)
+      store.vm.each do |vms|
+        host_name = vms.guest[:hostName]
+        guest_full_name = vms.guest[:guest_full_name]
+        guest_state = vms.guest[:guest_state]
+        puts "#{ui.color('VM Name:', :green)} #{host_name} #{ui.color('OS:', :magenta)} #{guest_full_name} #{ui.color('State:', :cyan)} #{guest_state}"
+      end
+    end
+  end
+end

data/lib/chef/knife/vsphere_datastore_maxfree.rb

@@ -1,49 +1,48 @@
-# Copyright (C) 2012, SCM Ventures AB
-# Author: Ian Delahorne <ian@scmventures.se>
-#
-# Permission to use, copy, modify, and/or distribute this software for
-# any purpose with or without fee is hereby granted, provided that the
-# above copyright notice and this permission notice appear in all
-# copies.
-#
-# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
-# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
-# DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
-# OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
-# TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-# PERFORMANCE OF THIS SOFTWARE
-
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-
-# Gets the data store with the most free space in datacenter
-class Chef::Knife::VsphereDatastoreMaxfree < Chef::Knife::BaseVsphereCommand
-
-  banner "knife vsphere datastore maxfree"
-
-  option :regex,
-         :short => "-r REGEX",
-         :long => "--regex REGEX",
-         :description => "Regex to match the datastore name"
-
-  get_common_options
-  $default[:regex] = ''
-
-  def run
-    $stdout.sync = true
-
-    vim = get_vim_connection
-    dcname = get_config(:vsphere_dc)
-	regex = /#{Regexp.escape( get_config(:regex))}/
-    dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
-	max = nil
-    dc.datastore.each do |store|
-	  if regex.match(store.name) and (max == nil or max.summary[:freeSpace] < store.summary[:freeSpace])
-	    max = store
-	  end      
-    end
-	puts max ? max.name : ""
-  end
-end
+# Copyright (C) 2012, SCM Ventures AB
+# Author: Ian Delahorne <ian@scmventures.se>
+#
+# Permission to use, copy, modify, and/or distribute this software for
+# any purpose with or without fee is hereby granted, provided that the
+# above copyright notice and this permission notice appear in all
+# copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+# DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
+# OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+# TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+# PERFORMANCE OF THIS SOFTWARE
+
+require 'chef/knife'
+require 'chef/knife/base_vsphere_command'
+
+# Gets the data store with the most free space in datacenter
+class Chef::Knife::VsphereDatastoreMaxfree < Chef::Knife::BaseVsphereCommand
+  banner 'knife vsphere datastore maxfree'
+
+  option :regex,
+         short: '-r REGEX',
+         long: '--regex REGEX',
+         description: 'Regex to match the datastore name',
+         default: ''
+
+  common_options
+
+  def run
+    $stdout.sync = true
+
+    vim_connection
+    dcname = get_config(:vsphere_dc)
+    regex = /#{Regexp.escape(get_config(:regex))}/
+    dc = config[:vim].serviceInstance.find_datacenter(dcname) || abort('datacenter not found')
+    max = nil
+    dc.datastore.each do |store|
+      if regex.match(store.name) && (max.nil? || max.summary[:freeSpace] < store.summary[:freeSpace])
+        max = store
+      end
+    end
+    puts max ? max.name : ''
+  end
+end