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.

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.

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:

Item Type Example
Description String PoweredOn
Date Created Datetime 1254121
VM Power State String WithVM
VM Name String True
VM ID String Dell System
SnapShot Size (MB) Double PowerEdge 320
Is The Snapshot Current Boolean 8
Is Replay Supported Boolean 19144
Name String 332
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


Virtual Machine Name String Yes SRVExchange
Snapshot Name String Yes