VMware Host - Delete snapshot

Declaration

<AMVMWAREVM ACTIVITY="delete_snapshot" SESSION="text" HOSTTYPE="text (options)" SERVER="text" USERNAME="text" PASSWORD="text (encrypted)" CONNECTIONTIMEOUT="number" VMPATH="text" TIMEOUT="number" OPENVMTIMEOUT="number" SNAPNAME="text" />

Related Topics   

Description

Deletes an existing virtual machine snapshot.

Practical usage

Used to delete a snapshot, usually after saving a backup.

Parameters

Connection

Property Type Required Default Markup Description
Connection --- --- --- --- Indicates where this activity's connection properties should originate from. Different parameters become active depending on the option selected. This is a visual parameter used only during design-time, therefore, contains no properties or markups. The available options are:
  • Host (default) - A custom set of credentials will be entered for this activity. This option is normally selected if only a single activity is needed to perform an operation.
  • Session - Credentials derive from a session created in a previous step with the use of the VMware Host - Connect activity. This allows several activities to be linked to a single session, eliminating redundancy. Multiple sessions can exist in a single task.
Session Text Yes, if Connection is set to Session VMOpsSession1 SESSION="VMO101" The name of a session (created in a previous VWmware Host - Connect step) in which to link this activity. This parameter is active only if the Connection parameter is set to Session.
Host type Text (options) Yes, if Connection is set to Host VIServer
  • HOSTTYPE="Server"
  • HOSTTYPE="Workstation"
  • HOSTTYPE="VIServer"
  • HOSTTYPE="Player"
 The type of VM host to establish a connection with. This parameter is active only if the Connection parameter is set to Host. The available options are:
  • VMware Server (1.0x)
  • VMware Workstation
  • VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0) (default)
  • VMware Player
Host name Text Yes (Empty) SERVER="host.server.com" The hostname or IP address of the computer where the virtual machine is located. This parameter is active only if the Host type parameter is set to VMware Server (1.0x) or VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0).
Username Text No (Empty) USERNAME="MsPacman" The username identifying a valid user account on the machine. This parameter is active only if the Host type parameter is set to VMware Server (1.0x) or VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0).
Password Text No (Empty) PASSWORD="encrypted" The password identifying a valid user account on the machine. This parameter is active only if the Host type parameter is set to VMware Server (1.0x) or VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0).
Connection timeout Number No 60 CONNECTIONTIMEOUT="50" The maximum time period in seconds during which a connection must be established between the guest and host, otherwise, the step times out. The default value is 60 seconds.

Virtual Machine

Property Type Required Default Markup Description
Virtual machine path Text Yes (Empty) VMPATH="C:\Temp\Snapshot.vmx" The path to the VM snapshot in which to delete.
Name Text Yes (Empty) SNAPNAME="Snapshot3" The user-defined name for the snapshot.
Timeout (seconds) Number No 60 TIMEOUT="50" The maximum value in seconds that this activity should wait for a response from the host.
Open VM timeout (seconds) Number No 60 OPENVMTIMEOUT="5" The maximum time period in seconds during which this activity must successfully connect to the specified VMware product or the task times out.

Description

Error Causes

On Error

Example

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

This sample task deletes a VM snapshot  named "test_snapshot."

Copy 
<!-- Create virtual machine connection of host type "Workstation" / Create and start session named "VMOpsSession1" -->
<AMVMWAREVM ACTIVITY="connect" HOSTTYPE="Workstation" SESSION="VMOpsSession1" />
<!-- Power on virtual OS image -->
<AMVMWAREVM SESSION="VMOpsSession1" VMPATH="F:\Virtual Machines\Windows Server 2008 x64\Windows Server 2008 x64.vmx" LAUNCHGUI="YES" />
<!-- Delete snap shot -->
<AMVMWAREVM ACTIVITY="delete_snapshot" SESSION="VMOpsSession1" VMPATH="F:\Virtual Machines\Windows 10 x86\Windows 10.vmx" SNAPNAME="test_snapshot" />
<!-- Power off virtual machine -->
<AMVMWAREVM ACTIVITY="poweroff_vm" SESSION="VMOpsSession1" VMPATH="F:\Virtual Machines\Windows10 x86\Windows 10.vmx" TIMEOUT="3" OPENVMTIMEOUT="3" SOFT="YES" TOOLSTIMEOUT="3" />
<!-- Disconnect virtual machine connection / End session -->
<AMVMWAREVM ACTIVITY="disconnect" SESSION="VMOpsSession1" />