knife-vsphere 2.1.1 → 2.1.3

data/lib/chef/knife/vsphere_vm_config.rb

@@ -1,9 +1,9 @@
 # Author:: Brian Dupras (<bdupras@rallydev.com>)
 # License:: Apache License, Version 2.0
 
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'chef/knife/search_helper'
+require "chef/knife"
+require "chef/knife/base_vsphere_command"
+require "chef/knife/search_helper"
 
 # VsphereVMconfig extends the BaseVspherecommand
 class Chef::Knife::VsphereVmConfig < Chef::Knife::BaseVsphereCommand
@@ -21,11 +21,11 @@ class Chef::Knife::VsphereVmConfig < Chef::Knife::BaseVsphereCommand
     vmname = @name_args.shift
     if vmname.nil?
       show_usage
-      fatal_exit('You must specify a virtual machine name')
+      fatal_exit("You must specify a virtual machine name")
     end
 
-    unless @name_args.length > 0 && @name_args.length % 2 == 0
-      fatal_exit('You must specify a series of PROPERTY name (e.g. annotation) followed by a value')
+    unless @name_args.length > 0 && @name_args.length.even?
+      fatal_exit("You must specify a series of PROPERTY name (e.g. annotation) followed by a value")
     end
 
     vm = get_vm_by_name(vmname, get_config(:folder)) || fatal_exit("Could not find #{vmname}")

data/lib/chef/knife/vsphere_vm_delete.rb

@@ -3,31 +3,31 @@
 # License:: Apache License, Version 2.0
 #
 
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'chef/knife/search_helper'
-require 'rbvmomi'
+require "chef/knife"
+require "chef/knife/base_vsphere_command"
+require "chef/knife/search_helper"
+require "rbvmomi"
 
 # These two are needed for the '--purge' deletion case
-require 'chef/node'
-require 'chef/api_client'
+require "chef/node"
+require "chef/api_client"
 
 # Delete a virtual machine from vCenter
 # VsphereVmDelete extends the BaseVspherecommand
 class Chef::Knife::VsphereVmDelete < Chef::Knife::BaseVsphereCommand
   include SearchHelper
-  banner 'knife vsphere vm delete VMNAME (options)'
+  banner "knife vsphere vm delete VMNAME (options)"
 
   option :purge,
-         short: '-P',
-         long: '--purge',
+         short: "-P",
+         long: "--purge",
          boolean: true,
-         description: 'Destroy corresponding node and client on the Chef Server, in addition to destroying the VM itself.'
+         description: "Destroy corresponding node and client on the Chef Server, in addition to destroying the VM itself."
 
   option :chef_node_name,
-         short: '-N NAME',
-         long: '--node-name NAME',
-         description: 'Use this option if the Chef node name is different from the VM name'
+         short: "-N NAME",
+         long: "--node-name NAME",
+         description: "Use this option if the Chef node name is different from the VM name"
 
   common_options
 
@@ -55,19 +55,19 @@ class Chef::Knife::VsphereVmDelete < Chef::Knife::BaseVsphereCommand
 
     if vmname.nil?
       show_usage
-      fatal_exit('You must specify a virtual machine name')
+      fatal_exit("You must specify a virtual machine name")
     end
 
     vm = get_vm_by_name(vmname, get_config(:folder)) || fatal_exit("Could not find #{vmname}")
 
-    vm.PowerOffVM_Task.wait_for_completion unless vm.runtime.powerState == 'poweredOff'
+    vm.PowerOffVM_Task.wait_for_completion unless vm.runtime.powerState == "poweredOff"
     vm.Destroy_Task.wait_for_completion
     puts "Deleted virtual machine #{vmname}"
 
     if config[:purge]
       vmname = config[:chef_node_name] if config[:chef_node_name]
-      destroy_item(Chef::Node, vmname, 'node')
-      destroy_item(Chef::ApiClient, vmname, 'client')
+      destroy_item(Chef::Node, vmname, "node")
+      destroy_item(Chef::ApiClient, vmname, "client")
       puts "Corresponding node and client for the #{vmname} server were deleted and unregistered with the Chef Server"
     end
   end

data/lib/chef/knife/vsphere_vm_disk_extend.rb

@@ -3,32 +3,32 @@
 # License:: Apache License, Version 2.0
 #
 
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'chef/knife/search_helper'
+require "chef/knife"
+require "chef/knife/base_vsphere_command"
+require "chef/knife/search_helper"
 
 class Chef::Knife::VsphereVmDiskExtend < Chef::Knife::BaseVsphereCommand
   include SearchHelper
-  banner 'knife vsphere vm disk extend VMNAME SIZE. Extends the disk of vm VMNAME to SIZE kilobytes.'
+  banner "knife vsphere vm disk extend VMNAME SIZE. Extends the disk of vm VMNAME to SIZE kilobytes."
 
   common_options
 
   option :diskname,
-         long: '--diskname DISKNAME',
-         description: 'The name of the disk that will be extended'
+         long: "--diskname DISKNAME",
+         description: "The name of the disk that will be extended"
 
   def run
     $stdout.sync = true
     vmname = @name_args[0]
     if vmname.nil?
       show_usage
-      fatal_exit('You must specify a virtual machine name')
+      fatal_exit("You must specify a virtual machine name")
     end
 
     size = @name_args[1]
     if size.nil? || !size.match(/^\d+$/)
       show_usage
-      fatal_exit('You must specify the new disk size')
+      fatal_exit("You must specify the new disk size")
     end
 
     disk_name = get_config(:diskname) unless get_config(:diskname).nil?
@@ -47,7 +47,7 @@ class Chef::Knife::VsphereVmDiskExtend < Chef::Knife::BaseVsphereCommand
       names = disks.map { |disk| disk.deviceInfo.label }
       abort("More than 1 disk found: #{names}, please use --diskname DISKNAME")
     elsif disks.length == 0
-      abort('No disk found')
+      abort("No disk found")
     end
 
     disk = disks[0]
@@ -57,9 +57,9 @@ class Chef::Knife::VsphereVmDiskExtend < Chef::Knife::BaseVsphereCommand
       RbVmomi::VIM::VirtualMachineConfigSpec(
         deviceChange: [RbVmomi::VIM::VirtualDeviceConfigSpec(
           device: disk,
-          operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation('edit'))]
+          operation: RbVmomi::VIM::VirtualDeviceConfigSpecOperation("edit"))]
       )).wait_for_completion
 
-    puts 'Disk resized successfully'
+    puts "Disk resized successfully"
   end
 end

data/lib/chef/knife/vsphere_vm_disk_list.rb

@@ -1,13 +1,13 @@
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'chef/knife/search_helper'
+require "chef/knife"
+require "chef/knife/base_vsphere_command"
+require "chef/knife/search_helper"
 
 # List the disks attached to a VM
 # VsphereVmdisklist extends the BaseVspherecommand
 class Chef::Knife::VsphereVmDiskList < Chef::Knife::BaseVsphereCommand
   include SearchHelper
 
-  banner 'knife vsphere vm disk list VMNAME'
+  banner "knife vsphere vm disk list VMNAME"
 
   common_options
 
@@ -18,7 +18,7 @@ class Chef::Knife::VsphereVmDiskList < Chef::Knife::BaseVsphereCommand
 
     unless vmname = @name_args[0]
       show_usage
-      fatal_exit 'You must specify a virtual machine name'
+      fatal_exit "You must specify a virtual machine name"
     end
 
     vm = get_vm_by_name(vmname, get_config(:folder)) || fatal_exit("Could not find #{vmname}")
@@ -28,7 +28,7 @@ class Chef::Knife::VsphereVmDiskList < Chef::Knife::BaseVsphereCommand
     end
 
     disks.each do |disk|
-      puts '%3d %20s %20s %s' % [disk.unitNumber,
+      puts "%3d %20s %20s %s" % [disk.unitNumber,
                             disk.deviceInfo.label,
                             disk.backing.datastore.name,
                             Filesize.from("#{disk.capacityInKB} KiB").pretty]

data/lib/chef/knife/vsphere_vm_execute.rb

@@ -1,29 +1,29 @@
 # Author:: Ian Delahorne (<ian@delahorne.com>)
 # License:: Apache License, Version 2.0
 
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'chef/knife/search_helper'
+require "chef/knife"
+require "chef/knife/base_vsphere_command"
+require "chef/knife/search_helper"
 
 # VsphereVMexecute extends the Basevspherecommand
 class Chef::Knife::VsphereVmExecute < Chef::Knife::BaseVsphereCommand
   include SearchHelper
 
-  banner 'knife vsphere vm execute VMNAME COMMAND ARGS'
+  banner "knife vsphere vm execute VMNAME COMMAND ARGS"
 
   option :exec_user,
-         long: '--exec-user USER',
-         description: 'User to execute as',
+         long: "--exec-user USER",
+         description: "User to execute as",
          required: true
 
   option :exec_passwd,
-         long: '--exec-passwd PASSWORD',
-         description: 'Password for execute user',
+         long: "--exec-passwd PASSWORD",
+         description: "Password for execute user",
          required: true
 
   option :exec_dir,
-         long: '--exec-dir DIRECTORY',
-         description: 'Working directory to execute in'
+         long: "--exec-dir DIRECTORY",
+         description: "Working directory to execute in"
 
   common_options
 
@@ -34,16 +34,16 @@ class Chef::Knife::VsphereVmExecute < Chef::Knife::BaseVsphereCommand
     vmname = @name_args.shift
     if vmname.nil?
       show_usage
-      fatal_exit('You must specify a virtual machine name')
+      fatal_exit("You must specify a virtual machine name")
     end
     command = @name_args.shift
     if command.nil?
       show_usage
-      fatal_exit('You must specify a command to execute')
+      fatal_exit("You must specify a command to execute")
     end
 
     args = @name_args
-    args = '' if args.nil? || args.empty?
+    args = "" if args.nil? || args.empty?
 
     vm = get_vm_by_name(vmname, get_config(:folder)) || fatal_exit("Could not find #{vmname}")
 
@@ -53,7 +53,7 @@ class Chef::Knife::VsphereVmExecute < Chef::Knife::BaseVsphereCommand
                                                           username: config[:exec_user],
                                                           password: config[:exec_passwd])
     prog_spec = RbVmomi::VIM::GuestProgramSpec(programPath: command,
-                                               arguments: args.join(' '),
+                                               arguments: args.join(" "),
                                                workingDirectory: get_config(:exec_dir))
 
     gom.processManager.StartProgramInGuest(vm: vm, auth: guest_auth, spec: prog_spec)

data/lib/chef/knife/vsphere_vm_find.rb

@@ -2,155 +2,155 @@
 # License:: Apache License, Version 2.0
 #
 
-require 'chef/knife'
-require 'chef/knife/base_vsphere_command'
-require 'chef/knife/search_helper'
+require "chef/knife"
+require "chef/knife/base_vsphere_command"
+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'
+  banner "knife vsphere vm find"
 
-  VMFOLDER = 'vm'.freeze
+  VMFOLDER = "vm".freeze
 
   common_options
 
   # Deprecating
   option :pool,
-         long: '--pool pool',
-         short: '-h',
-         description: 'Target pool'
+         long: "--pool pool",
+         short: "-h",
+         description: "Target pool"
   # Deprecating
   option :poolpath,
-         long: '--pool-path',
-         description: 'Pool is full-path'
+         long: "--pool-path",
+         description: "Pool is full-path"
 
   option :esx_disk,
-         long: '--esx-disk',
-         description: 'Show esx disks'
+         long: "--esx-disk",
+         description: "Show esx disks"
 
   option :snapshots,
-         long: '--snapshots',
-         description: 'Show snapshots'
+         long: "--snapshots",
+         description: "Show snapshots"
 
   option :os_disk,
-         long: '--os-disks',
-         description: 'Show os disks'
+         long: "--os-disks",
+         description: "Show os disks"
 
   option :cpu,
-         long: '--cpu',
-         description: 'Show cpu'
+         long: "--cpu",
+         description: "Show cpu"
 
   option :cpu_hot_add_enabled,
-         long: '--cpu_hot_add_enabled',
-         description: 'Show cpu hot add enabled'
+         long: "--cpu_hot_add_enabled",
+         description: "Show cpu hot add enabled"
 
   option :memory_hot_add_enabled,
-         long: '--memory_hot_add_enabled',
-         description: 'Show memory hot add enabled'
+         long: "--memory_hot_add_enabled",
+         description: "Show memory hot add enabled"
 
   option :ram,
-         long: '--ram',
-         description: 'Show ram'
+         long: "--ram",
+         description: "Show ram"
 
   option :ip,
-         long: '--ip',
-         description: 'Show primary ip'
+         long: "--ip",
+         description: "Show primary ip"
 
   option :networks,
-         long: '--networks',
-         description: 'Show all networks with their IPs'
+         long: "--networks",
+         description: "Show all networks with their IPs"
 
   option :soff,
-         long: '--powered-off',
-         description: 'Show only stopped machines'
+         long: "--powered-off",
+         description: "Show only stopped machines"
 
   option :son,
-         long: '--powered-on',
-         description: 'Show only started machines'
+         long: "--powered-on",
+         description: "Show only started machines"
 
   option :matchip,
-         long: '--match-ip IP',
-         description: 'match ip'
+         long: "--match-ip IP",
+         description: "match ip"
 
   option :matchos,
-         long: '--match-os OS',
-         description: 'match os'
+         long: "--match-os OS",
+         description: "match os"
 
   option :matchname,
-         long: '--match-name VMNAME',
-         description: 'match name'
+         long: "--match-name VMNAME",
+         description: "match name"
 
   option :matchtools,
-         long: '--match-tools TOOLSSTATE',
-         description: 'match tools state'
+         long: "--match-tools TOOLSSTATE",
+         description: "match tools state"
 
   option :hostname,
-         long: '--hostname',
-         description: 'show hostname of the guest'
+         long: "--hostname",
+         description: "show hostname of the guest"
 
   option :host_name,
-         long: '--host_name',
-         description: 'show name of the VMs host'
+         long: "--host_name",
+         description: "show name of the VMs host"
 
   option :os,
-         long: '--os',
-         description: 'show os details'
+         long: "--os",
+         description: "show os details"
 
   option :alarms,
-         long: '--alarms',
-         description: 'show alarm status'
+         long: "--alarms",
+         description: "show alarm status"
 
   option :tools,
-         long: '--tools',
-         description: 'show tools status'
+         long: "--tools",
+         description: "show tools status"
 
   option :full_path,
-         long: '--full-path',
-         description: 'Show full folder path to the VM'
+         long: "--full-path",
+         description: "Show full folder path to the VM"
 
   option :short_path,
-         long: '--short-path',
-         description: 'Show the VM\'s enclosing folder name'
+         long: "--short-path",
+         description: "Show the VM's enclosing folder name"
 
   $stdout.sync = true # smoother output from print
 
   # Main entry point to the command
   def run
-    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)
+    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)
+    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|
+      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 }
+          { "name" => net.network, "ip" => firstip.ipAddress, "prefix" => firstip.prefixLength }
         end
       end
     end
 
     if get_config(:os_disk)
-      property_map('guest.disk' => 'disks') do |disks|
+      property_map("guest.disk" => "disks") do |disks|
         disks.map do |disk|
-          { 'name' => disk.diskPath,
-            'capacity' => disk.capacity / 1024 / 1024,
-            'free' => disk.freeSpace / 1024 / 1024 }
+          { "name" => disk.diskPath,
+            "capacity" => disk.capacity / 1024 / 1024,
+            "free" => disk.freeSpace / 1024 / 1024 }
         end
       end
     end
@@ -165,8 +165,8 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
                           end
       end
 
-      thisvm['folder'] = full_path_to(vm) if get_config(:full_path)
-      thisvm['folder'] = vm.obj.parent.name if get_config(:short_path)
+      thisvm["folder"] = full_path_to(vm) if get_config(:full_path)
+      thisvm["folder"] = vm.obj.parent.name if get_config(:short_path)
 
       thisvm
     end
@@ -195,11 +195,11 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
   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'])
+    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
 
   def match_name?(name)
@@ -217,7 +217,7 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
   end
 
   def match_ip?(ip)
-    ip ||= 'NOTANIP'
+    ip ||= "NOTANIP"
     !get_config(:matchip) || ip.include?(get_config(:matchip))
   end
 
@@ -228,11 +228,11 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
   def state_to_english(power_state)
     case power_state
     when PS_ON
-      'on'
+      "on"
     when PS_OFF
-      'off'
+      "off"
     when PS_SUSPENDED
-      'suspended'
+      "suspended"
     end
   end
 
@@ -244,6 +244,6 @@ class Chef::Knife::VsphereVmFind < Chef::Knife::BaseVsphereCommand
       path.unshift iterator.name
     end
 
-    path.join '/'
+    path.join "/"
   end
 end