vagrant-vmware-esxi 1.0.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f46516e196812b3fbbf49dd8ed7a46495e2fc218
-  data.tar.gz: 67954083f84d6379592369129bb39d38630d06cb
+  metadata.gz: 3301495dc2f6eedc70da07b146b713b93e27bd0f
+  data.tar.gz: 8f97dd15927c34cb105cfa28c59b9f7d49e8e218
 SHA512:
-  metadata.gz: 15957a2906621db58b7e98e335527728e8c10b5a1c173a3612119a9a45d1440df19443ebbef528c48fb6fb86b1ca114110da0d0e642997a45212cd35824e4b4f
-  data.tar.gz: afa0bbd2b7ef8a49126ccb261083e7cea70341a029b6ecfb5d75e91db99c2f38257dea094b87549e5b2a01e233626893cf4064d17ec7140bc97a8905cad01700
+  metadata.gz: af1a8de6400d7f4ef38bc8a6b80e8561ac6fb5fbf228cf858d3c5894ee320c7e017045734e041911fcde0490e29276f91986fbfeb2276dcbfbf27bc0715443fa
+  data.tar.gz: 27319e322ee0600a762e5c49591b9db54c6d22b7926ce751d6ecfa323cc28e0ee0a0108eeaa38a8f36ded661704cda9b0c4bfff7f0f44a8c97b829a386895b39

data/README.md

@@ -1,21 +1,22 @@
 vagrant-vmware-esxi plugin
 ==========================
-This is a Vagrant plugin that adds a VMware ESXi provider support.  This allows Vagrant to control and provision VMs directly on an ESXi hypervisor without a need for vCenter or VShpere.   ESXi hypervisor is a free download from VMware! 
+This is a Vagrant plugin that adds a VMware ESXi provider support.  This allows Vagrant to control and provision VMs directly on an ESXi hypervisor without a need for vCenter or VShpere.   ESXi hypervisor is a free download from VMware!
 >https://www.vmware.com/go/get-free-esxi
 
 
-Features
---------
+Features and Compatibility
+--------------------------
 * Any of the vmware Box formats should be compatible.
-  * vmware_destop, vmware_fusion, vmware_workstation...
+  * vmware_desktop, vmware_fusion, vmware_workstation...
 * Will automatically download boxes from the web.
 * Will automatically upload the box to your ESXi host.
 * Automatic or manual VM names.
   * Automatic VM names are "PREFIX-HOSTNAME-USERNAME-DIR".
 * Multi machine capable.
-* Supports adding your VM to a Resource Pools to partition CPU and memory usage from other VMs on your ESXi host.
-* suspend / resume
-* rsync, using built-in Vagrant synced folders.
+* Supports adding your VM to Resource Pools to partition CPU and memory usage from other VMs on your ESXi host.
+* suspend / resume.
+* snapshots.
+* rsync & NFS using built-in Vagrant synced folders.
 * Provision using built-in Vagrant provisioner.
 
 Requirements
@@ -60,13 +61,13 @@ Vagrant.configure("2") do |config|
   #config.vm.box = 'centos/7'
   #config.vm.box = 'bento/ubuntu-14.04'
 
-  #  Currently this tool supports rsync ONLY.   NFS is not working yet
+  #  Supports type rsync and NFS.
   config.vm.synced_folder('.', '/Vagrantfiles', type: 'rsync')
 
   #
   #  Provider (esxi) settings
   #
-  config.vm.provider :esxi do |esxi|
+  config.vm.provider :vmware_esxi do |esxi|
 
     #  REQUIRED!  ESXi hostname/IP
     #    You MUST specify a esxi_hostname or IP, uless you
@@ -81,10 +82,10 @@ Vagrant.configure("2") do |config|
     #  A NOTE about esxi_password / ssh keys!!
     #
     #    If you don't specify a password and do not use ssh
-    #    keys, you wil; be entering your esxi password A LOT!
+    #    keys, you will be entering your esxi password A LOT!
     #
     #    From your command line, you should be able to run
-    #    following command without erros and be able to get to
+    #    following command without an error and be able to get to
     #    the esxi command prompt.
     #
     #      $ ssh root@ESXi_IP_ADDRESS
@@ -111,14 +112,14 @@ Vagrant.configure("2") do |config|
     esxi.virtual_network = "vmnet_example"
 
     #  OPTIONAL.  Specify a Disk Store
-    #    Default is to use the least used Disk Store.
+    #    The Default is to use the least used Disk Store.
     #esxi.vm_disk_store = "DS_001"
 
     #  OPTIONAL.  Guest VM name to be created/used.
     #    The Default will be automatically generated
     #    and will be based on the vmname_prefix,
     #    hostname, username, path...
-    #esxi.vmname = "Custome_Guest_VM_Name"
+    #esxi.vmname = "Custom-Guest-VM_Name"
 
     #  OPTIONAL.  When automatically naming VMs, use
     #    this prifix.
@@ -146,7 +147,7 @@ Vagrant.configure("2") do |config|
     #    Set this to 'True' will overwrite existing VMs (with the same name)
     #    when you run vagrant up.   ie,  if the vmname already exists,
     #    it will be destroyed, then over written...  This is helpful
-    #    if you have a VM that vagrant lost control (lost association).
+    #    if you have a VM that became an orphan (vagrant lost association).
     #esxi.allow_overwrite = 'True'
 
   end
@@ -155,21 +156,25 @@ end
 
 Basic usage
 -----------
-1. `vagrant up --provider=esxi`
+1. `vagrant up --provider=vmware_esxi`
 1. To access the VM, use `vagrant ssh`
 1. To destroy the VM, use `vagrant destroy`
 1. Some other fun stuff you can do.
   * `vagrant status`
   * `vagrant suspend`
   * `vagrant resume`
+  * `vagrant snapshot push`
+  * `vagrant snapshot list`
+  * `vagrant snapshot pop`  
   * `vagrant halt`
   * `vagrant provision`
 
 
-Known issues
-------------
-* NFS using built-in Vagrant synced folders is not yet supported.
-* Multi machines may not provision one VM if the boxes are different.
-  * I found this seems to be a problem with libvirt also, so I'm assuming it's a vagrant problem...
+Known issues with vmware_esxi
+-----------------------------
 * Cleanup doesn't always destroy a VM that has been partially built.  Use the allow_overwrite = 'True' option if you need to force a rebuild.
 * ovftool 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.
+* Built-in Vagrant synced folders using NFS fails if you try to re-provision.
+  * In general I find NFS synced folders pretty "flakey" anyways...
+* Multi machines may not provision one VM if the boxes are different.
+  * I found this problem with libvirt also, so I'm assuming it's a vagrant problem...

data/example_box/Vagrantfile

@@ -0,0 +1,109 @@
+Vagrant.configure("2") do |config|
+
+  #  Box, Select any box created for VMware that is compatible with
+  #    the ovftool.  To get maximum compatiblity You should download
+  #    and install the latest version for your OS.
+  #    https://www.vmware.com/support/developer/ovf/
+  #
+  #    If your box is stuck at "Powered On", then most likely
+  #    the system didn't have the vmware tools installed.
+  #
+  # Here are some of the MANY examples....
+  config.vm.box = 'hashicorp/precise64'
+  #config.vm.box = 'steveant/CentOS-7.0-1406-Minimal-x64'
+  #config.vm.box = 'geerlingguy/ubuntu1604'
+  #config.vm.box = 'laravel/homestead'
+  #config.vm.box = 'centos/7'
+  #config.vm.box = 'bento/ubuntu-14.04'
+
+  #  Supports type rsync and NFS.
+  config.vm.synced_folder('.', '/Vagrantfiles', type: 'rsync')
+
+  #
+  #  Provider (esxi) settings
+  #
+  config.vm.provider :vmware_esxi do |esxi|
+
+    #  REQUIRED!  ESXi hostname/IP
+    #    You MUST specify a esxi_hostname or IP, uless you
+    #    were lucky enough to name your esxi host "esxi".  :-)
+    esxi.esxi_hostname = "esxi"
+
+    #  ESXi username
+    #    Default is "root".
+    esxi.esxi_username = "root"
+
+    #
+    #  A NOTE about esxi_password / ssh keys!!
+    #
+    #    If you don't specify a password and do not use ssh
+    #    keys, you will be entering your esxi password A LOT!
+    #
+    #    From your command line, you should be able to run
+    #    following command without an error and be able to get to
+    #    the esxi command prompt.
+    #
+    #      $ ssh root@ESXi_IP_ADDRESS
+
+    #  IMPORTANT!  ESXi password.
+    #    The ssh connections to esxi will try your ssh
+    #    keys first.  However the ovftool does NOT!  To make
+    #    vagrant up fully password-less, you will need to
+    #    enter your password here....
+    esxi.esxi_password = nil
+
+    #  ESXi ssh keys
+    #    The Default is to use system defaults, However
+    #    you can specify an array of keys here...
+    #esxi.esxi_private_keys = []
+
+    #  SSH port.
+    #    Default port 22
+    #esxi.esxi_hostport = 22
+
+    #  REQUIRED!  Virtual Network
+    #    You MUST specify a Virtual Network!
+    #    The default is fail if no Virtual Network is set!
+    esxi.virtual_network = "vmnet_example"
+
+    #  OPTIONAL.  Specify a Disk Store
+    #    The Default is to use the least used Disk Store.
+    #esxi.vm_disk_store = "DS_001"
+
+    #  OPTIONAL.  Guest VM name to be created/used.
+    #    The Default will be automatically generated
+    #    and will be based on the vmname_prefix,
+    #    hostname, username, path...
+    #esxi.vmname = "Custom-Guest-VM_Name"
+
+    #  OPTIONAL.  When automatically naming VMs, use
+    #    this prifix.
+    #esxi.vmname_prefix = "V-"
+
+    #  OPTIONAL.  Memory size override
+    #    The default is to use the memory size specified in the
+    #    vmx file, however you can specify a new value here.
+    #esxi.memsize = "2048"
+
+    #  OPTIONAL.  Virtual CPUs override
+    #    The default is to use the number of virt cpus specified
+    #     in the vmx file, however you can specify a new value here.
+    #esxi.numvcpus = "2"
+
+    #  OPTIONAL.  Resource Pool
+    #    The default is to create VMs in the "root".  You can
+    #     specify a resource pool here to partition memory and
+    #     cpu usage away from other systems on your esxi host.
+    #     The resource pool must already exist and be configured.
+    #     Vagrant will NOT create it for you.
+    #esxi.resource_pool = "/Vagrant"
+
+    #  DANGEROUS!  Allow Overwrite
+    #    Set this to 'True' will overwrite existing VMs (with the same name)
+    #    when you run vagrant up.   ie,  if the vmname already exists,
+    #    it will be destroyed, then over written...  This is helpful
+    #    if you have a VM that became an orphan (vagrant lost association).
+    #esxi.allow_overwrite = 'True'
+
+  end
+end

data/example_box/Vagrantfile-multimachine

@@ -0,0 +1,36 @@
+#
+# This is a Vagrantfile multi machine example.
+#
+
+nodes = [
+  { hostname: 'VM-multi1', box: 'hashicorp/precise64' },
+  { hostname: 'VM-multi2', box: 'hashicorp/precise64' }
+]
+
+Vagrant.configure("2") do |config|
+  nodes.each do |node|
+    config.vm.define node[:hostname] do |node_config|
+      node_config.vm.hostname = node[:hostname]
+      node_config.vm.box = node[:box]
+      node_config.vm.synced_folder('.', '/Vagrantfiles', type: 'rsync')
+    end
+  end
+
+  config.vm.provider :vmware_esxi do |esxi|
+    #
+    #   Provider settings
+    #
+    esxi.esxi_hostname = "esxi"
+    esxi.esxi_username = "root"
+    esxi.esxi_password = nil
+    #esxi.esxi_private_keys = []
+    #esxi.esxi_hostport = 22
+    esxi.virtual_network = "vmnet_example"
+    #esxi.vm_disk_store = "DS_001"
+    #esxi.vmname_prefix = "V-"
+    #esxi.memsize = "2048"
+    #esxi.numvcpus = "2"
+    #esxi.resource_pool = "/Vagrant"
+    #esxi.allow_overwrite = 'True'
+  end
+end

data/example_box/metadata.json

@@ -1,4 +1,4 @@
 
 {
-    "provider": "vmware-esxi"
+    "provider": "vmware_esxi"
 }

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

@@ -11,6 +11,19 @@ module VagrantPlugins
         end
       end
 
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ReadSSHInfo
+          b.use ReadState
+        end
+      end
+
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ReadSSHInfo
+        end
+      end
+
       def self.action_halt
         Vagrant::Action::Builder.new.tap do |b|
           b.use ReadState
@@ -32,66 +45,97 @@ module VagrantPlugins
         end
       end
 
-      def self.action_destroy
+      def self.action_ssh
         Vagrant::Action::Builder.new.tap do |b|
-          b.use action_halt
           b.use ReadState
-          b.use Destroy
+          b.use ReadSSHInfo
+          b.use SSHExec
+          b.use SSHRun
         end
       end
 
-      def self.action_up
+      def self.action_snapshot_list
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
-          b.use ConnectESXi
-          b.use HandleBox
-          b.use ReadState
-          b.use CreateVM
-          b.use ReadState
-          b.use Boot
-          b.use Call, WaitForState, :running, 240 do |env1, b1|
+          b.use SnapshotList
+        end
+      end
+
+      def self.action_snapshot_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use SnapshotInfo
+        end
+      end
+
+      def self.action_snapshot_save
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use SnapshotSave
+        end
+      end
+
+      def self.action_snapshot_restore
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use action_halt
+          b.use Call, WaitForState, :powered_off, 240 do |env1, b1|
             if env1[:result] == 'True'
-              b1.use action_provision
+              b1.use SnapshotRestore
+              b1.use action_up
             end
           end
         end
       end
 
-      def self.action_reload
+      def self.action_snapshot_delete
         Vagrant::Action::Builder.new.tap do |b|
-          b.use Call, ReadState do |env1, b1|
-            if env1[:machine_state].to_s == 'powered_on'
-              b1.use action_halt
-            end
-            b1.use action_up
-          end
+          b.use SnapshotDelete
         end
       end
 
-      def self.action_read_state
+
+      def self.action_destroy
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ReadSSHInfo
-          b.use ReadState
+          b.use Call, ReadState do |env1, b1|
+            unless env1[:machine_state] == 'powered_off'
+              b1.use action_halt
+            end
+            b1.use ReadState
+            b1.use Destroy
+          end
         end
       end
 
-      def self.action_read_ssh_info
+      def self.action_reload
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ReadSSHInfo
+          b.use Call, ReadState do |env1, b1|
+            if (env1[:machine_state].to_s == 'powered_on') ||
+               (env1[:machine_state].to_s == 'running') ||
+               (env1[:machine_state].to_s == 'suspended')
+              b1.use action_halt
+            end
+            b1.use action_up
+          end
         end
       end
 
-      def self.action_ssh
+      def self.action_up
         Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectESXi
+          b.use HandleBox
           b.use ReadState
-          b.use ReadSSHInfo
-          b.use SSHExec
-          b.use SSHRun
+          b.use CreateVM
+          b.use ReadState
+          b.use Boot
+          b.use Call, WaitForState, :running, 240 do |env1, b1|
+            if env1[:result] == 'True'
+              b1.use action_provision
+            end
+          end
         end
       end
 
       def self.action_provision
         Vagrant::Action::Builder.new.tap do |b|
+          b.use ReadState
           b.use Call, WaitForState, :running, 240 do |env1, b1|
             if env1[:result] == 'True'
               b1.use ReadState
@@ -113,6 +157,11 @@ module VagrantPlugins
       autoload :Destroy, action_root.join('destroy')
       autoload :Suspend, action_root.join('suspend')
       autoload :Resume, action_root.join('resume')
+      autoload :SnapshotInfo, action_root.join('snapshot_info')
+      autoload :SnapshotList, action_root.join('snapshot_list')
+      autoload :SnapshotSave, action_root.join('snapshot_save')
+      autoload :SnapshotDelete, action_root.join('snapshot_delete')
+      autoload :SnapshotRestore, action_root.join('snapshot_restore')
       autoload :WaitForState, action_root.join('wait_for_state')
     end
   end

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

@@ -33,12 +33,12 @@ module VagrantPlugins
 
           # Set guestvm_vmname
           if !env[:machine].config.vm.hostname.nil?
-            # A hostname has been set, so use it.  (multi node)
+            # A hostname has been set, so use it.
             guestvm_vmname = env[:machine].config.vm.hostname
           elsif config.vmname.nil?
             #  Nothing set, so generate our own
-            guestvm_vmname = config.vmname_prefix
-            guestvm_vmname << `hostname`.strip
+            guestvm_vmname = config.vmname_prefix.strip
+            guestvm_vmname << `hostname`.partition('.').first.strip
             guestvm_vmname << '-'
             guestvm_vmname << `whoami`.gsub!(/[^0-9A-Za-z]/, '').strip
             guestvm_vmname << '-'

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

@@ -1,4 +1,5 @@
 require 'log4r'
+require 'net/ssh/simple'
 
 module VagrantPlugins
   module ESXi

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

@@ -1,4 +1,6 @@
 require 'log4r'
+require 'net/ssh/simple'
+require 'socket'
 
 module VagrantPlugins
   module ESXi
@@ -13,6 +15,17 @@ module VagrantPlugins
 
         def call(env)
           env[:machine_state] = read_state(env)
+
+          #  Do NFS stuff
+          if env[:machine_state].to_s.include? "running"
+            ssh_info = env[:machine].ssh_info
+            if defined?(ssh_info[:host])
+              env[:nfs_machine_ip] = [ssh_info[:host]]
+              env[:nfs_host_ip] = Socket::getaddrinfo(Socket.gethostname,"echo",Socket::AF_INET)[0][3]
+              env[:nfs_valid_ids] = [env[:machine].id]
+            end
+          end
+
           @app.call(env)
         end
 
@@ -23,6 +36,7 @@ module VagrantPlugins
           machine = env[:machine]
           config = env[:machine].provider_config
 
+
           return :not_created if machine.id.to_i < 1
 
           @logger.info("vagrant-vmware-esxi, read_state: machine id: #{machine.id}")

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

@@ -0,0 +1,63 @@
+require 'log4r'
+require 'net/ssh/simple'
+
+module VagrantPlugins
+  module ESXi
+    module Action
+      # This action will delete the snapshot
+      class SnapshotDelete
+        def initialize(app, _env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::snapshot_delete')
+        end
+
+        def call(env)
+          suspend(env)
+          @app.call(env)
+        end
+
+        def suspend(env)
+          @logger.info('vagrant-vmware-esxi, snapshot_delete: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          @logger.info("vagrant-vmware-esxi, snapshot_delete: machine id: #{machine.id}")
+          @logger.info("vagrant-vmware-esxi, snapshot_delete: current state: #{env[:machine_state]}")
+
+          if env[:machine_state].to_s == 'not_created'
+           env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                message: 'Cannot snapshot_delete in this state')
+          else
+            env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                 message: 'Attempting to snapshot_delete')
+
+            Net::SSH::Simple.sync(
+              user:     config.esxi_username,
+              password: config.esxi_password,
+              port:     config.esxi_hostport,
+              keys:     config.esxi_private_keys,
+              timeout:  300
+            ) do
+
+              r = ssh config.esxi_hostname,
+                  "vim-cmd vmsvc/snapshot.remove #{machine.id} "\
+                  "`vim-cmd vmsvc/snapshot.get #{machine.id} | "\
+                  "grep -A1 '.*Snapshot Name        : #{env[:snapshot_name]}$' | "\
+                  "grep 'Snapshot Id'|awk '{print $NF}'`"
+
+              if r.exit_code != 0
+                raise Errors::ESXiError,
+                      message: "Unable to remove snapshots of the VM:\n"\
+                               "  #{r.stdout}\n#{r.stderr}"
+              end
+
+              env[:ui].info I18n.t('vagrant_vmware_esxi.snapshot_deleted')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'log4r'
+require 'net/ssh/simple'
+
+module VagrantPlugins
+  module ESXi
+    module Action
+      # This action will list all the snapshots
+      class SnapshotInfo
+        def initialize(app, _env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::snapshot_info')
+        end
+
+        def call(env)
+          suspend(env)
+          @app.call(env)
+        end
+
+        def suspend(env)
+          @logger.info('vagrant-vmware-esxi, snapshot_info: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          @logger.info("vagrant-vmware-esxi, snapshot_info: machine id: #{machine.id}")
+          @logger.info("vagrant-vmware-esxi, snapshot_info: current state: #{env[:machine_state]}")
+
+          if env[:machine_state].to_s == 'not_created'
+           env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                message: 'Cannot snapshot_info in this state')
+          else
+
+            Net::SSH::Simple.sync(
+              user:     config.esxi_username,
+              password: config.esxi_password,
+              port:     config.esxi_hostport,
+              keys:     config.esxi_private_keys,
+            ) do
+
+              r = ssh config.esxi_hostname,
+                  "vim-cmd vmsvc/snapshot.get #{machine.id} 2>&1 | "\
+                  "sed 's/Get Snapshot:/ /g' | "\
+                  "grep -v "\
+                  "-e 'Snapshot Id ' "\
+                  "-e 'Snapshot Desciption ' "\
+                  "-e 'Snapshot State '"
+
+              snapshotinfo = r.stdout
+              if r.exit_code != 0
+                raise Errors::ESXiError,
+                      message: "Unable to list snapshots:\n"\
+                               "  #{allsnapshots}\n#{r.stderr}"
+              end
+
+              env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                   message: "#{snapshotinfo}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+require 'log4r'
+require 'net/ssh/simple'
+
+module VagrantPlugins
+  module ESXi
+    module Action
+      # This action will list all the snapshots
+      class SnapshotList
+        def initialize(app, _env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::snapshot_list')
+        end
+
+        def call(env)
+          suspend(env)
+          @app.call(env)
+        end
+
+        def suspend(env)
+          @logger.info('vagrant-vmware-esxi, snapshot_list: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          @logger.info("vagrant-vmware-esxi, snapshot_list: machine id: #{machine.id}")
+          @logger.info("vagrant-vmware-esxi, snapshot_list: current state: #{env[:machine_state]}")
+
+          if env[:machine_state].to_s == 'not_created'
+           env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                message: 'Cannot snapshot_list in this state')
+          else
+
+            Net::SSH::Simple.sync(
+              user:     config.esxi_username,
+              password: config.esxi_password,
+              port:     config.esxi_hostport,
+              keys:     config.esxi_private_keys,
+            ) do
+
+              r = ssh config.esxi_hostname,
+                  "vim-cmd vmsvc/snapshot.get #{machine.id} 2>&1 | "\
+                  "grep 'Snapshot Name'|sed 's/.*Snapshot Name        : //g'"
+
+              allsnapshots = r.stdout
+              if r.exit_code != 0
+                raise Errors::ESXiError,
+                      message: "Unable to list snapshots:\n"\
+                               "  #{allsnapshots}\n#{r.stderr}"
+              end
+
+              env[:machine_snapshot_list] = allsnapshots.split("\n")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require 'log4r'
+require 'net/ssh/simple'
+
+module VagrantPlugins
+  module ESXi
+    module Action
+      # This action will Restore (revert) the snapshot
+      class SnapshotRestore
+        def initialize(app, _env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::snapshot_restore')
+        end
+
+        def call(env)
+          suspend(env)
+          @app.call(env)
+        end
+
+        def suspend(env)
+          @logger.info('vagrant-vmware-esxi, snapshot_restore: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          @logger.info("vagrant-vmware-esxi, snapshot_restore: machine id: #{machine.id}")
+          @logger.info("vagrant-vmware-esxi, snapshot_restore: current state: #{env[:machine_state]}")
+
+          if env[:machine_state].to_s == 'not_created'
+           env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                message: 'Cannot snapshot_restore in this state')
+          else
+            env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                 message: 'Attempting to snapshot_restore')
+
+            Net::SSH::Simple.sync(
+              user:     config.esxi_username,
+              password: config.esxi_password,
+              port:     config.esxi_hostport,
+              keys:     config.esxi_private_keys,
+              timeout:  300
+            ) do
+
+              r = ssh config.esxi_hostname,
+                  "vim-cmd vmsvc/snapshot.revert #{machine.id} "\
+                  "`vim-cmd vmsvc/snapshot.get #{machine.id} | "\
+                  "grep -A1 '.*Snapshot Name        : #{env[:snapshot_name]}$' | "\
+                  "grep 'Snapshot Id'|awk '{print $NF}'` suppressPowerOn"
+
+              if r.exit_code != 0
+                raise Errors::ESXiError,
+                      message: "Unable to restore snapshots of the VM:\n"\
+                               "  #{r.stdout}\n#{r.stderr}"
+              end
+
+              env[:ui].info I18n.t('vagrant_vmware_esxi.snapshot_restored')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+require 'log4r'
+require 'net/ssh/simple'
+
+module VagrantPlugins
+  module ESXi
+    module Action
+      # This action will save (create) a new snapshot
+      class SnapshotSave
+        def initialize(app, _env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::snapshot_save')
+        end
+
+        def call(env)
+          suspend(env)
+          @app.call(env)
+        end
+
+        def suspend(env)
+          @logger.info('vagrant-vmware-esxi, snapshot_save: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          @logger.info("vagrant-vmware-esxi, snapshot_save: machine id: #{machine.id}")
+          @logger.info("vagrant-vmware-esxi, snapshot_save: current state: #{env[:machine_state]}")
+
+          if env[:machine_state].to_s == 'not_created'
+           env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                message: 'Cannot snapshot_save in this state')
+          else
+            env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                 message: 'Attempting to snapshot_save')
+
+            Net::SSH::Simple.sync(
+              user:     config.esxi_username,
+              password: config.esxi_password,
+              port:     config.esxi_hostport,
+              keys:     config.esxi_private_keys,
+              timeout:  300
+            ) do
+
+              r = ssh config.esxi_hostname,
+                  "vim-cmd vmsvc/snapshot.create #{machine.id} \"#{env[:snapshot_name]}\""
+
+              if r.exit_code != 0
+                raise Errors::ESXiError,
+                      message: "Unable to save snapshots of the VM:\n"\
+                               "  #{r.stdout}\n#{r.stderr}"
+              end
+              env[:ui].info I18n.t('vagrant_vmware_esxi.support')
+
+              env[:ui].info I18n.t('vagrant_vmware_esxi.snapshot_saved')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 require 'log4r'
 require 'timeout'
+require 'net/ssh/simple'
 
 module VagrantPlugins
   module ESXi

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

@@ -0,0 +1,16 @@
+
+module VagrantPlugins
+  module ESXi
+    module Cap
+      module SnapshotList
+        # Returns a list of the snapshots that are taken on this machine.
+        #
+        # @return [Array<String>] Snapshot Name
+        def self.snapshot_list(machine)
+          env = machine.action(:snapshot_list, lock: false)
+          env[:machine_snapshot_list]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module VagrantPlugins
+  module ESXi
+    class SnapshotInfo < Vagrant.plugin(2, :command)
+      def self.synopsis
+          "Snapshot additional information."
+        end
+      def execute
+        with_target_vms(nil, :provider => "vmware_esxi") do |vm|
+          vm.action(:snapshot_info)
+        end
+      end
+    end
+  end
+end

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

@@ -18,10 +18,20 @@ module VagrantPlugins
         setup_logging
         setup_i18n
 
-        require_relative 'provider'
+      require_relative 'provider'
         Provider
       end
 
+      provider_capability('vmware_esxi', 'snapshot_list') do
+        require_relative 'cap/snapshot_list'
+        Cap::SnapshotList
+      end
+
+      command('snapshot-info') do
+        require_relative "command"
+        SnapshotInfo
+      end
+
       # This initializes the internationalization strings.
       def self.setup_i18n
         require 'pathname'

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

@@ -21,7 +21,7 @@ module VagrantPlugins
       end
 
       def state
-        @machine.action('connect_esxi')
+        #@machine.action('connect_esxi')
         env = @machine.action('read_state')
         state_id = env[:machine_state]
 

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

@@ -1,6 +1,6 @@
 #  VERSION
 module VagrantPlugins
   module ESXi
-    VERSION = '1.0.1'
+    VERSION = '1.1.2'
   end
 end

data/locales/en.yml

@@ -32,6 +32,12 @@ en:
       The VM is already suspended.
     already_destroyed: |-
       The VM is destroyed.
+    snapshot_saved: |-
+      The snapshot has been saved.
+    snapshot_deleted: |-
+      The snapshot has been deleted.
+    snapshot_restored: |-
+      The snapshot has been restored.
     config:
       esxi_hostname_is_required: |-
         hostname is required

data/vagrant-vmware-esxi.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'i18n', '~> 0.6'
   s.add_runtime_dependency 'log4r', '~> 1.1'
   s.add_runtime_dependency "iniparse", '> 1.0'
+  s.add_runtime_dependency "nokogiri", '> 1.5'
   s.add_runtime_dependency "net-ssh-simple", '> 1.5'
 
   s.add_development_dependency "bundler"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vmware-esxi
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Jonathan Senkerik
@@ -52,6 +52,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: net-ssh-simple
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +118,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- example_box/Vagrantfile
+- example_box/Vagrantfile-multimachine
 - example_box/metadata.json
 - lib/vagrant-vmware-esxi.rb
 - lib/vagrant-vmware-esxi/action.rb
@@ -115,8 +131,15 @@ files:
 - lib/vagrant-vmware-esxi/action/read_ssh_info.rb
 - lib/vagrant-vmware-esxi/action/read_state.rb
 - lib/vagrant-vmware-esxi/action/resume.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
+- lib/vagrant-vmware-esxi/action/snapshot_restore.rb
+- lib/vagrant-vmware-esxi/action/snapshot_save.rb
 - lib/vagrant-vmware-esxi/action/suspend.rb
 - lib/vagrant-vmware-esxi/action/wait_for_state.rb
+- lib/vagrant-vmware-esxi/cap/snapshot_list.rb
+- lib/vagrant-vmware-esxi/command.rb
 - lib/vagrant-vmware-esxi/config.rb
 - lib/vagrant-vmware-esxi/errors.rb
 - lib/vagrant-vmware-esxi/plugin.rb
@@ -144,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Vagrant ESXi provider plugin