knife-vsphere 2.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb16b64d53791bd6e96ba472a5567de9c8f16cf2
-  data.tar.gz: 6da5cf9fe415bba0e43e48ecf6b70e084152dde1
+  metadata.gz: 28d327261e11658b4d6f926e93b136a1c4979e55
+  data.tar.gz: 4c0499b076d8197ccdbd44f9aba9834989e65743
 SHA512:
-  metadata.gz: 29a121097a149a4f65a477e25e81a8a5050f30211a34819453bd9ee40f919b5173c6fd42f96ffc23804c5530e1ec79a18f8453eac427e3146d4b6db654fd586c
-  data.tar.gz: 54c0d812429c81c78961c7e3cdda47c713fa175e53304289831c1fb8105f5132a7bcdb7a57e4648519d53daae996812c556c2b944c3c7ea6d7e7b72726d2b069
+  metadata.gz: dfdd72ab2858dc5ae00bc8e688c737562a68eb65e52a34e004629a7d7b40a1acb3776dc061c16cfc6699b788ea2f9c66c222af7608b8f3f174cee4fc0de775c1
+  data.tar.gz: 11f6c48d15e56559a0b6181d9e6506ae0c7d77ad9eec8f70dacbfaf4ab4103d31d18c8551c8a0c468097573c1e1fc4dcad753cded01d84a86a898b94e46a8e26

data/lib/chef/knife/vsphere_vm_cdrom.rb

@@ -64,7 +64,7 @@ class Chef::Knife::VsphereVmCdrom < Chef::Knife::BaseVsphereCommand
     fatal_exit 'You must specify the name and path of an ISO with --iso' if get_config(:attach) && !get_config(:iso)
     fatal_exit 'You must specify the datastore containing the ISO with --datastore' if get_config(:attach) && !get_config(:datastore)
 
-    vm = get_vm_by_name(vmname, config[:folder]) || fatal_exit("Could not find #{vmname}")
+    vm = get_vm_by_name(vmname, get_config(:folder)) || fatal_exit("Could not find #{vmname}")
 
     cdrom_obj = vm.config.hardware.device.find { |hw| hw.class == RbVmomi::VIM::VirtualCdrom }
     fatal_exit 'Could not find a cd drive' unless cdrom_obj

data/lib/chef/knife/vsphere_vm_clone.rb

@@ -8,12 +8,12 @@
 
 require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-require 'netaddr'
-require 'securerandom'
-require 'chef/knife/winrm_base'
 require 'chef/knife/customization_helper'
+require 'chef/knife/search_helper'
+require 'chef/knife/winrm_base'
 require 'ipaddr'
+require 'netaddr'
+require 'securerandom'
 
 # VsphereVmClone extends the BaseVspherecommand
 class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
@@ -28,6 +28,7 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
 
   include Chef::Knife::WinrmBase
   include CustomizationHelper
+  include SearchHelper
   deps do
     require 'chef/json_compat'
     require 'chef/knife/bootstrap'
@@ -351,17 +352,13 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
     end
 
     config[:chef_node_name] = vmname unless get_config(:chef_node_name)
-    config[:vmname] = vmname
 
     vim = vim_connection
     vim.serviceContent.virtualDiskManager
 
     dc = datacenter
 
-    src_folder = find_folder(get_config(:folder)) || dc.vmFolder
-
-    src_vm = find_in_folder(src_folder, RbVmomi::VIM::VirtualMachine, config[:source_vm]) ||
-             abort('VM/Template not found')
+    src_vm = get_vm_by_name(get_config(:source_vm), get_config(:folder)) || fatal_exit("Could not find template #{vmname}")
 
     create_delta_disk(src_vm) if get_config(:linked_clone)
 
@@ -372,7 +369,7 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
     dest_folder = cust_folder.nil? ? src_vm.vmFolder : find_folder(cust_folder)
 
     task = src_vm.CloneVM_Task(folder: dest_folder, name: vmname, spec: clone_spec)
-    puts "Cloning template #{config[:source_vm]} to new VM #{vmname}"
+    puts "Cloning template #{get_config(:source_vm)} to new VM #{vmname}"
 
     pp clone_spec if log_verbose?
 
@@ -398,8 +395,7 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
 
     return if get_config(:mark_as_template)
     if get_config(:power) || get_config(:bootstrap)
-      vm = find_in_folder(dest_folder, RbVmomi::VIM::VirtualMachine, vmname) ||
-           fatal_exit("VM #{vmname} not found")
+      vm = get_vm_by_name(vmname, cust_folder) || fatal_exit("VM #{vmname} not found")
       begin
         vm.PowerOnVM_Task.wait_for_completion
       rescue RbVmomi::Fault => e
@@ -704,7 +700,7 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
 
     # TODO: How could we not take this? Only if the identity were empty, but that's statically defined as empty above
     if use_ident
-      hostname = config[:customization_hostname] || config[:vmname]
+      hostname = config[:customization_hostname] || vmname
 
       if windows?(src_config)
         # We should get here with the customizations set, either by a plugin or a --cspec

data/lib/chef/knife/vsphere_vm_find.rb

@@ -1,24 +1,26 @@
-#
 # Author:: Raducu Deaconu (<rhadoo_io@yahoo.com>)
 # License:: Apache License, Version 2.0
 #
 
 require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
-require 'rbvmomi'
-require 'netaddr'
+require 'chef/knife/search_helper'
 
 # find vms belonging to pool that match criteria, display specified fields
 class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
+  include SearchHelper
   banner 'knife vsphere vm find'
 
+  VMFOLDER = 'vm'.freeze
+
   common_options
 
+  # Deprecating
   option :pool,
          long: '--pool pool',
          short: '-h',
          description: 'Target pool'
-
+  # Deprecating
   option :poolpath,
          long: '--pool-path',
          description: 'Pool is full-path'
@@ -55,10 +57,6 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
          long: '--ip',
          description: 'Show primary ip'
 
-  option :ips,
-         long: '--ips',
-         description: 'Show all ips, with networks - DEPRECATED use --networks'
-
   option :networks,
          long: '--networks',
          description: 'Show all networks with their IPs'
@@ -83,6 +81,10 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
          long: '--match-name VMNAME',
          description: 'match name'
 
+  option :matchtools,
+         long: '--match-tools TOOLSSTATE',
+         description: 'match tools state'
+
   option :hostname,
          long: '--hostname',
          description: 'show hostname of the guest'
@@ -103,189 +105,145 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
          long: '--tools',
          description: 'show tools status'
 
-  option :matchtools,
-         long: '--match-tools TOOLSSTATE',
-         description: 'match tools state'
-
   option :full_path,
          long: '--full-path',
-         description: 'Show full path'
+         description: 'Show full folder path to the VM'
 
-  $stdout.sync = true # smoother output from print
+  option :short_path,
+         long: '--short-path',
+         description: 'Show the VM\'s enclosing folder name'
 
-  # Find the given pool or compute resource
-  # @param folder [RbVmomi::VIM::Folder] the folder from which to start the search, most likely dc.hostFolder
-  # @param objectname [String] name of the object (pool or cluster/compute) to find
-  # @return [RbVmomi::VIM::ClusterComputeResource, RbVmomi::VIM::ComputeResource, RbVmomi::VIM::ResourcePool]
-  def traverse_folders_for_pool_clustercompute(folder, objectname)
-    children = find_all_in_folder(folder, RbVmomi::VIM::ManagedObject)
-    children.each do |child|
-      next unless child.class == RbVmomi::VIM::ClusterComputeResource || child.class == RbVmomi::VIM::ComputeResource || child.class == RbVmomi::VIM::ResourcePool
-      if child.name == objectname
-        return child
-      elsif child.class == RbVmomi::VIM::Folder || child.class == RbVmomi::VIM::ComputeResource || child.class == RbVmomi::VIM::ClusterComputeResource || child.class == RbVmomi::VIM::ResourcePool
-        pool = traverse_folders_for_pool_clustercompute(child, objectname)
-      end
-      return pool if pool
-    end
-    false
-  end
+  $stdout.sync = true # smoother output from print
 
   # Main entry point to the command
   def run
-    poolname = config[:pool]
-    if poolname.nil?
-      show_usage
-      fatal_exit('You must specify a resource pool or cluster name (see knife vsphere pool list)')
-    end
-
-    abort '--ips has been removed. Please use --networks' if get_config(:ips)
-
-    vim_connection
-    dc = datacenter
-    folder = dc.hostFolder
-    pool = if get_config(:poolpath)
-             find_pool(poolname) || abort("Pool #{poolname} not found")
-           else
-             traverse_folders_for_pool_clustercompute(folder, poolname) || abort("Pool #{poolname} not found")
-           end
-    vm_list = if pool.class == RbVmomi::VIM::ResourcePool
-                pool.vm
-              else
-                pool.resourcePool.vm
-              end
-
-    return if vm_list.nil?
-
-    output = vm_list.map do |vm|
-      thisvm = {}
-      if get_config(:matchname)
-        next unless vm.name.include? config[:matchname]
-      end
-
-      if get_config(:matchtools)
-        next unless vm.guest.toolsStatus == config[:matchtools]
-      end
-
-      power_state = vm.runtime.powerState
-
-      thisvm['state'] = case power_state
-                        when PS_ON
-                          'on'
-                        when PS_OFF
-                          'off'
-                        when PS_SUSPENDED
-                          'suspended'
-                        end
-
-
-      next if get_config(:soff) && (power_state == PS_ON)
-
-      next if get_config(:son) && (power_state == PS_OFF)
-
-      if get_config(:matchip)
-        if !vm.guest.ipAddress.nil? && vm.guest.ipAddress != ''
-          next unless vm.guest.ipAddress.include? config[:matchip]
-        else
-          next
-        end
-      end
-
-      unless vm.guest.guestFullName.nil?
-        if get_config(:matchos)
-          next unless vm.guest.guestFullName.include? config[:matchos]
+    property_map('name' => 'name')
+    property_map('runtime.powerState' => 'state') { |value| state_to_english(value) }
+
+    property_map('config.cpuHotAddEnabled' => 'cpu_hot_add_enabled') if get_config(:cpu_hot_add_enabled)
+    property_map('config.memoryHotAddEnabled' => 'memory_hot_add_enabled') if get_config(:memory_hot_add_enabled)
+    property_map('guest.guestFullName' => 'os') if get_config(:matchos) || get_config(:os)
+    property_map('guest.hostName' => 'hostname') if get_config(:hostname)
+    property_map('guest.ipAddress' => 'ip') if get_config(:matchip) || get_config(:ip)
+    property_map('guest.toolsStatus' => 'tools') if get_config(:matchtools) || get_config(:tools)
+    property_map('summary.config.memorySizeMB' => 'ram') if get_config(:ram)
+    property_map('summary.config.numCpu' => 'cpu') if get_config(:cpu)
+    property_map('summary.overallStatus' => 'alarms') if get_config(:alarms)
+    property_map('summary.runtime.host' => 'host_name', &:name) if get_config(:host_name)
+
+    # TODO: https://www.vmware.com/support/developer/converter-sdk/conv55_apireference/vim.VirtualMachine.html#field_detail says this is deprecated
+    property_map('layout.disk' => 'esx_disk') { |disks| disks.map(&:diskFile) } if get_config(:esx_disk)
+    property_map('snapshot.rootSnapshotList' => 'snapshots') { |snapshots| Array(snapshots).map(&:name) } if get_config(:snapshots)
+
+    if get_config(:networks)
+      property_map('guest.net' => 'networks') do |nets|
+        ipregex = /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$/
+        nets.map do |net|
+          firstip = net.ipConfig.ipAddress.first { |i| i.ipAddress[ipregex] }
+          { 'name' => net.network, 'ip' => firstip.ipAddress, 'prefix' => firstip.prefixLength }
         end
       end
+    end
 
-      thisvm['name'] = vm.name
-      if get_config(:hostname)
-        thisvm['hostname'] = vm.guest.hostName
-      end
-      if get_config(:host_name)
-        # TODO: Why vm.summary.runtime vs vm.runtime?
-        thisvm['host_name'] = vm.summary.runtime.host.name
-      end
-
-      if get_config(:full_path)
-        fullpath = ''
-        iterator = vm
-
-        while iterator = iterator.parent
-          break if iterator.name == 'vm'
-          fullpath = fullpath.empty? ? iterator.name : "#{iterator.name}/#{fullpath}"
+    if get_config(:os_disk)
+      property_map('guest.disk' => 'disks') do |disks|
+        disks.map do |disk|
+          { 'name' => disk.diskPath,
+            'capacity' => disk.capacity / 1024 / 1024,
+            'free' => disk.freeSpace / 1024 / 1024 }
         end
-        thisvm['folder'] = fullpath
-      else
-        thisvm['folder'] = vm.parent.name
       end
+    end
 
-      if get_config(:ip)
-        thisvm['ip'] = vm.guest.ipAddress
+    output = matched_vms.map do |vm|
+      thisvm = {}
+      @output_pairs.each do |property, out_key|
+        thisvm[out_key] = if @blocks[out_key]
+                            @blocks[out_key].call(vm[property])
+                          else
+                            vm[property]
+                          end
       end
 
-      if get_config(:networks)
-        ipregex = /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$/
-        thisvm['networks'] = vm.guest.net.map do |net|
-          firstip = net.ipConfig.ipAddress.first { |i| i.ipAddress[ipregex] }
+      thisvm['folder'] = full_path_to(vm) if get_config(:full_path)
+      thisvm['folder'] = vm.obj.parent.name if get_config(:short_path)
 
-          { 'name' => net.network,
-            'ip' => firstip.ipAddress,
-            'prefix' => firstip.prefixLength
-          }
-        end
-      end
+      thisvm
+    end
+    ui.output(output.compact)
+  end
 
-      if get_config(:os)
-        thisvm['os'] = vm.guest.guestFullName
-      end
+  private
+
+  # property_map sets up the things we'll ask from vmware, and how they'll be displayed
+  # If it's passed a Hash then we'll request the key from vmware and the output will appear
+  # in the item specified by key.
+  # If you pass a block, then the result from vsphere will be passed to the block and that value used instead
+  def property_map(property_pair, &block)
+    @properties ||= []
+    @output_pairs ||= {}
+    @blocks ||= {}
+
+    (prop, out_key) = property_pair.first
+    @properties << prop
+    @output_pairs[prop] = out_key
+    @blocks[out_key] = block if block
+  end
 
-      if get_config(:ram)
-        thisvm['ram'] = vm.summary.config.memorySizeMB
-      end
+  def matched_vms
+    get_all_vm_objects(properties: @properties).select { |vm| match_vm? vm }
+  end
 
-      if get_config(:cpu_hot_add_enabled)
-        thisvm['cpu_hot_add_enabled'] = vm.config.cpuHotAddEnabled
-      end
+  def match_vm?(vm)
+    match_name?(vm['name']) &&
+      match_tools?(vm['guest.toolsStatus']) &&
+      match_power_state?(vm['runtime.powerState']) &&
+      match_ip?(vm['guest.ipAddress']) &&
+      match_os?(vm['guest.guestFullName'])
+  end
 
-      if get_config(:memory_hot_add_enabled)
-        thisvm['memory_hot_add_enabled'] = vm.config.memoryHotAddEnabled
-      end
+  def match_name?(name)
+    !get_config(:matchname) || name.include?(get_config(:matchname))
+  end
 
-      if get_config(:cpu)
-        thisvm['cpu'] = vm.summary.config.numCpu
-      end
+  def match_tools?(tools)
+    !get_config(:matchtools) || tools == get_config(:matchtools)
+  end
 
-      if get_config(:alarms)
-        thisvm['alarms'] = vm.summary.overallStatus
-      end
+  def match_power_state?(power_state)
+    !(get_config(:son) || get_config(:soff)) ||
+      get_config(:son) && power_state == PS_ON ||
+      get_config(:soff) && power_state == PS_OFF
+  end
 
-      if get_config(:tools)
-        thisvm['tools'] = vm.guest.toolsStatus
-      end
+  def match_ip?(ip)
+    ip ||= 'NOTANIP'
+    !get_config(:matchip) || ip.include?(get_config(:matchip))
+  end
 
-      if get_config(:os_disk)
-        thisvm['disks'] = vm.guest.disk.map do |disk|
-          { 'name' => disk.diskPath,
-            'capacity' => disk.capacity / 1024 / 1024,
-            'free' => disk.freeSpace / 1024 / 1024
-          }
-        end
-      end
+  def match_os?(os)
+    !get_config(:matchos) || (os && os.include?(get_config(:matchos)))
+  end
 
-      if get_config(:esx_disk)
-        # TODO: https://www.vmware.com/support/developer/converter-sdk/conv55_apireference/vim.VirtualMachine.html#field_detail says this is deprecated
-        thisvm['esx_disks'] = vm.layout.disk.map(&:diskFile)
-      end
+  def state_to_english(power_state)
+    case power_state
+    when PS_ON
+      'on'
+    when PS_OFF
+      'off'
+    when PS_SUSPENDED
+      'suspended'
+    end
+  end
 
-      if get_config(:snapshots)
-        thisvm['snapshots'] = if vm.snapshot
-                                vm.snapshot.rootSnapshotList.map(&:name)
-                              else
-                                []
-                              end
-      end
-      thisvm
+  def full_path_to(vm)
+    path = []
+    iterator = vm.obj
+    while (iterator = iterator.parent)
+      break if iterator.name == VMFOLDER
+      path.unshift iterator.name
     end
-    ui.output(output.compact)
+
+    path.join '/'
   end
 end

data/lib/chef/knife/vsphere_vm_wait_sysprep.rb

@@ -42,8 +42,6 @@ class Chef::Knife::VsphereVmWaitSysprep < Chef::Knife::BaseVsphereCommand
       fatal_exit('You must specify a virtual machine name')
     end
 
-    config[:vmname] = vmname
-
     sleep_time = get_config(:sleep).to_i
     sleep_timeout = get_config(:timeout).to_i
 

data/lib/knife-vsphere/version.rb

@@ -1,5 +1,5 @@
 # The main knife-vsphere module.
 module KnifeVsphere
   # The version of this gem.
-  VERSION = '2.0.5'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-vsphere
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
 platform: ruby
 authors:
 - Ezra Pagel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: knife-windows
@@ -237,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: vSphere Support for Knife