VM Operations - Create Snapshot

Declaration

<AMVMWAREVM ACTIVITY="create_snapshot" VMPATH="text" SNAPNAME="text" SNAPDESC="text" TIMEOUT="number" OPENVMTIMEOUT="number" INCLUDEMEMORY="yes/no" HOSTTYPE="text (options)" SERVER="text" USERNAME="text" PASSWORD="text" />

See Also

VM Operations - Clone | VM Operations - Connect | VM Operations - Create Snapshot | VM Operations - Delete | VM Operations - Delete Snapshot | VM Operations - Disconnect | VM Operations - Install Tools | VM Operations - List Registered VMs | VM Operations - List Running VMs | VM Operations - List Snapshots | VM Operations - Pause | VM Operations - Power Off | VM Operations - Power On | VM Operations - Register VMs | VM Operations - Reset | VM Operations - Revert to Snapshots | VM Operations - Suspend | VM Operations - Unregister VM

Description

Creates a snapshot of an existing virtual machine. A snapshot records virtual machine conditions at the time of the snapshot, including the virtual machine's power state and data written to virtual disks. To revert to a snapshot, use the Revert to Snapshot action.

Practical Usage

Useful for performing backups. Also useful for checkpointing virtual machine states, for example in a test laboratory where you require specific settings for given test conditions.

Parameters

Virtual Machine Properties

Property

Type

Required

Default

Markup

Description

Virtual Machine Path

Text

Yes

(Empty)

VMPATH="C:\VMFolder\VMfile.vmx"

The path of the virtual machine configuration (.vmx) file in which to create a snapshot of. This parameter varies by product platform. With ESX/ESXi hosts and VMware Server 2.0, use a URL of the form "https://<hostName>:<port>/sdk" where <hostName> is either the DNS name or IP address, and <port> might be optional; credentials are required even for connections made locally. With VMware Workstation, use undef to connect to the local host. With VMware Server 1.0.x, use a DNS name or IP address for remote connections, or the same as Workstation for local connections.

Name

Text

No

(Empty)

SNAPNAME="Snapshot3"

A user-defined name for the snapshot.

Description

Text

No

(Empty)

SNAPDESC="Backup"

A user-defined description for the snapshot.

Include Memory

Yes/No

No

No

INCLUDEMEMORY="yes"

Specifies whether to include

Timeout (seconds)

Number

No

60

TIMEOUT="5"

The time out 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.

Connection Properties

These properties allow you to create a custom connection for this activity or link it to a session previously established (using the Connect activity) that contains pre-defined connection parameters.

Property

Type

Required

Default

Markup

Description

Provide Connection

 

 

 

 

Indicates where this activity's connection should originate from. Different parameters become active depending on the option selected. The available options are:

  • Custom (Default) - A custom set of credentials will be entered for this activity. Select this option if performing a single operation.

  • Session Based - Credentials should derive from a session created in a previous step with the use of the Connect activity. This allows several operations to be linked to a single session, eliminating redundancy. Multiple sessions can exist in a single task.

Host Type

Text (options)

Yes

VIServer

HOSTTYPE="Workstation"

The type of VM host to establish a connection with. The available options are:

  • VMware Server (1.0x)

  • VMware Workstation

  • VMware VI Server (ESX/ESXi, vCenter, VMware Server 2.0)(Default)

  • VMware Player

This parameter is active only if the Provide Connection parameter is set to Custom.

Host

Text

Yes

(Empty)

SERVER="host.server.com"

The host name 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 or VMware VI Server.

Username

Text

No

(Empty)

USERNAME="theUser"

The username identifying a valid user account on the virtual machine. This parameter is active only if the Host Type parameter is set to VMware Server or VMware VI Server.

Password

Text

No

(Empty)

PASSWORD="AM1DWVc+PAIZ6"

The password identifying a valid user account on the virtual machine. This parameter is active only if the Host Type parameter is set to VMware Server or VMware VI Server.

Connection Timeout (seconds)

Number

No

60

CONNECTIONTIMEOUT="20"

The maximum time out value in seconds that this activity should wait for a response from the host.

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: Create snapshot "myVirtualMachine" of virtual machine "F:\Virtual Machines\Windows 7 x86\Windows 7.vmx". Snapshot description is "Create a snapshot". Capture the full state of a running virtual machine, including the memory. Use default VM session.

 

<AMVMWAREVM ACTIVITY="create_snapshot" VMPATH="F:\Virtual Machines\Windows 7 x86\Windows 7.vmx" SNAPNAME="myVirtualMachine" SNAPDESC="Create a snapshot" INCLUDEMEMORY="yes" />

 

↑ Top