New-Snapshot Command | Vmware PowerCLI Reference

New-Snapshot

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

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
Name String 1
Specifies a name for the new snapshot.
required
VM VirtualMachine named
  • pipeline
  • wildcards
Specifies the virtual machine you want to snapshot. Passing multiple values to this parameter is obsolete.
optional Description String named
Provide a description of the new snapshot.
optional Memory SwitchParameter named
If the value is $true and if the virtual machine is powered on, the virtual machine's memory state is preserved with the snapshot.
optional ProgressAction ActionPreference named
optional Quiesce SwitchParameter named
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.
optional RunAsync SwitchParameter named
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.
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.

Output

VMware.VimAutomation.ViCore.Types.V1.VM.Snapshot

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.

Related Commands

Snapshot

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

This cmdlet creates a new snapshot of a virtual machine.

This cmdlet removes the specified virtual machine snapshots.

This cmdlet modifies the specified virtual machine snapshot.