VMware Workstation plugin

The VMware Workstation plugin provides steps for working with VMware Workstation virtual machines running on VMware vSphere, ESXi, or another copy of VMware Workstation.

Before you begin

To use the VMware Workstation plugin, complete the following prerequisite tasks:

  1. Verify that your Deployment Automation user role allows you to manage plugins. For details, see Server roles and system security.

  2. Download the Deployment Automation plugin bundle, extract the VMware Workstation plugin zip file from the bundle, and load the file into Deployment Automation. For details, see Load and upgrade plugins.

To use the plugin steps, open a component or global process and navigate to Virtualization > VMware > Workstation in the Tools pane.

For details on creating processes, see Create and design component processes and Create and design global processes.

Back to top

Clone VM step

The Clone VM step clones a virtual machine.

The following table describes the step's properties:

Property Description
Full path to vmrun utility

Specify the full path, including file name, to the tool that is used to execute VMware commands, for example:

C:\Program Files (x86)\VMware\VMware Workstation\vmrun.exe
Source path and file name Specify the full path, including file name, to the source .vmx file.
Snapshot name (Optional) If the snapshot name is included, the clone is created from the specified snapshot.
Create Linked Clone (Optional) Creates the clone so that it shares virtual disks with the parent virtual machine in an ongoing manner. This conserves disk space as long as the parent and clone do not change very much from their original state.

Back to top

Delete Snapshot step

The Delete Snapshot step deletes a snapshot of a virtual machine.

The following table describes the step's properties:

Property Description
Full path to vmrun utility

Specify the full path, including file name, to the tool that is used to execute VMware commands, for example:

C:\Program Files (x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, to the source .vmx file.
Snapshot name The snapshot name or the path to the snapshot in the tree, for multiple snapshots with the same name, for example, /snap1/snap1.1/snap1.1.2.

Back to top

Revert to Snapshot step

The Revert to Snapshot step reverts to a snapshot of the virtual machine.

The following table describes the step's properties:

Property Description
Full path to vmrun utility

Specify the full path, including file name, to the tool that is used to execute VMware commands, for example:

C:\Program Files (x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, to the source .vmx file.
Snapshot name

The snapshot name or the path to the snapshot in the tree, for multiple snapshots with the same name, for example:

/snap1/snap1.1/snap1.1.2

Back to top

Start VM step

The Start VM step starts a virtual machine.

The following table describes the step's properties:

Property Description
Full path to vmrun utility

Specify the full path, including file name, to the tool that is used to execute VMware commands, for example:

C:\Program Files (x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, to the source .vmx file.

Back to top

Stop VM step

The Stop VM step stops a virtual machine.

The following table describes the step's properties:

Property Description
Full path to vmrun utility

Specify the full path, including file name, to the tool that is used to execute VMware commands, for example:

C:\Program Files (x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, to the source .vmx file.

Back to top

Suspend VM step

The Suspend VM step suspends a virtual machine.

The following table describes the step's properties:

Property Description
Full path to vmrun utility

Specify the full path, including file name, to the tool that is used to execute VMware commands, for example:

C:\Program Files (x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, to the source .vmx file.

Back to top

Take Snapshot step

The Take Snapshot step takes a snapshot of a virtual machine.

The following table describes the step's properties:

Property Description
Full path to vmrun utility

Specify the full path, including file name, to the tool that is used to execute VMware commands, for example:

C:\Program Files (x86)\VMware\VMware Workstation\vmrun.exe
VM path Specify the full path, including file name, to the source .vmx file.
Snapshot name Specify the snapshot name.

Back to top

See also: