vagrant-vmware-esxi 1.5.1 → 2.0.1

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

@@ -36,7 +36,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true

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

@@ -85,9 +85,9 @@ module VagrantPlugins
               $esxi_password = ''
               esxi_password_key = config.esxi_password.gsub(/key:/i, '').chomp
               if esxi_password_key.empty?
-                config.esxi_private_keys = config.system_private_keys_path
+                config.local_private_keys = config.system_private_keys_path
               else
-                config.esxi_private_keys = esxi_password_key
+                config.local_private_keys = esxi_password_key
               end
             else
               # Use plain text password from config
@@ -109,8 +109,8 @@ module VagrantPlugins
             '*', '%2a').gsub('?', '%3f').gsub(\
             '$', '%24')
 
-          @logger.info('vagrant-vmware-esxi, connect_esxi: esxi_private_keys: '\
-                       "#{config.esxi_private_keys}")
+          @logger.info('vagrant-vmware-esxi, connect_esxi: local_private_keys: '\
+                       "#{config.local_private_keys}")
 
           #
           #  Test ESXi host connectivity
@@ -119,7 +119,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true
@@ -149,7 +149,7 @@ module VagrantPlugins
             elsif config.esxi_password =~ %r{^file:}i
               access_error_message = "file:#{esxi_password_file}"
             elsif config.esxi_password =~ %r{^key:}i
-              access_error_message = "key:#{config.esxi_private_keys}"
+              access_error_message = "key:#{config.local_private_keys}"
             else
               access_error_message = 'password in Vagrantfile'
             end

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

@@ -31,7 +31,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true

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

@@ -36,8 +36,8 @@ module VagrantPlugins
             env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
                                  message: 'Attempting to package')
 
-            if (config.allow_overwrite =~ %r{true}i) ||
-               (config.allow_overwrite =~ %r{yes}i)
+            if (config.local_allow_overwrite =~ %r{true}i) ||
+               (config.local_allow_overwrite =~ %r{yes}i)
               overwrite_opts = '--overwrite'
             else
               overwrite_opts = nil
@@ -53,7 +53,7 @@ module VagrantPlugins
             if File.exists?("#{boxname}.box") && overwrite_opts.nil?
               raise Errors::GeneralError,
                     message: "#{boxname}.box already exists.  Set \n"\
-                             "  allow_overwrite='True' in Vagrantfile for force."
+                             "  local_allow_overwrite='True' in Vagrantfile for force."
             end
 
             # Find a tar/bsdtar

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

@@ -39,7 +39,7 @@ module VagrantPlugins
           Net::SSH.start(config.esxi_hostname, config.esxi_username,
             password:                   $esxi_password,
             port:                       config.esxi_hostport,
-            keys:                       config.esxi_private_keys,
+            keys:                       config.local_private_keys,
             timeout:                    20,
             number_of_password_prompts: 0,
             non_interactive:            true

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

@@ -44,7 +44,7 @@ module VagrantPlugins
           Net::SSH.start(config.esxi_hostname, config.esxi_username,
             password:                   $esxi_password,
             port:                       config.esxi_hostport,
-            keys:                       config.esxi_private_keys,
+            keys:                       config.local_private_keys,
             timeout:                    20,
             number_of_password_prompts: 0,
             non_interactive:            true

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

@@ -41,7 +41,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true,

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

@@ -29,8 +29,8 @@ module VagrantPlugins
           config = env[:machine].provider_config
 
           #  Number of nics configured
-          if config.virtual_network.is_a? Array
-            number_of_adapters = config.virtual_network.count
+          if config.esxi_virtual_network.is_a? Array
+            number_of_adapters = config.esxi_virtual_network.count
           else
             number_of_adapters = 1
           end
@@ -86,7 +86,7 @@ module VagrantPlugins
                     interface: index,
                     type: :static,
                     use_dhcp_assigned_default_route: options[:use_dhcp_assigned_default_route],
-                    mac_address: options[:mac],
+                    guest_mac_address: options[:mac],
                     ip: options[:ip],
                     netmask: netmask,
                     gateway: options[:gateway]
@@ -97,14 +97,14 @@ module VagrantPlugins
                     interface: index,
                     type: :dhcp,
                     use_dhcp_assigned_default_route: options[:use_dhcp_assigned_default_route],
-                    mac_address: options[:mac]
+                    guest_mac_address: options[:mac]
                   }
                   ip_msg = 'dhcp'
                   netmask = ''
                 end
                 networks_to_configure << network
                 env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
-                                     message: "Configuring     : #{ip_msg}#{netmask} on #{config.virtual_network[index]}")
+                                     message: "Configuring     : #{ip_msg}#{netmask} on #{config.esxi_virtual_network[index]}")
               end
             end
 

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

@@ -37,7 +37,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true,

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

@@ -34,7 +34,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true

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

@@ -34,7 +34,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true

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

@@ -37,7 +37,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true,

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

@@ -22,6 +22,7 @@ module VagrantPlugins
           # Get config.
           machine = env[:machine]
           config = env[:machine].provider_config
+          time = Time.new
 
           @logger.info("vagrant-vmware-esxi, snapshot_save: machine id: #{machine.id}")
           @logger.info("vagrant-vmware-esxi, snapshot_save: current state: #{env[:machine_state]}")
@@ -37,7 +38,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true,
@@ -45,8 +46,32 @@ module VagrantPlugins
               keepalive_interval:         30
             ) do |ssh|
 
-              puts "machine id: #{machine.id}  snapshot name: #{env[:snapshot_name]}"
-              r = ssh.exec!("vim-cmd vmsvc/snapshot.create #{machine.id} \"#{env[:snapshot_name]}\"")
+              env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                   message: "snapshot name      : #{env[:snapshot_name]}")
+
+              if RUBY_PLATFORM =~ /win/i
+                username_msg = ENV['USERNAME'] unless ENV['USERNAME'].nil?
+              else
+                username_msg = ENV['USER'] unless ENV['USER'].nil?
+              end
+              username_msg = "Unknown" if username_msg.nil?
+
+              options_msg = ''
+              options_msg << ' ' + config.guest_snapshot_includememory unless config.guest_snapshot_includememory.nil?
+              options_msg << ' ' + config.guest_snapshot_quiesced unless config.guest_snapshot_quiesced.nil?
+              options_msg = "Options:" + options_msg if options_msg.length > 2
+
+              snapshot_msg = time.localtime.to_s + ", Snapshot created using Vagrant-vmware-esxi by " +\
+                              username_msg + "\n#{options_msg}"
+
+              if config.debug =~ %r{true}i
+                env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                     message: "snapshot_msg: #{snapshot_msg}")
+              end
+
+              r = ssh.exec!("vim-cmd vmsvc/snapshot.create #{machine.id} "\
+                "\"#{env[:snapshot_name]}\" \"#{snapshot_msg}\" "\
+                "#{config.guest_snapshot_includememor} #{config.guest_snapshot_quiesced}")
 
               if r.exitstatus != 0
                 raise Errors::ESXiError,

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

@@ -40,7 +40,7 @@ module VagrantPlugins
             Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
-              keys:                       config.esxi_private_keys,
+              keys:                       config.local_private_keys,
               timeout:                    20,
               number_of_password_prompts: 0,
               non_interactive:            true,

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

@@ -8,70 +8,92 @@ module VagrantPlugins
       attr_accessor :esxi_hostport
       attr_accessor :esxi_username
       attr_accessor :esxi_password
-      attr_accessor :esxi_private_keys
-      attr_accessor :ssh_username
-      attr_accessor :private_key_path
-      attr_accessor :vmname
-      attr_accessor :vmname_prefix
-      attr_accessor :guestos
-      attr_accessor :vm_disk_store
-      attr_accessor :vm_disk_type
-      attr_accessor :virtual_network
-      attr_accessor :nic_type
-      attr_accessor :mac_address
-      attr_accessor :resource_pool
-      attr_accessor :memsize
-      attr_accessor :numvcpus
-      attr_accessor :virtualhw_version
-      attr_accessor :custom_vmx_settings
-      attr_accessor :allow_overwrite
+      attr_accessor :esxi_disk_store
+      attr_accessor :esxi_virtual_network
+      attr_accessor :esxi_resource_pool
+      attr_accessor :guest_username
+      attr_accessor :guest_name
+      attr_accessor :guest_name_prefix
+      attr_accessor :guest_guestos
+      attr_accessor :guest_disk_type
+      attr_accessor :guest_nic_type
+      attr_accessor :guest_mac_address
+      attr_accessor :guest_memsize
+      attr_accessor :guest_numvcpus
+      attr_accessor :guest_virtualhw_version
+      attr_accessor :guest_snapshot_includememory
+      attr_accessor :guest_snapshot_quiesced
+      attr_accessor :guest_custom_vmx_settings
+      attr_accessor :local_private_keys
+      attr_accessor :local_allow_overwrite
+      attr_accessor :local_lax
+      attr_accessor :local_private_keys_path
       attr_accessor :debug
-      attr_accessor :lax
-      attr_accessor :system_private_keys_path
-      attr_accessor :supported_virtualhw_versions
-      attr_accessor :supported_vm_disk_types
-      attr_accessor :supported_nic_types
-      attr_accessor :supported_guestos
+      attr_accessor :supported_guest_virtualhw_versions
+      attr_accessor :supported_guest_disk_types
+      attr_accessor :supported_guest_nic_types
+      attr_accessor :supported_guest_guestos
+
+      #
+      #  legacy (1.x) config entries
+      attr_accessor :esxi_private_keys   # esxi_password
+      attr_accessor :ssh_username        # guest_username
+      attr_accessor :vmname              # guest_name
+      attr_accessor :vmname_prefix       # guest_name_prefix
+      attr_accessor :guestos             # guest_guestos
+      attr_accessor :vm_disk_store       # esxi_disk_store
+      attr_accessor :vm_disk_type        # guest_disk_type
+      attr_accessor :virtual_network     # esxi_virtual_network
+      attr_accessor :nic_type            # guest_nic_type
+      attr_accessor :mac_address         # guest_mac_address
+      attr_accessor :resource_pool       # esxi_resource_pool
+      attr_accessor :memsize             # guest_memsize
+      attr_accessor :numvcpus            # guest_numvcpus
+      attr_accessor :virtualhw_version   # guest_virtualhw_version
+      attr_accessor :custom_vmx_settings # guest_custom_vmx_settings
+      attr_accessor :allow_overwrite     # local_allow_overwrite
+      attr_accessor :lax                 # local_lax
 
       def initialize
         @esxi_hostname = nil
         @esxi_hostport = 22
         @esxi_username = 'root'
         @esxi_password = nil
-        @esxi_private_keys = UNSET_VALUE
-        @ssh_username = 'vagrant'
-        @private_key_path = UNSET_VALUE
-        @vmname = nil
-        @vmname_prefix = 'V-'
-        @guestos = nil
-        @vm_disk_store = nil
-        @vm_disk_type = nil
-        @virtual_network = nil
-        @nic_type = nil
-        @mac_address = ["","","",""]
-        @resource_pool = nil
-        @memsize = UNSET_VALUE
-        @numvcpus = UNSET_VALUE
-        @virtualhw_version = nil
-        @custom_vmx_settings = UNSET_VALUE
-        @allow_overwrite = 'False'
+        @esxi_disk_store = nil
+        @esxi_virtual_network = nil
+        @esxi_resource_pool = nil
+        @guest_username = 'vagrant'
+        @guest_name = nil
+        @guest_name_prefix = 'V-'
+        @guest_guestos = nil
+        @guest_disk_type = nil
+        @guest_nic_type = nil
+        @guest_mac_address = ["","","",""]
+        @guest_memsize = nil
+        @guest_numvcpus = nil
+        @guest_virtualhw_version = nil
+        @guest_snapshot_includememory = 'False'
+        @guest_snapshot_quiesced = 'False'
+        @guest_custom_vmx_settings = nil
+        @local_private_keys = nil
+        @local_allow_overwrite = 'False'
+        @local_lax = 'False'
         @debug = 'False'
-        @lax = 'False'
         @system_private_keys_path = [
           '~/.ssh/id_rsa',
           '~/.ssh/id_ecdsa',
           '~/.ssh/id_ed25519',
           '~/.ssh/id_dsa'
         ]
-        @supported_virtualhw_versions = [
+        @supported_guest_virtualhw_versions = [
           4,7,8,9,10,11,12,13
         ]
-        @supported_vm_disk_types = [
+        @supported_guest_disk_types = [
           'thin',
           'thick',
           'eagerzeroedthick'
         ]
-        @supported_nic_types = [
+        @supported_guest_nic_types = [
           'vlance',
           'flexible',
           'e1000',
@@ -80,7 +102,7 @@ module VagrantPlugins
           'vmxnet2',
           'vmxnet3'
         ]
-        @supported_guestos = [
+        @supported_guest_guestos = [
           'asianux3-64',
           'asianux3',
           'asianux4-64',
@@ -230,25 +252,132 @@ module VagrantPlugins
           'winXPPro-64',
           'winXPPro'
         ]
+
+        # Legacy (1.x)
+        @esxi_private_keys = nil
+        @ssh_username = nil
+        @vmname = nil
+        @vmname_prefix = nil
+        @guestos = nil
+        @vm_disk_store = nil
+        @vm_disk_type = nil
+        @virtual_network = nil
+        @nic_type = nil
+        @mac_address = nil
+        @resource_pool = nil
+        @memsize = nil
+        @numvcpus = nil
+        @virtualhw_version = nil
+        @custom_vmx_settings = nil
+        @allow_overwrite = nil
+        @lax = nil
       end
 
       def finalize!
-        @private_key_path = nil if @private_key_path == UNSET_VALUE
-        @ssh_username = nil if @ssh_username == UNSET_VALUE
-        if @virtual_network.is_a? String
-          @virtual_network = [@virtual_network]
+
+        #  Migrate legacy(1.x) parms to 2.0
+        migrate_msg = ""
+        unless @esxi_private_keys.nil?
+          migrate_msg << "You should migrate legacy option esxi_private_keys to esxi_password = \"key:\" in Vagrant file.\n"
+        end
+        unless @ssh_username.nil?
+          migrate_msg << "You should migrate legacy option ssh_username to guest_username in Vagrant file.\n"
+          @guest_username = @ssh_username.dup
+        end
+        unless @vmname.nil?
+          migrate_msg << "You should migrate legacy option vmname to guest_name in Vagrant file.\n"
+          @guest_name = @vmname.dup
+        end
+        unless @vmname_prefix.nil?
+          migrate_msg << "You should migrate legacy option vmname_prefix to guest_name_prefix in Vagrant file.\n"
+          @guest_name_prefix = @vmname_prefix.dup
+        end
+        unless @guestos.nil?
+          migrate_msg << "You should migrate legacy option guestos to guest_guestos in Vagrant file.\n"
+          @guest_guestos = @guestos.dup
+        end
+        unless @vm_disk_store.nil?
+          migrate_msg << "You should migrate legacy option vm_disk_store to esxi_disk_store in Vagrant file.\n"
+          @esxi_disk_store = @vm_disk_store.dup
         end
-        if @virtual_network.nil?
-          @virtual_network = ['--NotSet--']
+        unless @vm_disk_type.nil?
+          migrate_msg << "You should migrate legacy option vm_disk_type to guest_disk_type in Vagrant file.\n"
+          @guest_disk_type = @vm_disk_type.dup
         end
-        @esxi_private_keys = @system_private_keys_path if @esxi_private_keys == UNSET_VALUE
-        if @lax =~ /true/i
-          @lax = 'True'
+        unless @virtual_network.nil?
+          migrate_msg << "You should migrate legacy option virtual_network to esxi_virtual_network in Vagrant file.\n"
+          @esxi_virtual_network = @virtual_network.dup
+        end
+        unless @nic_type.nil?
+          migrate_msg << "You should migrate legacy option nic_type to guest_nic_type in Vagrant file.\n"
+          @guest_nic_type = @nic_type.dup
+        end
+        unless @mac_address.nil?
+          migrate_msg << "You should migrate legacy option mac_address to guest_mac_address in Vagrant file.\n"
+          @guest_mac_address = @mac_address.dup
+        end
+        unless @resource_pool.nil?
+          migrate_msg << "You should migrate legacy option resource_pool to esxi_resource_pool in Vagrant file.\n"
+          @esxi_resource_pool = @resource_pool.dup
+        end
+        unless @memsize.nil?
+          migrate_msg << "You should migrate legacy option memsize to guest_memsize in Vagrant file.\n"
+          @guest_memsize = @memsize.dup
+        end
+        unless @numvcpus.nil?
+          migrate_msg << "You should migrate legacy option numvcpus to guest_numvcpus in Vagrant file.\n"
+          @guest_numvcpus = @numvcpus.dup
+        end
+        unless @virtualhw_version.nil?
+          migrate_msg << "You should migrate legacy option virtualhw_version to guest_virtualhw_version in Vagrant file.\n"
+          @guest_virtualhw_version = @virtualhw_version.dup
+        end
+        unless @custom_vmx_settings.nil?
+          migrate_msg << "You should migrate legacy option custom_vmx_settings to guest_custom_vmx_settings in Vagrant file.\n"
+          @guest_custom_vmx_settings = @custom_vmx_settings.dup
+        end
+        unless @allow_overwrite.nil?
+          migrate_msg << "You should migrate legacy option allow_overwrite to local_allow_overwrite in Vagrant file.\n"
+          @local_allow_overwrite = @allow_overwrite.dup
+        end
+        unless @lax.nil?
+          migrate_msg << "You should migrate legacy option lax to local_lax in Vagrant file.\n"
+          @local_lax = @lax.dup
+        end
+
+        if $migrate_msg_flag.nil?
+          $migrate_msg_flag = 'True'
+          puts migrate_msg
+        end
+
+        @guest_username = nil if @guest_username == UNSET_VALUE
+
+        @esxi_virtual_network = [@esxi_virtual_network] if @esxi_virtual_network.is_a? String
+
+        @esxi_virtual_network = ['--NotSet--'] if @esxi_virtual_network.nil?
+
+        @local_private_keys = @system_private_keys_path if @local_private_keys == nil
+
+        # @guest_virtualhw_version = @guest_virtualhw_version.to_i unless @guest_virtualhw_version.nil?
+
+        if @local_lax =~ /true/i
+          @local_lax = 'True'
         else
-          @lax = 'False'
-        @virtualhw_version = @virtualhw_version.to_i unless @virtualhw_version.nil?
+          @local_lax = 'False'
+
+        end
+
+        if @guest_snapshot_includememory =~ /true/i
+          @guest_snapshot_includememory = 'includeMemory'
+        else
+          @guest_snapshot_includememory = ''
+       end
+       if @guest_snapshot_quiesced =~ /true/i
+         @guest_snapshot_quiesced = 'quiesced'
+       else
+         @guest_snapshot_quiesced = ''
        end
-     end
+      end
     end
   end
 end