powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-Snapshot



NAME
New-Snapshot

SYNOPSIS
Creates a new snapshot of a virtual machine.

SYNTAX
New-Snapshot [-VM] [-Name] [-Description ] [-Memory] [-Quiesce] [-Server ver[]>] [-RunAsync] [-WhatIf] [-Confirm] []


DESCRIPTION
Creates a new snapshot of a virtual machine with the provided inputs.


PARAMETERS
-VM
Specify the virtual machines you want to snapshot.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Name
Specify a name for the new snapshot.

Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Description
Provide a description of the new snapshot.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Memory
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
Accept pipeline input? false
Accept wildcard characters? false

-Quiesce
If the value is $true and the virtual machine is powered on, VMware Tools are used to quiesce the file system o
f the virtual machine. This assures that a disk snapshot represents a consistent state of the guest file system
s. If the virutal machine is powered off or VMware Tools are not available, the Quiesce parameter is ignored.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-RunAsync
Indicate that the command returns immediately without waiting for the task to complete. In this mode, the outpu
t of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync"
in the vSphere PowerCLI console.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
Snapshot


NOTES




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

C:\PS>New-Snapshot -VM VM -Name BeforePatch


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






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/New-Snapshot.html
Get-Snapshot
Remove-Snapshot
Set-Snapshot