vmsnapshot command

Last Updated : Jun 10, 2026 |

From Release 10.2, use the vmsnapshot command to create, remove, revert, and list the snapshot of Session Manager and Branch Session Manager deployed in a virtualized environment.

Verify with the system administrator that the required Virtual machine state privileges are available on the virtual machine.

Note:

The vmsnapshot command is not available in a Software-Only environment.

Syntax

vmsnapshot [-h] [-d] [--host] [-u] [-p] [-a] [-y][create] [remove] [revert] [list --current]
-h, --help

Displays help for the command and also the required and optional parameters.

-d, --debug

Displays the log information.

--host

Displays the ESXi IP or FQDN.

-u, --user

Displays the ESXi username.

-p, --passwd

Displays the ESXi password.

Note:

You can also provide the password through a file without exposing it to the command-line. You can use the following command:

vmsnapshot --host <ESXi host IP Address> -u root list <full path of the file containing the password>

For example: vmsnapshot --host 12.12.15.14 -u root list </tmp/passwd

-a, --auth

Use ESXi host, ESXi user, and ESXi password from encrypted file.

-y, --assumeYes

Silent operation, assume "yes" for any prompts.

create <Name of the new snapshot>

Creates a new snapshot.

remove <Name of the snapshot to remove>

Removes the given snapshot.

revert <Name of the snapshot to revert>

Reverts the virtual machine to the given snapshot.

list, list --current

  • listDisplays all the snapshot.

  • list --currentDisplays the latest snapshot.