vagrant-vmware-esxi 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b492ed5cff029e4fd8de183ed3fe60bb2cf7fa2
-  data.tar.gz: 398277bd2f8d457495d20364d02f8af7920e15d3
+  metadata.gz: 343c96c9a16c7657eecc7386265446c25d30918d
+  data.tar.gz: 8eb77a209ec5b5707d655210e420abaa14482795
 SHA512:
-  metadata.gz: fb9b631795bd52722a72fe6d2da9409a461680e90c4b2192867f4f0c46438b64b3c13885e0985e78442f1ad834ec14972fac0510d154c39458ae8882cac27827
-  data.tar.gz: 20c7f5420df573bd8b954fe4b31845129066c88b59b5ae4495c11d3f2f841e555f10df8c6ec638eb82555176101c28048f7c3fb3d5846545629166fdc6779664
+  metadata.gz: b9f8620e0c93b40a8f8892c823c7818cdd533578547adc9f6eeaa24a3edac91432303eb73d233fd97ffa0c736334dab49bee381f55b79e5afc50c3bb307577c8
+  data.tar.gz: dacca0c01725ff30f9174604016ea739b797485d7b4989011cfca602b91282dde14b39fa8dfae0acab0b5f6b8a3c4631374f0415dac58a7c16980bb0d35d8ca0

data/README.md

@@ -35,7 +35,7 @@ Features and Compatibility
 Requirements
 ------------
 1. This is a vagrant plugin, so you need vagrant installed...  :-)
-2. This plugin requires ovftool from VMware.  Download from VMware website.
+2. This plugin requires ovftool from VMware.  Download from VMware website.  NOTE: ovftool installer for windows doesn't put ovftool.exe in your path.  You can manually set your path, or install ovftool in the \HashiCorp\Vagrant\bin directory.
 >https://www.vmware.com/support/developer/ovf/
 3. You MUST enable ssh access on your ESXi hypervisor.
   * Google 'How to enable ssh access on esxi'
@@ -52,6 +52,7 @@ How to install
 Download and install Vagrant on your local system using instructions from https://vagrantup.com/downloads.html.   
 ```
 vagrant plugin install vagrant-vmware-esxi
+vagrant plugin list
 vagrant version
 ```
 How to use and configure a Vagrantfile
@@ -59,7 +60,7 @@ How to use and configure a Vagrantfile
 
 1. cd SOMEDIR
 1. `vagrant init`
-1. `vi Vagrantfile`  # See below to setup access your ESXi host and to set some preferences.
+1. `vi Vagrantfile`  # Replace the contents of Vagrantfile with the following example. Specify parameters to access your ESXi host, guest and local preferences.
 ```ruby
 #
 #  Fully documented Vagrantfile available
@@ -72,7 +73,7 @@ Vagrant.configure('2') do |config|
   #    https://www.vmware.com/support/developer/ovf/
   #
   #    If your box is stuck at 'Powered On', then most likely
-  #    the system doesn't have the vmware tools installed.
+  #    the box/vm doesn't have the vmware tools installed.
   #
   # Here are some of the MANY examples....
   config.vm.box = 'generic/centos7'
@@ -93,12 +94,16 @@ Vagrant.configure('2') do |config|
   config.vm.synced_folder('.', '/vagrant', type: 'rsync')
   config.vm.synced_folder('.', '/vagrant', type: 'nfs', disabled: true)
 
-  #  Vagrant can set a static IP for the additional network interfaces.  Use
-  #  public_network or private_network to manually set a static IP and
-  #  netmask.  ESXi doesn't use the concept of public or private networks so
-  #  both are valid here.  The primary network interface is considered the
-  #  "vagrant management" interface and cannot be changed,
-  #  so you can specify 3 entries here!
+  #  Vagrant can configure additional network interfaces using a static IP or
+  #  DHCP. Use public_network or private_network to manually set a static IP and
+  #  optionally netmask.  ESXi doesn't use the concept of public or private
+  #  networks so both are valid here.  The primary network interface is considered the
+  #  "vagrant management" interface and cannot be changed and this plugin
+  #  supports 4 NICS, so you can specify 3 entries here!
+  #
+  #  https://www.vagrantup.com/docs/networking/public_network.html
+  #  https://www.vagrantup.com/docs/networking/private_network.html
+  #
   #    *** Invalid settings could cause 'vagrant up' to fail ***
   #config.vm.network 'private_network', ip: '192.168.10.170', netmask: '255.255.255.0'
   #config.vm.network 'private_network', ip: '192.168.11.170'
@@ -127,11 +132,11 @@ Vagrant.configure('2') do |config|
     #  SSH port.
     #esxi.esxi_hostport = 22
 
-    #  HIGHLY RECOMMENDED!  Virtual Network
-    #    You should specify a Virtual Network!  If it's not specified, the
+    #  HIGHLY RECOMMENDED!  ESXi Virtual Network
+    #    You should specify an ESXi Virtual Network!  If it's not specified, the
     #    default is to use the first found.  You can specify up to 4 virtual
     #    networks using an array format.
-    #esxi.esxi_virtual_network = ['vmnet1','vmnet2','vmnet3','vmnet4']
+    #esxi.esxi_virtual_network = ['VM Network','VM Network2','VM Network3','VM Network4']
 
     #  OPTIONAL.  Specify a Disk Store
     #esxi.esxi_disk_store = 'DS_001'
@@ -174,7 +179,7 @@ Vagrant.configure('2') do |config|
     #esxi.guest_disk_type = 'thick'
 
     #  OPTIONAL.  Create additional storage for guests.
-    #    You can specify an array of upto 14 virtual disk sizes (in GB) that you
+    #    You can specify an array of up to 13 virtual disk sizes (in GB) that you
     #    would like the provider to create once the guest has been created.
     #esxi.guest_storage = [10,20]
 
@@ -212,27 +217,6 @@ Vagrant.configure('2') do |config|
 end
 ```
 
-Upgrading from vagrant-vmware-esxi 1.x.x
-----------------------------------------
-The following Vagrantfile parameters have been renamed for clarity.  The plugin still recognizes these legacy parameters, however it's recommended to migrate to the 2.x parameters.
-* esxi_private_keys --> esxi_password = "key:"
-* vm_disk_store --> esxi_disk_store
-* virtual_network --> esxi_virtual_network
-* resource_pool --> esxi_resource_pool
-* vmname --> guest_name
-* vmname_prefix --> guest_name_prefix
-* ssh_username --> guest_username
-* memsize --> guest_memsize
-* numvcpus --> guest_numvcpus
-* vm_disk_type --> guest_disk_type
-* nic_type --> guest_nic_type
-* mac_address --> guest_mac_address
-* guestos --> guest_guestos
-* virtualhw_version --> guest_virtualhw_version
-* custom_vmx_settings --> guest_custom_vmx_settings
-* lax --> local_lax
-* allow_overwrite --> local_allow_overwrite
-
 
 Basic usage
 -----------
@@ -243,6 +227,7 @@ Basic usage
   * `vagrant status`
   * `vagrant suspend`
   * `vagrant resume`
+  * `vagrant ssh-config`
   * `vagrant snapshot push`
   * `vagrant snapshot list`
   * `vagrant snapshot-info`
@@ -251,18 +236,28 @@ Basic usage
   * `vagrant provision`
 
 
+
+Upgrading from vagrant-vmware-esxi 1.x.x
+----------------------------------------
+See wiki for more information.
+>https://github.com/josenk/vagrant-vmware-esxi/wiki/Upgrading-from-vagrant-vmware-esxi-1.x.x
+
+
 Known issues with vmware_esxi
 -----------------------------
 * The boxes must have open-vm-tools or vmware-tools installed to properly transition to the 'running' state.
 * Invalid settings (bad IP address, netmask, MAC address, guest_custom_vmx_settings) could cause 'vagrant up' to fail.  Review vSphere console and/or ESXi logs to help debug why it failed.
 * Cleanup doesn't always destroy a VM that has been partially built.  Use the local_allow_overwrite = 'True' option if you need to force a rebuild, or you can delete the vm using the VSphere client.
 * ovftool installer for windows doesn't put ovftool.exe in your path.  You can manually set your path, or install ovftool in the \HashiCorp\Vagrant\bin directory.
-* In general I find the vagrant NFS synced folders a little 'flaky'...
-* V2.0.1 - 2.0.5 is not compatible with Windows (to support ed25519 ssh keys, net-ssh requires libsodium but it's not compatible with Windows).  Update to a newer version.
+* Vagrant NFS synced folders is not reliable on multi-homed clients (your vagrant pc/laptop/host).  There is no 100% reliable way to know which IP is the correct, most reliable, most desirable, etc...
+* V2.0.1 - 2.0.5 is not compatible with Windows (to support ed25519 ssh keys, net-ssh requires libsodium but it's not compatible with Windows).  ed25519 support has been removed for now.   It will be added back when net-ssh 5.x goes out of beta.
+* Cygwin & gitbash have console issues. Ruby module io/console does not have support.  https://github.com/ruby/io-console/issues/2
 
 
 Version History
 ---------------
+* 2.0.7 Fix, Doesn't wait for running when executing "vagrant reload"
+        Fix, "vagrant halt" will now attempt a graceful shutdown before doing a hard power off.
 * 2.0.6 Fix Windows compatibility by not supporting ed25519 ssh keys.  When net-ssh 5.x is released AND vagrant allows it's use, I will support ed25519 again.
         Fix, encode '/' in esxi passwords.
         Fix, Get local IP address for NFS syncd folders.  Filter out localhost 127.0.0.0/8.

data/lib/vagrant-vmware-esxi/action.rb

@@ -23,8 +23,18 @@ module VagrantPlugins
       def self.action_halt
         Vagrant::Action::Builder.new.tap do |b|
           b.use SetESXiPassword
-          b.use ReadState
-          b.use Halt
+          b.use Call, ReadState do |env1, b1|
+            if env1[:machine_state].to_s == 'running'
+              b1.use Shutdown
+              b1.use Call, WaitForState, :powered_off, 30 do |env1, b2|
+                unless env1[:result] == 'True'
+                  b2.use Halt
+                end
+              end
+            else
+              b1.use Halt
+            end
+          end
         end
       end
 
@@ -41,6 +51,7 @@ module VagrantPlugins
           b.use SetESXiPassword
           b.use ReadState
           b.use Resume
+          b.use WaitForState, :running, 240
         end
       end
 
@@ -78,17 +89,13 @@ module VagrantPlugins
       def self.action_snapshot_restore
         Vagrant::Action::Builder.new.tap do |b|
           b.use SetESXiPassword
-          b.use action_halt
+          b.use Halt
           b.use Call, WaitForState, :powered_off, 240 do |env1, b1|
             if env1[:result] == 'True'
               b1.use SnapshotRestore
               b1.use ReadState
               b1.use Boot
-              b1.use Call, WaitForState, :running, 240 do |env1, b2|
-                if env1[:result] == 'True'
-                  #
-                end
-              end
+              b1.use WaitForState, :running, 240
             end
           end
         end
@@ -107,7 +114,7 @@ module VagrantPlugins
           b.use SetESXiPassword
           b.use Call, ReadState do |env1, b1|
             unless env1[:machine_state] == 'powered_off'
-              b1.use action_halt
+              b1.use Halt
             end
             b1.use ReadState
             b1.use Destroy
@@ -178,6 +185,7 @@ module VagrantPlugins
       autoload :SetNetworkIP, action_root.join('set_network_ip')
       autoload :Boot, action_root.join('boot')
       autoload :Halt, action_root.join('halt')
+      autoload :Shutdown, action_root.join('shutdown')
       autoload :Destroy, action_root.join('destroy')
       autoload :Suspend, action_root.join('suspend')
       autoload :Resume, action_root.join('resume')

data/lib/vagrant-vmware-esxi/action/halt.rb

@@ -38,6 +38,7 @@ module VagrantPlugins
             ) do |ssh|
 
               r = ssh.exec!("vim-cmd vmsvc/power.off #{machine.id}")
+              config.saved_ipaddress = nil
 
               if r.exitstatus != 0
                 raise Errors::ESXiError,

data/lib/vagrant-vmware-esxi/action/resume.rb

@@ -50,6 +50,7 @@ module VagrantPlugins
             ) do |ssh|
 
               r = ssh.exec!("vim-cmd vmsvc/power.on #{machine.id}")
+              config.saved_ipaddress = nil
 
               if r.exitstatus != 0
                 raise Errors::ESXiError,

data/lib/vagrant-vmware-esxi/action/shutdown.rb

@@ -0,0 +1,55 @@
+require 'log4r'
+require 'net/ssh'
+
+module VagrantPlugins
+  module ESXi
+    module Action
+      # This action will start a graceful shutdown on the vm
+      class Shutdown
+        def initialize(app, _env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::shutdown')
+        end
+
+        def call(env)
+          shutdown(env)
+          @app.call(env)
+        end
+
+        def shutdown(env)
+          @logger.info('vagrant-vmware-esxi, shutdown: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          if env[:machine_state].to_s == 'powered_off'
+            env[:ui].info I18n.t('vagrant_vmware_esxi.already_powered_off')
+          elsif env[:machine_state].to_s == 'not_created'
+            env[:ui].info I18n.t('vagrant_vmware_esxi.already_destroyed')
+          else
+            env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                 message: "Starting graceful shutdown...")
+            Net::SSH.start(config.esxi_hostname, config.esxi_username,
+              password:                   $esxi_password,
+              port:                       config.esxi_hostport,
+              keys:                       config.local_private_keys,
+              timeout:                    20,
+              number_of_password_prompts: 0,
+              non_interactive:            true
+            ) do |ssh|
+
+              r = ssh.exec!("vim-cmd vmsvc/power.shutdown #{machine.id}")
+              config.saved_ipaddress = nil
+
+              if r.exitstatus != 0
+                raise Errors::ESXiError,
+                      message: "Unable to shutdown the VM:\n    #{r}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vmware-esxi/action/snapshot_restore.rb

@@ -51,6 +51,7 @@ module VagrantPlugins
                   "grep -A1 '.*Snapshot Name        : #{env[:snapshot_name]}$' | "\
                   "grep 'Snapshot Id'|awk '{print $NF}'` suppressPowerOn")
 
+              config.saved_ipaddress = nil
               if r.exitstatus != 0
                 raise Errors::ESXiError,
                       message: "Unable to restore snapshots of the VM:\n"\

data/lib/vagrant-vmware-esxi/version.rb

@@ -1,7 +1,7 @@
 #  VERSION
 module VagrantPlugins
   module ESXi
-    VERSION = '2.0.6'
+    VERSION = '2.0.7'
     $vagrant_vmware_esxi_version = VERSION
   end
 end

data/vagrant-vmware-esxi.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/vagrant-vmware-esxi/version', __FILE__)
 Gem::Specification.new do |s|
   s.name            = 'vagrant-vmware-esxi'
   s.version         = VagrantPlugins::ESXi::VERSION
-  s.date            = '2018-02-28'
+  s.date            = '2018-03-21'
   s.summary         = 'Vagrant ESXi provider plugin'
   s.description     = 'A Vagrant plugin that adds a VMware ESXi provider support'
   s.authors         = ['Jonathan Senkerik']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vmware-esxi
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors:
 - Jonathan Senkerik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -92,6 +92,7 @@ files:
 - lib/vagrant-vmware-esxi/action/read_state.rb
 - lib/vagrant-vmware-esxi/action/resume.rb
 - lib/vagrant-vmware-esxi/action/set_network_ip.rb
+- lib/vagrant-vmware-esxi/action/shutdown.rb
 - lib/vagrant-vmware-esxi/action/snapshot_delete.rb
 - lib/vagrant-vmware-esxi/action/snapshot_info.rb
 - lib/vagrant-vmware-esxi/action/snapshot_list.rb