Rename-VM

Renames a virtual machine.

Syntax

Rename-VM
      [-Name] <String>
      [-NewName] <String>
      [-Passthru]
      [-ComputerName <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Rename-VM
      [-NewName] <String>
      [-Passthru]
      [-VM] <VirtualMachine[]>
      [-ComputerName <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Rename-VM cmdlet renames a virtual machine.

Examples

Example 1

PS C:\>Rename-VM VM1 -NewName VM2

Renames virtual machine VM1 to VM2.

Example 2

PS C:\>Get-VM VM1 | Rename-VM -NewName VM2 -PassThru

Renames virtual machine VM1 to VM2 and displays the renamed virtual machine.

Parameters

-ComputerName

Specifies one or more Hyper-V hosts on which the virtual machine is to be deleted. 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:.
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the virtual machine to be renamed.

Type:String
Aliases:VMName
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-NewName

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

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Passthru

Specifies that an object is to be passed through to the pipeline representing the virtual machine to be renamed.

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

Specifies the virtual machine to be renamed.

Type:VirtualMachine[]
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

None by default; Microsoft.HyperV.PowerShell.VirtualMachine if -PassThru is specified.