< Back
New-Snapshot
Post
NAME New-Snapshot
SYNOPSIS
This cmdlet creates a new snapshot of a virtual machine.
SYNTAX
New-Snapshot [-VM] <VirtualMachine> [-Name] <String> [-Description <String>] [-Memory] [-Quiesce] [-RunAsync]
[-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new snapshot of a virtual machine with the provided inputs.
PARAMETERS
-Description <String>
Provide a description of the new snapshot.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies a name for the new snapshot.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VM <VirtualMachine>
Specifies the virtual machine you want to snapshot. Passing multiple values to this parameter is obsolete.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The one or more newly created Snapshot objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... pshot.html
Get-Snapshot
Remove-Snapshot
Set-Snapshot
SYNOPSIS
This cmdlet creates a new snapshot of a virtual machine.
SYNTAX
New-Snapshot [-VM] <VirtualMachine> [-Name] <String> [-Description <String>] [-Memory] [-Quiesce] [-RunAsync]
[-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new snapshot of a virtual machine with the provided inputs.
PARAMETERS
-Description <String>
Provide a description of the new snapshot.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies a name for the new snapshot.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VM <VirtualMachine>
Specifies the virtual machine you want to snapshot. Passing multiple values to this parameter is obsolete.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The one or more newly created Snapshot objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... pshot.html
Get-Snapshot
Remove-Snapshot
Set-Snapshot