Set-Snapshot

NAME Set-Snapshot



SYNOPSIS

This cmdlet modifies the specified virtual machine snapshot.





SYNTAX

Set-Snapshot [-Snapshot] <Snapshot[]> [-Description <String>] [-Name <String>] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

This cmdlet modifies the name and the description of the specified virtual machine snapshot.





PARAMETERS

-Description <String>

Provides a new description for the snapshot.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies a new name for the snapshot.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Snapshot <Snapshot[]>

Specifies the snapshot whose properties you want to change.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? 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.



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

Zero or more modified Snapshot objects







NOTES









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



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



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: https://code.vmware.com/doc/preview?id= ... pshot.html

Get-Snapshot

New-Snapshot

Remove-Snapshot