Rename-VM

Renames a virtual machine.

Syntax

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

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.

Required Parameters

-Name

Specifies the name of the virtual machine to be renamed.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:True
-NewName

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

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VM

Specifies the virtual machine to be renamed.

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

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

Outputs

None by default; Microsoft.Virtualization.Powershell.VirtualMachine if -PassThru is specified.