Get Snapshot Information (VMware)
This object returns one or more snapshots for one or all virtual machines, and both the virtual machine and snapshot name fields support the use of "*", which will return all virtual machines or snapshots.
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.
Input Parameters
Name | Type | Required | Description |
---|---|---|---|
Session ID | String | Yes | The session ID that is generated by the VMware connection object. This is required for this object to work. |
Virtual Machine Name | String | Yes |
The name of the virtual machine for which you want to get information. The field support wildcards, so to return all virtual machines, use "*" as the value. |
Snapshot Name | String | Yes |
The name of the snapshot to be searched for on one or all virtual machines. It supports "*" as a wildcard, which will find all snapshots. |
Output Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Snapshots Information | Collection |
The list of snapshots returned as an array to be used with a "Foreach" object. It contains following host information:
|
||||||||||||||||||||||||||||||
Records Found | Number | The number of records found and returned. | ||||||||||||||||||||||||||||||
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 |
Snapshot * |