knife-vsphere 0.1.7 → 0.1.8

data/lib/chef/knife/BaseVsphereCommand.rb

@@ -1,167 +1,169 @@
-#
-# Author:: Ezra Pagel (<ezra@cpan.org>)
-# Contributor:: Jesse Campbell (<hikeit@gmail.com>)
-# License:: Apache License, Version 2.0
-#
-
-require 'chef/knife'
-require 'rbvmomi'
-
-# Base class for vsphere knife commands
-class Chef
-	class Knife
-		class BaseVsphereCommand < Knife
-
-			deps do
-				require 'chef/knife/bootstrap'
-				Chef::Knife::Bootstrap.load_deps
-				require 'fog'
-				require 'socket'
-				require 'net/ssh/multi'
-				require 'readline'
-				require 'chef/json_compat'
-			end
-
-
-			def self.get_common_options
-
-				option :vsphere_user,
-					:short => "-u USERNAME",
-					:long => "--user USERNAME",
-					:description => "The username for the host"
-
-				option :vsphere_pass,
-					:short => "-p PASSWORD",
-					:long => "--password PASSWORD",
-					:description => "The password for the host"
-
-				option :datacenter,
-					:short => "-d DATACENTER",
-					:long => "--datacenter DATACENTER",
-					:description => "The Datacenter to create the VM in"
-
-				option :path,
-					:long => "--path SOAP_PATH",
-					:description => "The SOAP endpoint path",
-					:proc => Proc.new { |p| Chef::Config[:knife][:path] = p },
-					:default => "/sdk"
-
-				option :port,
-					:long => "--port PORT",
-					:description => "The VI SDK port number to use",
-					:proc => Proc.new { |p| Chef::Config[:knife][:port] = p },
-					:default => 443
-
-				option :use_ssl,
-					:long => "--ssl USE_SSL",
-					:description => "Whether to use SSL connection",
-					:default => true
-
-				option :insecure,
-					:short => "-i USE_INSECURE_SSL",
-					:long => "--insecure USE_INSECURE_SSL",
-					:description => "Determines whether SSL certificate verification is skipped",
-					:default => true
-
-				option :folder,
-					:short => "-f FOLDER",
-					:long => "--folder FOLDER",
-					:description => "The folder to get VMs from",
-					:default => ''
-
-			end
-
-			def locate_config_value(key)
-				key = key.to_sym
-				Chef::Config[:knife][key] || config[key]
-			end
-
-			def get_vim_connection
-
-				conn_opts = {
-					:host => locate_config_value(:vsphere_host),
-					:path => config[:path],
-					:port => config[:port],
-					:use_ssl => config[:ssl],
-					:user => locate_config_value(:vsphere_user),
-					:password => locate_config_value(:vsphere_pass),
-					:insecure => config[:insecure]
-				}
-
-				#    opt :insecure, "don't verify ssl certificate", :short => 'k', :default => (ENV['RBVMOMI_INSECURE'] == '1')
-				#    opt :debug, "Log SOAP messages", :short => 'd', :default => (ENV['RBVMOMI_DEBUG'] || false)
-
-				vim = RbVmomi::VIM.connect conn_opts
-				config[:vim] = vim
-				return vim
-			end
-
-			def find_folder(folderName)
-				dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
-				dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
-				baseEntity = dc.vmFolder
-				entityArray = folderName.split('/')
-				entityArray.each do |entityArrItem|
-					if entityArrItem != ''
-						baseEntity = baseEntity.childEntity.grep(RbVmomi::VIM::Folder).find { |f| f.name == entityArrItem } or
-              abort "no such folder #{folderName} while looking for #{entityArrItem}"
-					end
-				end
-				baseEntity
-			end
-
-			def find_network(networkName)
-				dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
-				dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
-				baseEntity = dc.network
-				baseEntity.find { |f| f.name == networkName } or abort "no such network #{networkName}"
-			end
-
-			def find_pool(poolName)
-				dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
-				dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
-				baseEntity = dc.hostFolder
-				entityArray = poolName.split('/')
-				entityArray.each do |entityArrItem|
-					if entityArrItem != ''
-						if baseEntity.is_a? RbVmomi::VIM::Folder
-							baseEntity = baseEntity.childEntity.find { |f| f.name == entityArrItem } or
-                abort "no such pool #{poolName} while looking for #{entityArrItem}"
-						elsif baseEntity.is_a? RbVmomi::VIM::ClusterComputeResource
-							baseEntity = baseEntity.resourcePool.resourcePool.find { |f| f.name == entityArrItem } or
-                abort "no such pool #{poolName} while looking for #{entityArrItem}"
-						elsif baseEntity.is_a? RbVmomi::VIM::ResourcePool
-							baseEntity = baseEntity.resourcePool.find { |f| f.name == entityArrItem } or
-                abort "no such pool #{poolName} while looking for #{entityArrItem}"
-						else
-							abort "Unexpected Object type encountered #{baseEntity.type} while finding resourcePool"
-						end
-					end
-				end
-				baseEntity
-			end
-
-			def find_datastore(dsName)
-				dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
-				dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
-				baseEntity = dc.datastore
-				baseEntity.find { |f| f.info.name == dsName } or abort "no such datastore #{dsName}"
-			end
-
-
-			def find_all_in_folder(folder, type)
-				folder.childEntity.grep(type)
-			end
-
-			def find_in_folder(folder, type, name)
-				folder.childEntity.grep(type).find { |o| o.name == name }
-			end
-
-			def fatal_exit(msg)
-				ui.fatal(msg)
-				exit 1
-			end
-
-		end
-	end
-end
+#
+# Author:: Ezra Pagel (<ezra@cpan.org>)
+# Contributor:: Jesse Campbell (<hikeit@gmail.com>)
+# License:: Apache License, Version 2.0
+#
+
+require 'chef/knife'
+require 'rbvmomi'
+
+# Base class for vsphere knife commands
+class Chef
+	class Knife
+		class BaseVsphereCommand < Knife
+
+			deps do
+				require 'chef/knife/bootstrap'
+				Chef::Knife::Bootstrap.load_deps
+				require 'fog'
+				require 'socket'
+				require 'net/ssh/multi'
+				require 'readline'
+				require 'chef/json_compat'
+			end
+
+
+			def self.get_common_options
+
+				option :vsphere_user,
+					:short => "-u USERNAME",
+					:long => "--user USERNAME",
+					:description => "The username for the host"
+
+				option :vsphere_pass,
+					:short => "-p PASSWORD",
+					:long => "--password PASSWORD",
+					:description => "The password for the host"
+
+				option :datacenter,
+					:short => "-d DATACENTER",
+					:long => "--datacenter DATACENTER",
+					:description => "The Datacenter to create the VM in"
+
+				option :path,
+					:long => "--path SOAP_PATH",
+					:description => "The SOAP endpoint path",
+					:proc => Proc.new { |p| Chef::Config[:knife][:path] = p },
+					:default => "/sdk"
+
+				option :port,
+					:long => "--port PORT",
+					:description => "The VI SDK port number to use",
+					:proc => Proc.new { |p| Chef::Config[:knife][:port] = p },
+					:default => 443
+
+				option :use_ssl,
+					:long => "--ssl USE_SSL",
+					:description => "Whether to use SSL connection",
+					:default => true
+
+				option :insecure,
+					:short => "-i USE_INSECURE_SSL",
+					:long => "--insecure USE_INSECURE_SSL",
+					:description => "Determines whether SSL certificate verification is skipped",
+					:default => true
+
+				option :folder,
+					:short => "-f FOLDER",
+					:long => "--folder FOLDER",
+					:description => "The folder to get VMs from",
+					:default => ''
+
+			end
+
+			def locate_config_value(key)
+				key = key.to_sym
+				Chef::Config[:knife][key] || config[key]
+			end
+
+			def get_vim_connection
+
+				conn_opts = {
+					:host => locate_config_value(:vsphere_host),
+					:path => config[:path],
+					:port => config[:port],
+					:use_ssl => config[:ssl],
+					:user => locate_config_value(:vsphere_user),
+					:password => locate_config_value(:vsphere_pass),
+					:insecure => config[:insecure]
+				}
+
+				#    opt :insecure, "don't verify ssl certificate", :short => 'k', :default => (ENV['RBVMOMI_INSECURE'] == '1')
+				#    opt :debug, "Log SOAP messages", :short => 'd', :default => (ENV['RBVMOMI_DEBUG'] || false)
+
+				vim = RbVmomi::VIM.connect conn_opts
+				config[:vim] = vim
+				return vim
+			end
+
+			def find_folder(folderName)
+				dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
+				dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+				baseEntity = dc.vmFolder
+				entityArray = folderName.split('/')
+				entityArray.each do |entityArrItem|
+					if entityArrItem != ''
+						baseEntity = baseEntity.childEntity.grep(RbVmomi::VIM::Folder).find { |f| f.name == entityArrItem } or
+              abort "no such folder #{folderName} while looking for #{entityArrItem}"
+					end
+				end
+				baseEntity
+			end
+
+			def find_network(networkName)
+				dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
+				dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+				baseEntity = dc.network
+				baseEntity.find { |f| f.name == networkName } or abort "no such network #{networkName}"
+			end
+
+			def find_pool(poolName)
+				dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
+				dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+				baseEntity = dc.hostFolder
+				entityArray = poolName.split('/')
+				entityArray.each do |entityArrItem|
+					if entityArrItem != ''
+						if baseEntity.is_a? RbVmomi::VIM::Folder
+							baseEntity = baseEntity.childEntity.find { |f| f.name == entityArrItem } or
+                abort "no such pool #{poolName} while looking for #{entityArrItem}"
+						elsif baseEntity.is_a? RbVmomi::VIM::ClusterComputeResource
+							baseEntity = baseEntity.resourcePool.resourcePool.find { |f| f.name == entityArrItem } or
+                abort "no such pool #{poolName} while looking for #{entityArrItem}"
+						elsif baseEntity.is_a? RbVmomi::VIM::ResourcePool
+							baseEntity = baseEntity.resourcePool.find { |f| f.name == entityArrItem } or
+                abort "no such pool #{poolName} while looking for #{entityArrItem}"
+						else
+							abort "Unexpected Object type encountered #{baseEntity.type} while finding resourcePool"
+						end
+					end
+				end
+
+        baseEntity = baseEntity.resourcePool if not baseEntity.is_a?(RbVmomi::VIM::ResourcePool) and baseEntity.respond_to?(:resourcePool)
+        baseEntity
+			end
+
+			def find_datastore(dsName)
+				dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
+				dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+				baseEntity = dc.datastore
+				baseEntity.find { |f| f.info.name == dsName } or abort "no such datastore #{dsName}"
+			end
+
+
+			def find_all_in_folder(folder, type)
+				folder.childEntity.grep(type)
+			end
+
+			def find_in_folder(folder, type, name)
+				folder.childEntity.grep(type).find { |o| o.name == name }
+			end
+
+			def fatal_exit(msg)
+				ui.fatal(msg)
+				exit 1
+			end
+
+		end
+	end
+end

data/lib/chef/knife/vsphere_customization_list.rb

@@ -1,29 +1,29 @@
-#
-# Author:: Ezra Pagel (<ezra@cpan.org>)
-# License:: Apache License, Version 2.0
-#
-require 'chef/knife'
-require 'chef/knife/BaseVsphereCommand'
-
-# 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/BaseVsphereCommand'
+
+# 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
+

data/lib/chef/knife/vsphere_datastore_list.rb

@@ -0,0 +1,58 @@
+# 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/BaseVsphereCommand'
+
+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
+  def run
+    $stdout.sync = true
+    
+    vim = get_vim_connection
+    dcname = config[:vsphere_dc] || Chef::Config[:knife][:vsphere_dc]
+    dc = config[:vim].serviceInstance.find_datacenter(dcname) or abort "datacenter not found"
+    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})"
+    end
+  end
+end
+