Rename-VMSnapshot

Rename-VMSnapshot

Renames a virtual machine snapshot.

Syntax

Parameter Set: SnapshotName
Rename-VMSnapshot [-Name] <String> [-VMName] <String> [-NewName] <String> [-ComputerName <String[]> ] [-Passthru] [ <CommonParameters>]

Parameter Set: SnapshotObject
Rename-VMSnapshot [-VMSnapshot] <VMSnapshot> [-NewName] <String> [-Passthru] [ <CommonParameters>]

Parameter Set: VM
Rename-VMSnapshot [-VM] <VirtualMachine> [-NewName] <String> -Name <String> [-Passthru] [ <CommonParameters>]

Detailed Description

The Rename-VMSnapshot cmdlet renames a virtual machine snapshot.

Parameters

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which the virtual machine snapshot is to be renamed. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.

Aliases	none
Required?	false
Position?	named
Default Value	.
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String>

Specifies the name of the virtual machine snapshot to be renamed.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	true

-NewName<String>

Specifies the name to which the virtual machine snapshot is to be renamed.

Aliases	none
Required?	true
Position?	3
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Passthru

Specifies that a VMSnapshot object is to be passed through to the pipeline representing the virtual machine snapshot to be renamed.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VM<VirtualMachine>

Specifies the virtual machine of which the snapshot is to be renamed.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-VMName<String>

Specifies the name of the virtual machine of which the snapshot is to be renamed.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	true

-VMSnapshot<VMSnapshot>

Specifies the virtual machine snapshot to be renamed.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• None by default; VMSnapshot if –PassThru is specified.

Examples

Example 1

Renames snapshot Configuration 2 of virtual machine TestVM to Configuration 2: applied all updates.

PS C:\> Rename-VMSnapshot –VMName TestVM –Name “Configuration 2” –NewName “Configuration 2: applied all updates“