PowerCLI Reference



This cmdlet retrieves the virtual machine snapshots available on a vCenter Server system.


Get-Snapshot [-VM] <VirtualMachine[]> [[-Name] <String[]>] [-Id <String[]>] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet returns information about the snapshots that correspond to the filter criteria provided by the Name and VM parameters. The disk size of the snapshots is retrieved only if you have the "Datastore/Browse datastore" privilege to the datastore where the shapshot is located. Otherwise, the following message is displayed: "Unable to populate snapshot size due to unsufficient permissions."


NameTypeDescriptionRequired?Pipeline InputDefault Value
VMVirtualMachine[]Specifies the virtual machines whose snapshots you want to retrieve. The position of this parameter is deprecated and will be changed in a future release. To avoid errors when you run existing scripts on future PowerCLI versions, specify the parameter by name.trueTrue (ByValue)
NameString[]Specifies the names of the snapshots you want to retrieve.falseFalse
IdString[]Specifies the IDs of the snapshots you want to retrieve.

Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falseFalse

Return Type

Zero or more Snapshot objects



-------------------------- Example 1 --------------------------

Get-Snapshot -VM VM -Name 'Before ServicePack 2'

Retrieves the snapshot named "Before ServicePack2" of the VM virtual machine.

Copyright © VMware, Inc. All rights reserved.