knife-vsphere 1.2.26 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 060509d9604ac932b4808fc732e6fba41602b1c6
-  data.tar.gz: 44f9be0f47b5a38e67916cb1b0dcb87fb94c67e5
+  metadata.gz: 1590f83d24583a54afdd8e0d20e6cebdbe68a16c
+  data.tar.gz: 1ad17a8abad640718689b93a16879734c27f8250
 SHA512:
-  metadata.gz: a1d09af5a783b1b6a06f0bbfef2078187a9785a3397fca2cf6578d5d9d330ec397335716361db47c8502185eeaed146598a51533407ec939ba39c7152670934b
-  data.tar.gz: 37f379b2b0a787489e83785b4d761844d523fecd713e1112e69901b21e56fef0854ced1a53b686875c9aeea5b60fffeeae31c904b32febcda41f807dad2da8f3
+  metadata.gz: 6a220f46264fb88086e93bc61195e3c093048604f07eabeadbe4cabb78201dbc4671df728aa7372c3363ec176c0266b3fc267fb47065d5fd68eeedda1f0cdd61
+  data.tar.gz: 344665daa9c9849c83d8ea1b2fa6e1872ca487424c691462f6b89ae7f53e2a7c51d74cfb6c77fc876c20b937bde297b3bb5695d4182c20e8186e4a98ca3460a1

data/lib/chef/knife/base_vsphere_command.rb

@@ -9,13 +9,18 @@ require 'rbvmomi'
 require 'base64'
 require 'filesize'
 
+# Power state on
 PS_ON ||= 'poweredOn'.freeze
+# Power state off
 PS_OFF ||= 'poweredOff'.freeze
+# Power state suspended
 PS_SUSPENDED ||= 'suspended'.freeze
 
 # Base class for vsphere knife commands
 class Chef
+  # Base class for knife
   class Knife
+    # Main knife vsphere that more or less everything in this gem is built off of
     class BaseVsphereCommand < Knife
       deps do
         require 'chef/knife/bootstrap'

data/lib/chef/knife/customization_helper.rb

@@ -5,7 +5,14 @@
 
 require 'rbvmomi'
 
+# The Customization helper for sysprep
 module CustomizationHelper
+  # Wait for sysprep
+  #
+  # @param [Object] vm The VM object to connect to
+  # @param [Object] vim_connection The vim_connection object settings to connect for
+  # @param [String] timeout A string to set the timeout
+  # @param [String] sleep_time A string to set the a sleep_time
   def self.wait_for_sysprep(vm, vim_connection, timeout, sleep_time)
     vem = vim_connection.serviceContent.eventManager
 
@@ -31,6 +38,10 @@ module CustomizationHelper
     end
   end
 
+  # Confirm that cspec is done
+  #
+  # @param [Object] vm The VM object to connect to
+  # @param [Object] vem The vem TODO
   def self.query_customization_succeeded(vm, vem)
     vem.QueryEvents(filter:
         RbVmomi::VIM::EventFilterSpec(entity:

data/lib/chef/knife/vsphere_cpu_ratio.rb

@@ -1,11 +1,14 @@
 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]'
 
   common_options
 
+  # The main run method for cpu_ratio
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_customization_list.rb

@@ -6,11 +6,14 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Lists all customization specifications in the configured datacenter
+# VsphereCustomizationlist extends the BaseVspherecommand
 class Chef::Knife::VsphereCustomizationList < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere customization list'
 
   common_options
 
+  # The main run method for customization_list
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_datastore_file.rb

@@ -3,6 +3,7 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Upload or download a file from a datastore
+# VsphereDatastoreFile extends the BaseVspherecommand
 class Chef::Knife::VsphereDatastoreFile < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere datastore file'
 
@@ -28,6 +29,8 @@ class Chef::Knife::VsphereDatastoreFile < Chef::Knife::BaseVsphereCommand
          short: '-D',
          description: 'Download remote file to local'
 
+  # Main run method for datastore_file
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_datastore_list.rb

@@ -19,6 +19,7 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Lists all known data stores in datacenter with sizes
+# VsphereDatastorelist extends the BaseVspherecommand
 class Chef::Knife::VsphereDatastoreList < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere datastore list'
 
@@ -33,6 +34,8 @@ class Chef::Knife::VsphereDatastoreList < Chef::Knife::BaseVsphereCommand
          long: '--pool pool',
          description: 'Target pool'
 
+  # The main run method for datastore_list
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_datastore_maxfree.rb

@@ -19,6 +19,7 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Gets the data store with the most free space in datacenter
+# VsphereDatastoreMaxfree extends the BaseVspherecommand
 class Chef::Knife::VsphereDatastoreMaxfree < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere datastore maxfree'
 
@@ -38,6 +39,8 @@ class Chef::Knife::VsphereDatastoreMaxfree < Chef::Knife::BaseVsphereCommand
 
   common_options
 
+  # The main run method for datastore_maxfree
+  #
   def run
     $stdout.sync = true
     if get_config(:vlan) && get_config(:pool)

data/lib/chef/knife/vsphere_folder_list.rb

@@ -6,11 +6,16 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Lists all vm folders
+# VsphereFolderlist extends the BaseVspherecommand
 class Chef::Knife::VsphereFolderList < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere folder list'
 
   common_options
 
+  # Walks though the folders to find something
+  #
+  # param [String] folder that you should go through
+  # param [String] indent_level for the output to indent
   def traverse_folders(folder, indent_level)
     puts "#{'  ' * indent_level} #{ui.color('Folder', :cyan)}: " + folder.name
 
@@ -20,6 +25,7 @@ class Chef::Knife::VsphereFolderList < Chef::Knife::BaseVsphereCommand
     end
   end
 
+  # Main run method for folder_list
   def run
     vim_connection
     base_folder = find_folder(get_config(:folder))

data/lib/chef/knife/vsphere_hosts_list.rb

@@ -4,6 +4,7 @@ require 'rbvmomi'
 require 'netaddr'
 
 # list hosts belonging to pool
+# VsphereHostslist extends the BaseVspherecommand
 class Chef::Knife::VsphereHostsList < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere hosts list'
 
@@ -13,6 +14,8 @@ class Chef::Knife::VsphereHostsList < Chef::Knife::BaseVsphereCommand
          short: '-h',
          description: 'Target pool'
 
+  # The main run method for hosts_list
+  #
   def run
     vim_connection
     dc = datacenter

data/lib/chef/knife/vsphere_pool_query.rb

@@ -3,11 +3,14 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# VspherePoolQuery extends the BaseVsphereCommand
 class Chef::Knife::VspherePoolQuery < Chef::Knife::BaseVsphereCommand
   banner "knife vsphere pool query POOLNAME QUERY.  See \"http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.ComputeResource.html\" for allowed QUERY values."
 
   common_options
 
+  # The main run method for poll_query
+  #
   def run
     args = ARGV
     args[2] = 'show'

data/lib/chef/knife/vsphere_template_list.rb

@@ -7,11 +7,14 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Lists all known VM templates in the configured datacenter
+# VsphereTemplatelist extends the BaseVspherecommand
 class Chef::Knife::VsphereTemplateList < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere template list'
 
   common_options
 
+  # The main run method for template_list
+  #
   def run
     $stdout.sync = true
     $stderr.sync = true

data/lib/chef/knife/vsphere_vlan_create.rb

@@ -2,6 +2,7 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Lists all known data stores in datacenter with sizes
+# VsphereVlanCreate extends BaseVspherecommand
 class Chef::Knife::VsphereVlanCreate < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vlan create NAME VID'
 
@@ -11,6 +12,8 @@ class Chef::Knife::VsphereVlanCreate < Chef::Knife::BaseVsphereCommand
          long: '--switch DVSNAME',
          description: 'The DVSwitch that will hold this VLAN'
 
+  # The main run method for vlan_create
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_vlan_list.rb

@@ -18,11 +18,14 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Lists all known data stores in datacenter with sizes
+# VsphereVlanlist extends the BaseVspherecommand
 class Chef::Knife::VsphereVlanList < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vlan list'
 
   common_options
 
+  # The main run method for vlan_list
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_vm_cdrom.rb

@@ -5,9 +5,11 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# VsphereVmCdrom extends the BaseVspherecommand
 class Chef::Knife::VsphereVmCdrom < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm cdrom VMNAME (options)'
 
+  # The empty device name.
   EMPTY_DEVICE_NAME = ''.freeze
 
   common_options
@@ -44,6 +46,8 @@ class Chef::Knife::VsphereVmCdrom < Chef::Knife::BaseVsphereCommand
          long: '--recursive',
          description: 'Search all folders'
 
+  # The main run method for vm_cdrom
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_vm_clone.rb

@@ -15,10 +15,13 @@ require 'chef/knife/winrm_base'
 require 'chef/knife/customization_helper'
 require 'ipaddr'
 
+# VsphereVmClone extends the BaseVspherecommand
 class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm clone VMNAME (options)'
 
+  # A AUTO_MAC for NIC?
   AUTO_MAC = 'auto'
+  # A NO IP for you to use!
   NO_IPS = ''
 
   include Chef::Knife::WinrmBase
@@ -389,8 +392,6 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
 
     return unless get_config(:bootstrap)
 
-    connect_host = guest_address(vm)
-    Chef::Log.debug("Connect Host for Bootstrap: #{connect_host}")
     connect_port = get_config(:ssh_port)
     protocol = get_config(:bootstrap_protocol)
     if windows?(src_vm.config)
@@ -403,10 +404,14 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
         CustomizationHelper.wait_for_sysprep(vm, vim, Integer(get_config(:sysprep_timeout)), 10)
         puts 'Customization Complete'
       end
+      connect_host = guest_address(vm)
+      Chef::Log.debug("Connect Host for winrm Bootstrap: #{connect_host}")
       wait_for_access(connect_host, connect_port, protocol)
       ssh_override_winrm
       bootstrap_for_windows_node.run
     else
+      connect_host = guest_address(vm)
+      Chef::Log.debug("Connect Host for SSH Bootstrap: #{connect_host}")
       protocol ||= 'ssh'
       wait_for_access(connect_host, connect_port, protocol)
       ssh_override_winrm
@@ -687,7 +692,7 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
         )
         license_file_print_data = RbVmomi::VIM.CustomizationLicenseFilePrintData(
           autoMode: cust_spec.identity.licenseFilePrintData.autoMode
-        )
+        ) if cust_spec.identity.licenseFilePrintData # optional param
 
         user_data = RbVmomi::VIM.CustomizationUserData(
           fullName: cust_spec.identity.userData.fullName,
@@ -770,7 +775,6 @@ class Chef::Knife::VsphereVmClone < Chef::Knife::BaseVsphereCommand
   end
 
   # Retrieves a CustomizationSpecItem that matches the supplied name
-  # @param vim [Connection] VI Connection to use
   # @param name [String] name of customization
   # @return [RbVmomi::VIM::CustomizationSpecItem]
   def find_customization(name)

data/lib/chef/knife/vsphere_vm_config.rb

@@ -6,6 +6,7 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# VsphereVMconfig extends the BaseVspherecommand
 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\"
@@ -13,6 +14,8 @@ class Chef::Knife::VsphereVmConfig < Chef::Knife::BaseVsphereCommand
 
   common_options
 
+  # The main run method in vm_config
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[0]

data/lib/chef/knife/vsphere_vm_delete.rb

@@ -12,6 +12,7 @@ require 'chef/node'
 require 'chef/api_client'
 
 # Delete a virtual machine from vCenter
+# VsphereVmDelete extends the BaseVspherecommand
 class Chef::Knife::VsphereVmDelete < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm delete VMNAME (options)'
 
@@ -33,12 +34,18 @@ class Chef::Knife::VsphereVmDelete < Chef::Knife::BaseVsphereCommand
   # 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.
+  #
+  # @param [Object] itemClass The class object
+  # @param [String] name The name of the VM that you need to delete
+  # @param [String] type_name The type_name of the thing that you need? TODO
   def destroy_item(itemClass, name, type_name)
     object = itemClass.load(name)
     object.destroy
     puts "Deleted #{type_name} #{name}"
   end
 
+  # The main run method from vm_delete
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_vm_disk_list.rb

@@ -2,11 +2,14 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # List the disks attached to a VM
+# VsphereVmdisklist extends the BaseVspherecommand
 class Chef::Knife::VsphereVmDiskList < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm disk list VMNAME'
 
   common_options
 
+  # The main run method for vm_disk_list
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_vm_execute.rb

@@ -6,6 +6,7 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# VsphereVMexecute extends the Basevspherecommand
 class Chef::Knife::VsphereVmExecute < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm execute VMNAME COMMAND ARGS'
 
@@ -25,6 +26,8 @@ class Chef::Knife::VsphereVmExecute < Chef::Knife::BaseVsphereCommand
 
   common_options
 
+  # The main run method for vm_execute
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[0]

data/lib/chef/knife/vsphere_vm_find.rb

@@ -49,7 +49,11 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
 
   option :ips,
          long: '--ips',
-         description: 'Show all ips, with networks'
+         description: 'Show all ips, with networks - DEPRECATED use --networks'
+
+  option :networks,
+         long: '--networks',
+         description: 'Show all networks with their IPs'
 
   option :soff,
          long: '--powered-off',
@@ -73,7 +77,7 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
 
   option :hostname,
          long: '--hostname',
-         description: 'show hostname'
+         description: 'show hostname of the guest'
 
   option :host_name,
          long: '--host_name',
@@ -101,20 +105,25 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
 
   $stdout.sync = true # smoother output from print
 
-  def traverse_folders_for_pool_clustercompute(folder, poolname)
+  # 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 == poolname
+      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, poolname)
+        pool = traverse_folders_for_pool_clustercompute(child, objectname)
       end
       return pool if pool
     end
     false
   end
 
+  # Main entry point to the command
   def run
     poolname = config[:pool]
     if poolname.nil?
@@ -122,6 +131,8 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
       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
@@ -130,121 +141,135 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
            else
              traverse_folders_for_pool_clustercompute(folder, poolname) || abort("Pool #{poolname} not found")
            end
-    vm = if pool.class == RbVmomi::VIM::ResourcePool
-           pool.vm
-         else
-           pool.resourcePool.vm
-         end
-
-    return if vm.nil?
-    vm.each do |vmc|
-      state = case vmc.runtime.powerState
-              when PS_ON
-                ui.color('on', :green)
-              when PS_OFF
-                ui.color('off', :red)
-              when PS_SUSPENDED
-                ui.color('suspended', :yellow)
+    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 vmc.name.include? config[:matchname]
+        next unless vm.name.include? config[:matchname]
       end
 
       if get_config(:matchtools)
-        next unless vmc.guest.toolsStatus == config[:matchtools]
+        next unless vm.guest.toolsStatus == config[:matchtools]
       end
 
-      next if get_config(:soff) && (vmc.runtime.powerState == PS_ON)
+      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(:son) && (vmc.runtime.powerState == PS_OFF)
+      next if get_config(:soff) && (power_state == PS_ON)
+
+      next if get_config(:son) && (power_state == PS_OFF)
 
       if get_config(:matchip)
-        if !vmc.guest.ipAddress.nil? && vmc.guest.ipAddress != ''
-          next unless vmc.guest.ipAddress.include? config[:matchip]
+        if !vm.guest.ipAddress.nil? && vm.guest.ipAddress != ''
+          next unless vm.guest.ipAddress.include? config[:matchip]
         else
           next
         end
       end
 
-      unless vmc.guest.guestFullName.nil?
+      unless vm.guest.guestFullName.nil?
         if get_config(:matchos)
-          next unless vmc.guest.guestFullName.include? config[:matchos]
+          next unless vm.guest.guestFullName.include? config[:matchos]
         end
       end
 
-      print "#{ui.color('VM Name:', :cyan)} #{vmc.name}\t"
+      thisvm['name'] = vm.name
       if get_config(:hostname)
-        print "#{ui.color('Hostname:', :cyan)} #{vmc.guest.hostName}\t"
+        thisvm['hostname'] = vm.guest.hostName
       end
       if get_config(:host_name)
-        print "#{ui.color('Host_name:', :cyan)} #{vmc.summary.runtime.host.name}\t"
+        # TODO: Why vm.summary.runtime vs vm.runtime?
+        thisvm['host_name'] = vm.summary.runtime.host.name
       end
 
       if get_config(:full_path)
-        actualname = ''
-        vmcp = vmc
-        while !vmcp.parent.nil? && vmcp.parent.name != 'vm'
-          actualname.concat("#{vmcp.parent.name}/")
-          vmcp = vmcp.parent
-        end
-        print ui.color('Folder:', :cyan)
-        print '"'
-        print actualname.split('/').reverse.join('/')
-        print "\"\t"
+        fullpath = ''
+        iterator = vm
 
+        while iterator = iterator.parent
+          break if iterator.name == 'vm'
+          fullpath = fullpath.empty? ? iterator.name : "#{iterator.name}/#{fullpath}"
+        end
+        thisvm['folder'] = fullpath
       else
-        print "#{ui.color('Folder', :cyan)}: #{vmc.parent.name}\t"
+        thisvm['folder'] = vm.parent.name
       end
 
       if get_config(:ip)
-        print "#{ui.color('IP:', :cyan)} #{vmc.guest.ipAddress}\t"
+        thisvm['ip'] = vm.guest.ipAddress
       end
-      if get_config(:ips)
+
+      if get_config(:networks)
         ipregex = /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$/
-        networks = vmc.guest.net.map { |net| "#{net.network}:" + net.ipConfig.ipAddress.select { |i| i.ipAddress[ipregex] }[0].ipAddress }
-        print "#{ui.color('IPS:', :cyan)} #{networks.join(',')}\t"
+        thisvm['networks'] = vm.guest.net.map do |net|
+          firstip = net.ipConfig.ipAddress.first { |i| i.ipAddress[ipregex] }
+
+          { 'name' => net.network,
+            'ip' => firstip.ipAddress,
+            'prefix' => firstip.prefixLength
+          }
+        end
       end
+
       if get_config(:os)
-        print "#{ui.color('OS:', :cyan)} #{vmc.guest.guestFullName}\t"
+        thisvm['os'] = vm.guest.guestFullName
       end
+
       if get_config(:ram)
-        print "#{ui.color('RAM:', :cyan)} #{vmc.summary.config.memorySizeMB}\t"
+        thisvm['ram'] = vm.summary.config.memorySizeMB
       end
+
       if get_config(:cpu)
-        print "#{ui.color('CPU:', :cyan)} #{vmc.summary.config.numCpu}\t"
+        thisvm['cpu'] = vm.summary.config.numCpu
       end
+
       if get_config(:alarms)
-        print "#{ui.color('Alarms:', :cyan)} #{vmc.summary.overallStatus}\t"
+        thisvm['alarms'] = vm.summary.overallStatus
       end
-      print "#{ui.color('State:', :cyan)} #{state}\t"
+
       if get_config(:tools)
-        print "#{ui.color('Tools:', :cyan)} #{vmc.guest.toolsStatus}\t"
+        thisvm['tools'] = vm.guest.toolsStatus
       end
 
       if get_config(:os_disk)
-        print ui.color('OS Disks:', :cyan)
-        vmc.guest.disk.each do |disc|
-          print "#{disc.diskPath} #{disc.capacity / 1024 / 1024}MB Free:#{disc.freeSpace / 1024 / 1024}MB |"
+        thisvm['disks'] = vm.guest.disk.map do |disk|
+          { 'name' => disk.diskPath,
+            'capacity' => disk.capacity / 1024 / 1024,
+            'free' => disk.freeSpace / 1024 / 1024
+          }
         end
       end
 
       if get_config(:esx_disk)
-        print ui.color('ESX Disks:', :cyan)
-        vmc.layout.disk.each do |dsc|
-          print "#{dsc.diskFile} | "
-        end
+        # 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
 
       if get_config(:snapshots)
-        unless vmc.snapshot.nil?
-          print ui.color('Snapshots:', :cyan)
-          vmc.snapshot.rootSnapshotList.each do |snap|
-            print " #{snap.name}"
-          end
-        end
+        thisvm['snapshots'] = if vm.snapshot
+                                vm.snapshot.rootSnapshotList.map(&:name)
+                              else
+                                []
+                              end
       end
-      puts
+      thisvm
     end
+    ui.output(output.compact)
   end
 end

data/lib/chef/knife/vsphere_vm_markastemplate.rb

@@ -13,6 +13,7 @@ require 'rbvmomi'
 # Clone an existing template into a new VM, optionally applying a customization specification.
 # usage:
 # knife vsphere vm markastemplate MyVM --folder /templates
+# Vspherevmmarkastemplate extends the Basevspherecommand
 class Chef::Knife::VsphereVmMarkastemplate < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm markastemplate VMNAME'
 
@@ -23,6 +24,8 @@ class Chef::Knife::VsphereVmMarkastemplate < Chef::Knife::BaseVsphereCommand
          description: 'The folder which contains the VM',
          default: ''
 
+  # The main run method for vm_markastemplate
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_vm_move.rb

@@ -6,6 +6,7 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Lists all known virtual machines in the configured datacenter
+# VsphereVmMove extends the BaseVspherecommand
 class Chef::Knife::VsphereVmMove < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm move'
 
@@ -35,6 +36,8 @@ class Chef::Knife::VsphereVmMove < Chef::Knife::BaseVsphereCommand
          boolean: true
 
   # Convert VM
+  #
+  # @param [Object] vm The VM object to convert the VM
   def convert_vm(vm)
     dc = datacenter
     hosts = find_all_in_folder(dc.hostFolder, RbVmomi::VIM::ComputeResource)
@@ -56,6 +59,8 @@ class Chef::Knife::VsphereVmMove < Chef::Knife::BaseVsphereCommand
   end
 
   # Move VM
+  #
+  # @param [Object] vm The VM object to convert the VM
   def move_vm(vm)
     dest_name = config[:dest_name] || vm.name
     dest_folder = config[:dest_folder].nil? ? (vm.parent) : (find_folder(get_config(:dest_folder)))
@@ -64,6 +69,8 @@ class Chef::Knife::VsphereVmMove < Chef::Knife::BaseVsphereCommand
     dest_folder.MoveIntoFolder_Task(list: [vm]).wait_for_completion unless vm.parent == dest_folder
   end
 
+  # The main run method for vm_move
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[0]

data/lib/chef/knife/vsphere_vm_net.rb

@@ -4,10 +4,15 @@
 #
 require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
+
 # Switch VM networking state up/down (on all network interfaces)
+# VsphereVmNet extends the BaseVspherecommand
 class Chef::Knife::VsphereVmNet < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm net STATE VMNAME'
   common_options
+
+  # The main run method for vm_net
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[1]

data/lib/chef/knife/vsphere_vm_network_list.rb

@@ -7,11 +7,14 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# VsphereVmNetworklist extends the BaseVspherecommand
 class Chef::Knife::VsphereVmNetworkList < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm network list VMNAME'
 
   common_options
 
+  # The main run method for vm_network_list
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_vm_network_set.rb

@@ -6,6 +6,7 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Changes network on a certain VM
+# VsphereVmNetworkSet extends the BaseVspherecommand
 class Chef::Knife::VsphereVmNetworkSet < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm network set VMNAME NETWORKNAME'
 
@@ -16,6 +17,8 @@ class Chef::Knife::VsphereVmNetworkSet < Chef::Knife::BaseVsphereCommand
     description: 'Network interface to use when multiple NICs are present on the VM. (0,1..)',
     default: 0
 
+  # The main run method for vm_network_set
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[0]

data/lib/chef/knife/vsphere_vm_property_get.rb

@@ -6,11 +6,14 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# VsphereVMPropertyget extends the BaseVspherecommand
 class Chef::Knife::VsphereVmPropertyGet < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm property get VMNAME PROPERTY.  Gets a vApp Property on VMNAME.'
 
   common_options
 
+  # The main run method for vm_property_get
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[0]

data/lib/chef/knife/vsphere_vm_property_set.rb

@@ -6,6 +6,7 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# VsphereVMPropertySet extends Basevspherecommand
 class Chef::Knife::VsphereVmPropertySet < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm property set VMNAME PROPERTY VALUE.  Sets a vApp Property on VMNAME.'
 
@@ -15,6 +16,8 @@ class Chef::Knife::VsphereVmPropertySet < Chef::Knife::BaseVsphereCommand
          long: '--ovf-environment-transport STRING',
          description: 'Comma delimited string.  Configures the transports to use for properties. Supported values are: iso and com.vmware.guestInfo.'
 
+  # The main run method for vm_property_set
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[0]

data/lib/chef/knife/vsphere_vm_query.rb

@@ -3,11 +3,14 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# VsphereVmQuery extends the BaseVspherecommand
 class Chef::Knife::VsphereVmQuery < Chef::Knife::BaseVsphereCommand
   banner "knife vsphere vm query VMNAME QUERY.  See \"http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.VirtualMachine.html\" for allowed QUERY values."
 
   common_options
 
+  # The main run method for vm_query
+  #
   def run
     args = ARGV
     args[2] = 'show'

data/lib/chef/knife/vsphere_vm_show.rb

@@ -6,11 +6,14 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# VsphereVmShow extends the BaseVspherecommand
 class Chef::Knife::VsphereVmShow < Chef::Knife::BaseVsphereCommand
   banner "knife vsphere vm show VMNAME QUERY.  See \"http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.VirtualMachine.html\" for allowed QUERY values."
 
   common_options
 
+  # The main run method for vm_show
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[0]

data/lib/chef/knife/vsphere_vm_state.rb

@@ -9,7 +9,9 @@ require 'rbvmomi'
 require 'netaddr'
 
 # Manage power state of a virtual machine
+# VsphereVmState extends the BaseVspherecommand
 class Chef::Knife::VsphereVmState < Chef::Knife::BaseVsphereCommand
+  # The Different power states that vSphere reports
   POWER_STATES = {
     PS_ON => 'powered on',
     PS_OFF => 'powered off',
@@ -40,6 +42,8 @@ class Chef::Knife::VsphereVmState < Chef::Knife::BaseVsphereCommand
          long: '--recursive',
          description: 'Search all folders'
 
+  # The main run method for vm_state
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_vm_toolsconfig.rb

@@ -6,6 +6,7 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# Vspherevmtoolsconfig extends the BaseVspherecommand
 class Chef::Knife::VsphereVmToolsconfig < Chef::Knife::BaseVsphereCommand
   banner "knife vsphere vm toolsconfig PROPERTY VALUE.
           See \"https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.vm.ToolsConfigInfo.html\"
@@ -17,6 +18,8 @@ class Chef::Knife::VsphereVmToolsconfig < Chef::Knife::BaseVsphereCommand
          description: 'Allow empty string'
   common_options
 
+  # The main run method for vm_toolsconfig
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[0]

data/lib/chef/knife/vsphere_vm_vmdk_add.rb

@@ -6,6 +6,7 @@ require 'chef/knife'
 require 'chef/knife/base_vsphere_command'
 
 # Add a new disk to a virtual machine
+# VsphereVmvmdkadd extends the BaseVspherecommand
 class Chef::Knife::VsphereVmVmdkAdd < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm vmdk add VMNAME DISK_GB'
 
@@ -21,6 +22,8 @@ class Chef::Knife::VsphereVmVmdkAdd < Chef::Knife::BaseVsphereCommand
          long: '--target-lun NAME',
          description: 'name of target LUN'
 
+  # The main run method for vm_vmdk_add
+  #
   def run
     $stdout.sync = true
 

data/lib/chef/knife/vsphere_vm_vnc_set.rb

@@ -7,6 +7,7 @@ require 'chef/knife/base_vsphere_command'
 require 'rbvmomi'
 require 'netaddr'
 
+# Main class VsphereVMvncset extends the BaseVspherecommand
 class Chef::Knife::VsphereVmVncset < Chef::Knife::BaseVsphereCommand
   banner 'knife vsphere vm vncset VMNAME COMMAND ARGS'
 
@@ -22,6 +23,8 @@ class Chef::Knife::VsphereVmVncset < Chef::Knife::BaseVsphereCommand
 
   common_options
 
+  # The main run method for vm_vnc_set
+  #
   def run
     $stdout.sync = true
     vmname = @name_args[0]

data/lib/chef/knife/vsphere_vm_wait_sysprep.rb

@@ -30,6 +30,8 @@ class Chef::Knife::VsphereVmWaitSysprep < Chef::Knife::BaseVsphereCommand
          description: 'The timeout in seconds before aborting. Default: 300 seconds',
          default: 300
 
+  # The main run method for vm_wait_sysprep.
+  #
   def run
     $stdout.sync = true
 

data/lib/knife-vsphere/version.rb

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

metadata

@@ -1,125 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: knife-vsphere
 version: !ruby/object:Gem::Version
-  version: 1.2.26
+  version: 2.0.0
 platform: ruby
 authors:
 - Ezra Pagel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-20 00:00:00.000000000 Z
+date: 2017-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: filesize
+  name: knife-windows
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: netaddr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rbvmomi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: knife-windows
+  name: filesize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rb-readline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: VMware vSphere Support for Chef's Knife Command
@@ -174,7 +202,7 @@ files:
 - lib/chef/knife/vsphere_vm_vnc_set.rb
 - lib/chef/knife/vsphere_vm_wait_sysprep.rb
 - lib/knife-vsphere/version.rb
-homepage: http://github.com/ezrapagel/knife-vsphere
+homepage: http://github.com/chef-partners/knife-vsphere
 licenses:
 - Apache
 metadata: {}
@@ -184,17 +212,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: vSphere Support for Knife