Remove VM Snapshot (VMware)
This object removes one or all VMware snapshot against a single VM.
Install VMware.PowerCLI
Before using this VMware Automation Manager Object, you must install the PowerShell module VMware.PowerCLI.
This VMware Automation Object runs on 64-bit PowerShell, and the module must also be added to 64-bit PowerShell.
Requires PowerShell 5.0
Before using this VMware Automation Manager Object, you must install PowerShell 5.0.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Session ID | String | Yes | This is the session ID that is generated by the VMware connection object. This is required for this object to work. |
| Virtual Machine Name | String | Yes | This is the name of the virtual machine from which you want to remove a VMware snapshot. The field does not support wildcards, and is mandatory. |
| Snapshot Name | String | Yes | Specifies the name of the snapshot to be deleted. It supports “*” as a wildcard, which will remove all snapshots from the specified virtual machine. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
| Result String | String | Object execution error details. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
| Session ID | String | Yes | ab4c55c1273cb609678a2bb6a15104e927ac8dec 10.199.2.23 |
| Virtual Machine Name | String | Yes | SRVExchange |
| Snapshot Name | String | Yes | SRVExchange SRV* * |