knife-vsphere 2.1.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5a38302a790751f683b4e650f7bf7bb8425409b2
-  data.tar.gz: 2c4f53befb4b733af86250addfcd844f417df1be
+SHA256:
+  metadata.gz: e528b518f61a2b89add76550ea53e352456f4beba7353b7347daba3bf0e19cad
+  data.tar.gz: d3ce8d781c6978dda58408f8221c61f6e609d2679186d1dc15092b9f8738cbac
 SHA512:
-  metadata.gz: 8fc957ac456c865811d93ea7b6e9ce6006b85e26ab710a21e8cd0ac31e6e39e5665c55a1b6ac1f1e78076cff52ea79c8863460e4f04d6df7c7bdb68f07a8ebd4
-  data.tar.gz: a51ce26b8a3e093dae4a11e82627fccfffa906b8c2fbef53aa935e29fbdb2cdb8dadd8830d1336e3e14b59f2d0dbe3d2b4c64bcc248452bd88eb468b9a14ac74
+  metadata.gz: 84c58eb0029c57b8cb583924b41ad7e4f5c51b9f7ff23f4e19380d1cc24d23f29a059319744a44cc54b451e6b84bf1fb14bf00a779b9ccc4fd948b7f77cf5724
+  data.tar.gz: 532c60b0f873d716f29ee2c256589c5a54f5e3f0fbf9486a793f40756decdfb9684c6329b9d8af762639d37e4f8c6473b3c923838d3f1e535b502ee722e88290

data/lib/chef/knife/base_vsphere_command.rb

@@ -4,17 +4,17 @@
 # License:: Apache License, Version 2.0
 #
 
-require 'chef/knife'
-require 'rbvmomi'
-require 'base64'
-require 'filesize'
+require "chef/knife"
+require "rbvmomi"
+require "base64"
+require "filesize"
 
 # Power state on
-PS_ON ||= 'poweredOn'.freeze
+PS_ON ||= "poweredOn".freeze
 # Power state off
-PS_OFF ||= 'poweredOff'.freeze
+PS_OFF ||= "poweredOff".freeze
 # Power state suspended
-PS_SUSPENDED ||= 'suspended'.freeze
+PS_SUSPENDED ||= "suspended".freeze
 
 # Base class for vsphere knife commands
 class Chef
@@ -23,66 +23,65 @@ class Chef
     # Main knife vsphere that more or less everything in this gem is built off of
     class BaseVsphereCommand < Knife
       deps do
-        require 'chef/knife/bootstrap'
+        require "chef/knife/bootstrap"
         Chef::Knife::Bootstrap.load_deps
-        require 'fog'
-        require 'socket'
-        require 'net/ssh/multi'
-        require 'readline'
-        require 'chef/json_compat'
+        require "socket"
+        require "net/ssh/multi"
+        require "readline"
+        require "chef/json_compat"
       end
 
       def self.common_options
         option :vsphere_user,
-               short: '-u USERNAME',
-               long: '--vsuser USERNAME',
-               description: 'The username for vsphere'
+               short: "-u USERNAME",
+               long: "--vsuser USERNAME",
+               description: "The username for vsphere"
 
         option :vsphere_pass,
-               short: '-p PASSWORD',
-               long: '--vspass PASSWORD',
-               description: 'The password for vsphere'
+               short: "-p PASSWORD",
+               long: "--vspass PASSWORD",
+               description: "The password for vsphere"
 
         option :vsphere_host,
-               long: '--vshost HOST',
-               description: 'The vsphere host'
+               long: "--vshost HOST",
+               description: "The vsphere host"
 
         option :vsphere_dc,
-               short: '-D DATACENTER',
-               long: '--vsdc DATACENTER',
-               description: 'The Datacenter for vsphere'
+               short: "-D DATACENTER",
+               long: "--vsdc DATACENTER",
+               description: "The Datacenter for vsphere"
 
         option :vsphere_path,
-               long: '--vspath SOAP_PATH',
-               description: 'The vsphere SOAP endpoint path',
-               default: '/sdk'
+               long: "--vspath SOAP_PATH",
+               description: "The vsphere SOAP endpoint path",
+               default: "/sdk"
 
         option :vsphere_port,
-               long: '--vsport PORT',
-               description: 'The VI SDK port number to use',
-               default: '443'
+               long: "--vsport PORT",
+               description: "The VI SDK port number to use",
+               default: "443"
 
         option :vsphere_nossl,
-               long: '--vsnossl',
-               description: 'Disable SSL connectivity'
+               long: "--vsnossl",
+               description: "Disable SSL connectivity"
 
         option :vsphere_insecure,
-               long: '--vsinsecure',
-               description: 'Disable SSL certificate verification'
+               long: "--vsinsecure",
+               description: "Disable SSL certificate verification"
 
         option :folder,
-               short: '-f FOLDER',
-               long: '--folder FOLDER',
-               description: 'The folder to get VMs from',
-               default: ''
+               short: "-f FOLDER",
+               long: "--folder FOLDER",
+               description: "The folder to get VMs from",
+               default: ""
 
         option :proxy_host,
-               long: '--proxyhost PROXY_HOSTNAME',
-               description: 'Proxy hostname'
+               long: "--proxyhost PROXY_HOSTNAME",
+               description: "Proxy hostname"
 
         option :proxy_port,
-               long: '--proxyport PROXY_PORT',
-               description: 'Proxy port'
+               long: "--proxyport PROXY_PORT",
+               description: "Proxy port"
       end
 
       def get_config(key)
@@ -97,7 +96,7 @@ class Chef
           # Password is not in the config file - grab it
           # from the command line
           get_password_from_stdin
-        elsif get_config(:vsphere_pass).start_with?('base64:')
+        elsif get_config(:vsphere_pass).start_with?("base64:")
           Base64.decode64(get_config(:vsphere_pass)[7..-1]).chomp
         else
           get_config(:vsphere_pass)
@@ -114,7 +113,7 @@ class Chef
           password: password,
           insecure: get_config(:vsphere_insecure),
           proxyHost: get_config(:proxy_host),
-          proxyPort: get_config(:proxy_port)
+          proxyPort: get_config(:proxy_port),
         }
       end
 
@@ -123,7 +122,7 @@ class Chef
       end
 
       def get_password_from_stdin
-        @password ||= ui.ask('Enter your password: ') { |q| q.echo = false }
+        @password ||= ui.ask("Enter your password: ") { |q| q.echo = false }
       end
 
       def traverse_folders_for_pools(folder)
@@ -174,17 +173,17 @@ class Chef
 
       def datacenter
         dcname = get_config(:vsphere_dc)
-        traverse_folders_for_dc(vim_connection.rootFolder, dcname) || abort('datacenter not found')
+        traverse_folders_for_dc(vim_connection.rootFolder, dcname) || abort("datacenter not found")
       end
 
       def find_folder(folderName)
         dc = datacenter
         base_entity = dc.vmFolder
-        entity_array = folderName.split('/')
+        entity_array = folderName.split("/")
         entity_array.each do |entityArrItem|
-          if entityArrItem != ''
+          if entityArrItem != ""
             base_entity = base_entity.childEntity.grep(RbVmomi::VIM::Folder).find { |f| f.name == entityArrItem } ||
-                          abort("no such folder #{folderName} while looking for #{entityArrItem}")
+              abort("no such folder #{folderName} while looking for #{entityArrItem}")
           end
         end
         base_entity
@@ -197,7 +196,7 @@ class Chef
         networks = base_entity.select { |f| f.name == networkName }
         abort("no such network #{networkName}") if networks.empty?
 
-        if dvswitch && dvswitch != 'auto'
+        if dvswitch && dvswitch != "auto"
           return networks.find do |f|
             next unless f.respond_to?(:config)
             sw = f.config.distributedVirtualSwitch
@@ -211,11 +210,11 @@ class Chef
       def find_pool_folder(folderName)
         dc = datacenter
         base_entity = dc.hostFolder
-        entity_array = folderName.split('/')
+        entity_array = folderName.split("/")
         entity_array.each do |entityArrItem|
-          if 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}")
+              abort("no such folder #{folderName} while looking for #{entityArrItem}")
           end
         end
         base_entity
@@ -224,18 +223,18 @@ class Chef
       def find_pool(poolName)
         dc = datacenter
         base_entity = dc.hostFolder
-        entity_array = poolName.split('/')
+        entity_array = poolName.split("/")
         entity_array.each do |entityArrItem|
-          next if entityArrItem == ''
+          next if entityArrItem == ""
           if base_entity.is_a? RbVmomi::VIM::Folder
             base_entity = base_entity.childEntity.find { |f| f.name == entityArrItem } ||
-                          abort("no such pool #{poolName} while looking for #{entityArrItem}")
+              abort("no such pool #{poolName} while looking for #{entityArrItem}")
           elsif base_entity.is_a?(RbVmomi::VIM::ClusterComputeResource) || base_entity.is_a?(RbVmomi::VIM::ComputeResource)
             base_entity = base_entity.resourcePool.resourcePool.find { |f| f.name == entityArrItem } ||
-                          abort("no such pool #{poolName} while looking for #{entityArrItem}")
+              abort("no such pool #{poolName} while looking for #{entityArrItem}")
           elsif base_entity.is_a? RbVmomi::VIM::ResourcePool
             base_entity = base_entity.resourcePool.find { |f| f.name == entityArrItem } ||
-                          abort("no such pool #{poolName} while looking for #{entityArrItem}")
+              abort("no such pool #{poolName} while looking for #{entityArrItem}")
           else
             abort "Unexpected Object type encountered #{base_entity.type} while finding resourcePool"
           end
@@ -266,7 +265,7 @@ class Chef
         if candidates.length > 0
           vmdk_datastore = candidates[0]
         else
-          puts 'Insufficient space on all LUNs designated or assigned to the virtual machine. Please specify a new target.'
+          puts "Insufficient space on all LUNs designated or assigned to the virtual machine. Please specify a new target."
           vmdk_datastore = nil
         end
         vmdk_datastore
@@ -278,7 +277,7 @@ class Chef
         dc = datacenter
         base_entity = dc.datastore
         base_entity.each do |ds|
-          stores.push ds if ds.name.match(/#{regex}/)
+          stores.push ds if ds.name =~ /#{regex}/
         end
         stores
       end
@@ -295,10 +294,10 @@ class Chef
           folder = dc.datastoreFolder
         end
         folder.childEntity.each do |child|
-          if child.class.to_s == 'Folder'
+          if child.class.to_s == "Folder"
             ds = find_datastorecluster(dsName, child)
             return ds if ds
-          elsif child.class.to_s == 'StoragePod' && child.name == dsName
+          elsif child.class.to_s == "StoragePod" && child.name == dsName
             return child
           end
         end
@@ -307,7 +306,7 @@ class Chef
 
       def number_to_human_size(number)
         number = number.to_f
-        storage_units_fmt = %w(byte kB MB GB TB)
+        storage_units_fmt = %w{byte kB MB GB TB}
         base = 1024
         if number.to_i < base
           unit = storage_units_fmt[0]
@@ -319,7 +318,7 @@ class Chef
           unit = storage_units_fmt[exponent]
         end
 
-        format('%0.2f %s', number, unit)
+        format("%0.2f %s", number, unit)
       end
 
       def find_device(vm, deviceName)
@@ -346,9 +345,9 @@ class Chef
       def get_path_to_object(object)
         if object.is_a?(RbVmomi::VIM:: ManagedEntity)
           if object.parent.is_a?(RbVmomi::VIM:: ManagedEntity)
-            return get_path_to_object(object.parent) + '/' + object.parent.name
+            get_path_to_object(object.parent) + "/" + object.parent.name
           else
-            return ''
+            ""
           end
         else
           puts "Unknown type #{object.class}, not enumerating"
@@ -398,8 +397,8 @@ class Chef
       end
 
       def windows?(config)
-        is_win_bool = config.guestId.downcase.include?('windows')
-        Chef::Log.debug('Identified os as windows.') if is_win_bool
+        is_win_bool = config.guestId.downcase.include?("windows")
+        Chef::Log.debug("Identified os as windows.") if is_win_bool
         is_win_bool
       end
 
@@ -407,8 +406,8 @@ class Chef
         gid = config.guestId.downcase
         # This makes the assumption that if it isn't mac or windows it's linux
         # See https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for values
-        is_linux_bool = !gid.include?('windows') && !gid.include?('darwin')
-        Chef::Log.debug('Identified os as linux.') if is_linux_bool
+        is_linux_bool = !gid.include?("windows") && !gid.include?("darwin")
+        Chef::Log.debug("Identified os as linux.") if is_linux_bool
         is_linux_bool
       end
     end

data/lib/chef/knife/customization_helper.rb

@@ -3,7 +3,7 @@
 # License:: Apache License, Version 2.0
 #
 
-require 'rbvmomi'
+require "rbvmomi"
 
 # The Customization helper for sysprep
 module CustomizationHelper
@@ -19,7 +19,7 @@ module CustomizationHelper
     wait = true
     waited_seconds = 0
 
-    print 'Waiting for sysprep...'
+    print "Waiting for sysprep..."
     while wait
       events = query_customization_succeeded(vm, vem)
 
@@ -31,7 +31,7 @@ module CustomizationHelper
       elsif waited_seconds >= timeout
         abort "\nCustomization of VM #{vm.name} not succeeded within #{timeout} seconds."
       else
-        print '.'
+        print "."
         sleep(sleep_time)
         waited_seconds += sleep_time
       end
@@ -46,6 +46,6 @@ module CustomizationHelper
     vem.QueryEvents(filter:
         RbVmomi::VIM::EventFilterSpec(entity:
         RbVmomi::VIM::EventFilterSpecByEntity(entity: vm, recursion:
-        RbVmomi::VIM::EventFilterSpecRecursionOption(:self)), eventTypeId: ['CustomizationSucceeded']))
+        RbVmomi::VIM::EventFilterSpecRecursionOption(:self)), eventTypeId: ["CustomizationSucceeded"]))
   end
 end

data/lib/chef/knife/search_helper.rb

@@ -7,6 +7,10 @@ module SearchHelper
   # param [Array<String>] properties to retrieve
   # @return [Array<RbVmomi::VIM::ObjectContent>]
   def get_all_vm_objects(opts = {})
+    get_all_objects(opts.merge(type: "VirtualMachine"))
+  end
+
+  def get_all_objects(opts = {})
     pc = vim_connection.serviceInstance.content.propertyCollector
     viewmgr = vim_connection.serviceInstance.content.viewManager
     folder = if opts[:folder]
@@ -15,10 +19,10 @@ module SearchHelper
                vim_connection.serviceInstance.content.rootFolder
              end
     vmview = viewmgr.CreateContainerView(container: folder,
-                                         type: ['VirtualMachine'],
+                                         type: [opts[:type]],
                                          recursive: true)
 
-    opts[:properties] ||= ['name']
+    opts[:properties] ||= ["name"]
 
     filter_spec = RbVmomi::VIM.PropertyFilterSpec(
       objectSet: [
@@ -26,22 +30,27 @@ module SearchHelper
         skip: true,
         selectSet: [
           RbVmomi::VIM.TraversalSpec(
-            name: 'traverseEntities',
-            type: 'ContainerView',
-            path: 'view',
+            name: "traverseEntities",
+            type: "ContainerView",
+            path: "view",
             skip: false
           )
         ]
       ],
       propSet: [
-        { type: 'VirtualMachine', pathSet: opts[:properties] }
+        { type: opts[:type], pathSet: opts[:properties] }
       ]
     )
     pc.RetrieveProperties(specSet: [filter_spec])
   end
 
   def get_vm_by_name(vmname, folder = nil)
-    vm = get_all_vm_objects(folder: folder).detect { |r| r['name'] == vmname }
+    vm = get_all_vm_objects(folder: folder).detect { |r| r["name"] == vmname }
     vm ? vm.obj : nil
   end
+
+  def get_vm_host_by_name(name, folder = nil)
+    host = get_all_objects(type: "HostSystem", folder: folder).detect { |r| r["name"] == name }
+    host ? host.obj : nil
+  end
 end

data/lib/chef/knife/vsphere_cluster_list.rb

@@ -3,12 +3,12 @@
 # Contributor:: Dennis Pattmann (https://github.com/DennisBP)
 # License:: Apache License, Version 2.0
 #
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
+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'
+  banner "knife vsphere cluster list"
 
   common_options
 
@@ -16,8 +16,8 @@ class Chef::Knife::VsphereClusterList < Chef::Knife::BaseVsphereCommand
     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' }
-      return { 'Cluster' => clusters.map(&:last).join('/') }
+      clusters = folder.path[3..-1].reject { |p| p.last == "ClusterComputeResource" }
+      return { "Cluster" => clusters.map(&:last).join("/") }
     end
 
     folders = find_all_in_folder(folder, RbVmomi::VIM::ManagedObject) || []
@@ -29,11 +29,11 @@ class Chef::Knife::VsphereClusterList < Chef::Knife::BaseVsphereCommand
   def find_cluster_folder(folderName)
     dc = datacenter
     base_entity = dc.hostFolder
-    entity_array = folderName.split('/')
+    entity_array = folderName.split("/")
     entity_array.each do |entityArrItem|
-      if 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}")
+          abort("no such folder #{folderName} while looking for #{entityArrItem}")
       end
     end
     base_entity

data/lib/chef/knife/vsphere_cpu_ratio.rb

@@ -1,9 +1,9 @@
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
+require "chef/knife"
+require "chef/knife/base_vsphere_command"
 
 # VsphereCpuratio extends the BaseVspherecommand
 class Chef::Knife::VsphereCpuRatio < Chef::Knife::BaseVsphereCommand
-  banner 'knife vsphere cpu ratio [CLUSTER] [HOST]'
+  banner "knife vsphere cpu ratio [CLUSTER] [HOST]"
 
   common_options
 
@@ -38,7 +38,7 @@ class Chef::Knife::VsphereCpuRatio < Chef::Knife::BaseVsphereCommand
 
         puts "#{h.name}: #{ratio}"
       end
-      puts ''
+      puts ""
     end
   end
 end