Rename-VMSnapshot

Module:

Hyper-V

Renames a virtual machine snapshot.

Syntax

PowerShell

Rename-VMSnapshot
      [-Name] <String>
      [-VMName] <String>
      [-NewName] <String>
      [-ComputerName <String[]>]
      [-Passthru]

PowerShell

Rename-VMSnapshot
      [-VM] <VirtualMachine>
      [-NewName] <String>
      [-Passthru]
      [-Name] <String>

PowerShell

Rename-VMSnapshot
      [-VMSnapshot] <VMSnapshot>
      [-NewName] <String>
      [-Passthru]

Description

The Rename-VMSnapshot cmdlet renames a virtual machine snapshot.

Examples

Example 1

PowerShell

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

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

Parameters

-ComputerName

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.

Type:	String[]
Position:	Named
Default value:	.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

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

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-NewName

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

Type:	String
Position:	3
Default value:	None
Required:	True
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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VM

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

Type:	VirtualMachine
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMName

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

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-VMSnapshot

Specifies the virtual machine snapshot to be renamed.

Type:	VMSnapshot
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Outputs

None

Default

VMSnapshot

If -PassThru is specified.