Set-Snapshot

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

Syntax

-Snapshot  <Snapshot[]>
[-Description  <String>]
[-Name  <String>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Snapshot
Snapshot[] named
  • pipeline
  • Specifies the snapshot whose properties you want to change.
    optional
    Description
    String named Provides a new description for the snapshot.
    optional
    Name
    String named Specifies a new name for the snapshot.

    Output

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

    Examples


    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 Commands

    Feedback

    Was this page helpful?