knife-vsphere 2.1.1 → 2.1.3

data/lib/chef/knife/vsphere_vm_network_set.rb

@@ -2,21 +2,21 @@
 # Author:: Owen Groves (<omgroves@gmail.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"
 
 # Changes network on a certain VM
 # VsphereVmNetworkSet extends the BaseVspherecommand
 class Chef::Knife::VsphereVmNetworkSet < Chef::Knife::BaseVsphereCommand
   include SearchHelper
-  banner 'knife vsphere vm network set VMNAME NETWORKNAME'
+  banner "knife vsphere vm network set VMNAME NETWORKNAME"
 
   common_options
 
   option :nic,
-    long: '--nic INTEGER',
-    description: 'Network interface to use when multiple NICs are present on the VM. (0,1..)',
+    long: "--nic INTEGER",
+    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
@@ -27,11 +27,11 @@ class Chef::Knife::VsphereVmNetworkSet < Chef::Knife::BaseVsphereCommand
     networkname = @name_args[1]
     if vmname.nil?
       show_usage
-      fatal_exit('You must specify a virtual machine name')
+      fatal_exit("You must specify a virtual machine name")
     end
     if networkname.nil?
       show_usage
-      fatal_exit('You must specify a network name')
+      fatal_exit("You must specify a network name")
     end
 
     network = find_network(networkname)
@@ -43,9 +43,9 @@ class Chef::Knife::VsphereVmNetworkSet < Chef::Knife::BaseVsphereCommand
     elsif network.is_a? RbVmomi::VIM::Network
       nic.backing = RbVmomi::VIM.VirtualEthernetCardNetworkBackingInfo(deviceName: network.name)
     else
-      fatal_exit('Network type not recognized')
+      fatal_exit("Network type not recognized")
     end
-    change_spec = RbVmomi::VIM.VirtualMachineConfigSpec(deviceChange: [RbVmomi::VIM.VirtualDeviceConfigSpec(device: nic, operation: 'edit')])
+    change_spec = RbVmomi::VIM.VirtualMachineConfigSpec(deviceChange: [RbVmomi::VIM.VirtualDeviceConfigSpec(device: nic, operation: "edit")])
     vm.ReconfigVM_Task(spec: change_spec).wait_for_completion
   end
 end

data/lib/chef/knife/vsphere_vm_property_get.rb

@@ -1,14 +1,14 @@
 # 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"
 
 # VsphereVMPropertyget extends the BaseVspherecommand
 class Chef::Knife::VsphereVmPropertyGet < Chef::Knife::BaseVsphereCommand
   include SearchHelper
-  banner 'knife vsphere vm property get VMNAME PROPERTY.  Gets a vApp Property on VMNAME.'
+  banner "knife vsphere vm property get VMNAME PROPERTY.  Gets a vApp Property on VMNAME."
 
   common_options
 
@@ -19,19 +19,19 @@ class Chef::Knife::VsphereVmPropertyGet < Chef::Knife::BaseVsphereCommand
     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
 
     property_name = @name_args[1]
     if property_name.nil?
       show_usage
-      fatal_exit('You must specify a PROPERTY name (e.g. annotation)')
+      fatal_exit("You must specify a PROPERTY name (e.g. annotation)")
     end
     property_name = property_name.to_sym
 
     vm = get_vm_by_name(vmname, get_config(:folder)) || fatal_exit("Could not find #{vmname}")
 
-    existing_property = vm.config.vAppConfig.property.find { |p| p.props[:id] == property_name.to_s  }
+    existing_property = vm.config.vAppConfig.property.find { |p| p.props[:id] == property_name.to_s }
 
     if existing_property
       puts existing_property.props[:value]

data/lib/chef/knife/vsphere_vm_property_set.rb

@@ -1,20 +1,20 @@
 # 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"
 
 # VsphereVMPropertySet extends Basevspherecommand
 class Chef::Knife::VsphereVmPropertySet < Chef::Knife::BaseVsphereCommand
   include SearchHelper
-  banner 'knife vsphere vm property set VMNAME PROPERTY VALUE.  Sets a vApp Property on VMNAME.'
+  banner "knife vsphere vm property set VMNAME PROPERTY VALUE.  Sets a vApp Property on VMNAME."
 
   common_options
 
   option :ovf_environment_transport,
-         long: '--ovf-environment-transport STRING',
-         description: 'Comma delimited string.  Configures the transports to use for properties. Supported values are: iso and com.vmware.guestInfo.'
+         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
   #
@@ -23,20 +23,20 @@ class Chef::Knife::VsphereVmPropertySet < Chef::Knife::BaseVsphereCommand
     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
 
     property_name = @name_args[1]
     if property_name.nil?
       show_usage
-      fatal_exit('You must specify a PROPERTY name (e.g. annotation)')
+      fatal_exit("You must specify a PROPERTY name (e.g. annotation)")
     end
     property_name = property_name.to_sym
 
     property_value = @name_args[2]
     if property_value.nil?
       show_usage
-      fatal_exit('You must specify a PROPERTY value')
+      fatal_exit("You must specify a PROPERTY value")
     end
 
     vim_connection
@@ -46,14 +46,14 @@ class Chef::Knife::VsphereVmPropertySet < Chef::Knife::BaseVsphereCommand
     vm = get_vm_by_name(vmname, get_config(:folder)) || fatal_exit("Could not find #{vmname}")
 
     if vm.config.vAppConfig && vm.config.vAppConfig.property
-      existing_property = vm.config.vAppConfig.property.find { |p| p.props[:id] == property_name.to_s  }
+      existing_property = vm.config.vAppConfig.property.find { |p| p.props[:id] == property_name.to_s }
     end
 
     if existing_property
-      operation = 'edit'
+      operation = "edit"
       property_key = existing_property.props[:key]
     else
-      operation = 'add'
+      operation = "add"
       property_key = property_name.object_id
     end
 
@@ -65,9 +65,9 @@ class Chef::Knife::VsphereVmPropertySet < Chef::Knife::BaseVsphereCommand
             info: {
               key: property_key,
               id: property_name.to_s,
-              type: 'string',
+              type: "string",
               userConfigurable: true,
-              value: property_value
+              value: property_value,
             }
           )
         ]
@@ -75,8 +75,8 @@ class Chef::Knife::VsphereVmPropertySet < Chef::Knife::BaseVsphereCommand
     )
 
     unless config[:ovf_environment_transport].nil?
-      transport = config[:ovf_environment_transport].split(',')
-      transport = [''] if transport == [] ## because "".split returns [] and vmware wants [""]
+      transport = config[:ovf_environment_transport].split(",")
+      transport = [""] if transport == [] ## because "".split returns [] and vmware wants [""]
       vm_config_spec[:vAppConfig][:ovfEnvironmentTransport] = transport
     end
 

data/lib/chef/knife/vsphere_vm_show.rb

@@ -1,14 +1,14 @@
 # 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"
 
 # VsphereVmShow extends the BaseVspherecommand
 class Chef::Knife::VsphereVmShow < Chef::Knife::BaseVsphereCommand
   include SearchHelper
-  banner "knife vsphere vm show VMNAME QUERY.  See \"http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.VirtualMachine.html\" for allowed QUERY values."
+  banner 'knife vsphere vm show VMNAME QUERY.  See "http://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.VirtualMachine.html" for allowed QUERY values.'
 
   common_options
 
@@ -19,19 +19,19 @@ class Chef::Knife::VsphereVmShow < 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
 
     if @name_args.empty?
       show_usage
-      fatal_exit('You must specify a QUERY value (e.g. guest.ipAddress or network[0].name)')
+      fatal_exit("You must specify a QUERY value (e.g. guest.ipAddress or network[0].name)")
     end
 
     vm = get_vm_by_name(vmname, get_config(:folder)) || fatal_exit("Could not find #{vmname}")
 
     out = @name_args.map do |query_string|
       # split QUERY by dots, and walk the object model
-      query = query_string.split '.'
+      query = query_string.split "."
       result = vm
       query.each do |part|
         message, index = part.split(/[\[\]]/)
@@ -43,6 +43,6 @@ class Chef::Knife::VsphereVmShow < Chef::Knife::BaseVsphereCommand
 
       { query_string => result }
     end
-  ui.output out
+    ui.output out
   end
 end

data/lib/chef/knife/vsphere_vm_snapshot.rb

@@ -2,68 +2,68 @@
 # 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"
 
 # Manage snapshots of a virtual machine
 class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
   include SearchHelper
-  banner 'knife vsphere vm snapshot VMNAME (options)'
+  banner "knife vsphere vm snapshot VMNAME (options)"
 
   common_options
 
   option :list,
-         long: '--list',
-         description: 'The current tree of snapshots'
+         long: "--list",
+         description: "The current tree of snapshots"
 
   option :create_new_snapshot,
-         long: '--create SNAPSHOT',
-         description: 'Create a new snapshot off of the current snapshot.'
+         long: "--create SNAPSHOT",
+         description: "Create a new snapshot off of the current snapshot."
 
   option :remove_named_snapshot,
-         long: '--remove SNAPSHOT',
-         description: 'Remove a named snapshot.'
+         long: "--remove SNAPSHOT",
+         description: "Remove a named snapshot."
 
   option :revert_snapshot,
-         long: '--revert SNAPSHOT',
-         description: 'Revert to a named snapshot.'
+         long: "--revert SNAPSHOT",
+         description: "Revert to a named snapshot."
 
   option :revert_current_snapshot,
-         long: '--revert-current',
-         description: 'Revert to current snapshot.',
+         long: "--revert-current",
+         description: "Revert to current snapshot.",
          boolean: false
 
   option :power,
-         long: '--start',
-         description: 'Indicates whether to start the VM after a successful revert',
+         long: "--start",
+         description: "Indicates whether to start the VM after a successful revert",
          boolean: false
 
   option :wait,
-         long: '--wait',
-         description: 'Indicates whether to wait for creation/removal to complete',
+         long: "--wait",
+         description: "Indicates whether to wait for creation/removal to complete",
          boolean: false
 
   option :find, # imma deprecate this
-         long: '--find',
-         description: 'Finds the virtual machine by searching all folders'
+         long: "--find",
+         description: "Finds the virtual machine by searching all folders"
 
   option :dump_memory,
-         long: '--dump-memory',
+         long: "--dump-memory",
          boolean: true,
-         description: 'Dump the memory in the snapshot',
+         description: "Dump the memory in the snapshot",
          default: false
 
   option :quiesce,
-         long: '--quiesce',
+         long: "--quiesce",
          boolean: true,
-         description: 'Quiesce the VM prior to snapshotting',
+         description: "Quiesce the VM prior to snapshotting",
          default: false
 
   option :snapshot_description,
-         long: '--snapshot-descr DESCR',
-         description: 'Snapshot description',
-         default: ''
+         long: "--snapshot-descr DESCR",
+         description: "Snapshot description",
+         default: ""
 
   def run
     $stdout.sync = true
@@ -71,7 +71,7 @@ class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
     vmname = @name_args[0]
     if vmname.nil?
       show_usage
-      ui.fatal('You must specify a virtual machine name')
+      ui.fatal("You must specify a virtual machine name")
       exit 1
     end
 
@@ -105,7 +105,7 @@ class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
     end
 
     if get_config(:revert_current_snapshot)
-      puts 'Reverting to Current Snapshot'
+      puts "Reverting to Current Snapshot"
       vm.RevertToCurrentSnapshot_Task(suppressPowerOn: false).wait_for_completion
       if get_config(:power)
         vm.PowerOnVM_Task.wait_for_completion
@@ -137,12 +137,12 @@ class Chef::Knife::VsphereVmSnapshot < Chef::Knife::BaseVsphereCommand
 
   def display_node(node, current)
     children = node.childSnapshotList.map { |item| display_node(item, current) }
-    snapshot_tree = { 'SnapshotName' => node.name,
-                      'SnapshotId' => node.id,
-                      'SnapshotDescription' => node.description,
-                      'SnapshotCreationDate' => node.createTime.iso8601,
-                      'Children' => children }
-    snapshot_tree.merge!({ 'IsCurrentSnapshot' => true }) if node.snapshot == current
+    snapshot_tree = { "SnapshotName" => node.name,
+                      "SnapshotId" => node.id,
+                      "SnapshotDescription" => node.description,
+                      "SnapshotCreationDate" => node.createTime.iso8601,
+                      "Children" => children }
+    snapshot_tree["IsCurrentSnapshot"] = true if node.snapshot == current
     snapshot_tree
   end
 end

data/lib/chef/knife/vsphere_vm_state.rb

@@ -3,9 +3,9 @@
 # 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"
 
 # Manage power state of a virtual machine
 # VsphereVmState extends the BaseVspherecommand
@@ -13,34 +13,34 @@ class Chef::Knife::VsphereVmState < Chef::Knife::BaseVsphereCommand
   include SearchHelper
   # The Different power states that vSphere reports
   POWER_STATES = {
-    PS_ON => 'powered on',
-    PS_OFF => 'powered off',
-    PS_SUSPENDED => 'suspended'
-  }
+    PS_ON => "powered on",
+    PS_OFF => "powered off",
+    PS_SUSPENDED => "suspended",
+  }.freeze
 
-  banner 'knife vsphere vm state VMNAME (options)'
+  banner "knife vsphere vm state VMNAME (options)"
 
   common_options
 
   option :state,
-         short: '-s STATE',
-         long: '--state STATE',
-         description: 'The power state to transition the VM into; one of on|off|suspended|reboot'
+         short: "-s STATE",
+         long: "--state STATE",
+         description: "The power state to transition the VM into; one of on|off|suspended|reboot"
 
   option :wait_port,
-         short: '-w PORT',
-         long: '--wait-port PORT',
-         description: 'Wait for VM to be accessible on a port'
+         short: "-w PORT",
+         long: "--wait-port PORT",
+         description: "Wait for VM to be accessible on a port"
 
   option :shutdown,
-         short: '-g',
-         long: '--shutdown',
-         description: 'Guest OS shutdown'
+         short: "-g",
+         long: "--shutdown",
+         description: "Guest OS shutdown"
 
   option :recursive,
-         short: '-r',
-         long: '--recursive',
-         description: 'Search all folders'
+         short: "-r",
+         long: "--recursive",
+         description: "Search all folders"
 
   # The main run method for vm_state
   #
@@ -50,7 +50,7 @@ class Chef::Knife::VsphereVmState < Chef::Knife::BaseVsphereCommand
     vmname = @name_args[0]
     if vmname.nil?
       show_usage
-      ui.fatal('You must specify a virtual machine name')
+      ui.fatal("You must specify a virtual machine name")
       exit 1
     end
 
@@ -65,14 +65,14 @@ class Chef::Knife::VsphereVmState < Chef::Knife::BaseVsphereCommand
     else
 
       case config[:state]
-      when 'on'
+      when "on"
         if state == PS_ON
           puts "Virtual machine #{vmname} was already powered on"
         else
           vm.PowerOnVM_Task.wait_for_completion
           puts "Powered on virtual machine #{vmname}"
         end
-      when 'off'
+      when "off"
         if state == PS_OFF
           puts "Virtual machine #{vmname} was already powered off"
         else
@@ -81,33 +81,33 @@ class Chef::Knife::VsphereVmState < Chef::Knife::BaseVsphereCommand
             print "Waiting for virtual machine #{vmname} to shut down..."
             until vm.runtime.powerState == PS_OFF
               sleep 2
-              print '.'
+              print "."
             end
-            puts 'done'
+            puts "done"
           else
             vm.PowerOffVM_Task.wait_for_completion
             puts "Powered off virtual machine #{vmname}"
           end
         end
-      when 'suspend'
-        if state == POWER_STATES['suspended']
+      when "suspend"
+        if state == POWER_STATES["suspended"]
           puts "Virtual machine #{vmname} was already suspended"
         else
           vm.SuspendVM_Task.wait_for_completion
           puts "Suspended virtual machine #{vmname}"
         end
-      when 'reset'
+      when "reset"
         vm.ResetVM_Task.wait_for_completion
         puts "Reset virtual machine #{vmname}"
-      when 'reboot'
+      when "reboot"
         vm.RebootGuest
         puts "Reboot virtual machine #{vmname}"
       end
 
       if get_config(:wait_port)
         print "Waiting for port #{get_config(:wait_port)}..."
-        print '.' until tcp_test_port_vm(vm, get_config(:wait_port))
-        puts 'done'
+        print "." until tcp_test_port_vm(vm, get_config(:wait_port))
+        puts "done"
       end
     end
   end