powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-Snapshot



NAME
Set-Snapshot

SYNOPSIS
Changes the name and the description of the virtual machine snapshot.

SYNTAX
Set-Snapshot [-Snapshot] [-Name ] [-Description ] [-WhatIf] [-Confirm] [ ers>]


DESCRIPTION
Changes the name and the description of the virtual machine snapshot.


PARAMETERS
-Snapshot
Specify the snapshot whose properties you want to change.

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

-Name
Specify a new name for the snapshot.

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

-Description
Provide a new description for the snapshot.

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>Set-Snapshot -Snapshot $snapshot -Name BeforePatch -Description "Before windows update"


Sets the name and the description of the snapshot in the $snapshot variable.





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

C:\PS>Get-VM | Get-Snapshot -Name "InitialState" | Set-Snapshot -Description "This snapshot is created right after
the OS installation."


Updates the description of all snapshots with name InitialState, from all virtual machines.






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