## PowerCLI Reference

# New-Snapshot

## Synopsis

This cmdlet creates a new snapshot of a virtual machine.

Syntax

New-Snapshot [-VM] <VirtualMachine> [-Name] <String> [-Description <String>] [-Memory] [-Quiesce] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-Snapshot
Remove-Snapshot
Set-Snapshot

Detailed Description

This cmdlet creates a new snapshot of a virtual machine with the provided inputs.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
VM | VirtualMachine | Specifies the virtual machine you want to snapshot. Passing multiple values to this parameter is obsolete. | true | true (ByValue)
Name | String | Specifies a name for the new snapshot. | true | false
Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | false
Description | String | Provide a description of the new snapshot. | false | false
Memory | SwitchParameter | If the value is $true and if the virtual machine is powered on, the virtual machine's memory state is preserved with the snapshot. | false | false
Quiesce | SwitchParameter | If the value is $true and the virtual machine is powered on, VMware Tools are used to quiesce the file system of the virtual machine. This assures that a disk snapshot represents a consistent state of the guest file systems. If the virutal machine is powered off or VMware Tools are not available, the Quiesce parameter is ignored. | false | false
RunAsync | SwitchParameter | Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console. | false | false
Server | VIServer[] | 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. | false | false
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false

Return Type

The one or more newly created Snapshot objects

Notes

Examples

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

    New-Snapshot -VM VM -Name BeforePatch

Creates a new snapshot of the VM virtual machine named BeforePatch.

-------------- Example 2 --------------

    New-Snapshot -VM VM2 -Name PoweredOnVM -Memory $true

Creates a new snapshot of the VM2 powered-on virtual machine and preserves its memory state.

Copyright © VMware, Inc. All rights reserved.