Rename-VM
Rename-VM
Renames a virtual machine.
Syntax
Parameter Set: Name
Rename-VM [-Name] <String> [-NewName] <String> [-ComputerName <String[]> ] [-Passthru] [ <CommonParameters>]
Parameter Set: VMObject
Rename-VM [-VM] <VirtualMachine[]> [-NewName] <String> [-Passthru] [ <CommonParameters>]
Detailed Description
The Rename-VM cmdlet renames a virtual machine.
Parameters
-ComputerName<String[]>
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.
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 to be renamed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-NewName<String>
Specifies the name to which the virtual machine is to be renamed.
Aliases |
none |
Required? |
true |
Position? |
2 |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine 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; Microsoft.Virtualization.Powershell.VirtualMachine if –PassThru is specified.
Examples
Example 1
Renames virtual machine VM1 to VM2.
PS C:\> Rename-VM VM1 –NewName VM2
Example 2
Renames virtual machine VM1 to VM2 and displays the renamed virtual machine.
PS C:\> Get-VM VM1 | Rename-VM –NewName VM2 -PassThru