Rename-VM
Rename-VM
Renames a virtual machine.
語法
Parameter Set: Name
Rename-VM [-Name] <String[]> [-NewName] <String> [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <System.String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMObject
Rename-VM [-VM] <VirtualMachine[]> [-NewName] <String> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細描述
The Rename-VM cmdlet renames a virtual machine.
參數
-CimSession<Microsoft.Management.Infrastructure.CimSession[]>
在遠端工作階段或遠端電腦上執行 Cmdlet。輸入電腦名稱或工作階段物件,例如 New-CimSession 或 Get-CimSession Cmdlet 的輸出。預設為本機電腦上目前的工作階段。
別名 |
none |
必要項? |
false |
位置? |
named |
預設值 |
none |
接受管線輸入? |
false |
接受萬用字元? |
false |
-ComputerName<System.String[]>
Specifies one or more Hyper-V hosts on which this cmdlet operates. 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.
別名 |
none |
必要項? |
false |
位置? |
named |
預設值 |
none |
接受管線輸入? |
false |
接受萬用字元? |
false |
-Credential<System.Management.Automation.PSCredential[]>
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
別名 |
none |
必要項? |
false |
位置? |
named |
預設值 |
none |
接受管線輸入? |
false |
接受萬用字元? |
false |
-Name<String[]>
Specifies the name of the virtual machine to be renamed.
別名 |
VMName |
必要項? |
true |
位置? |
1 |
預設值 |
none |
接受管線輸入? |
True (ByValue) |
接受萬用字元? |
false |
-NewName<String>
Specifies the name to which the virtual machine is to be renamed.
別名 |
none |
必要項? |
true |
位置? |
2 |
預設值 |
none |
接受管線輸入? |
false |
接受萬用字元? |
false |
-Passthru
Specifies that an object is to be passed through to the pipeline representing the virtual machine to be renamed.
別名 |
none |
必要項? |
false |
位置? |
named |
預設值 |
none |
接受管線輸入? |
false |
接受萬用字元? |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine to be renamed.
別名 |
none |
必要項? |
true |
位置? |
1 |
預設值 |
none |
接受管線輸入? |
True (ByValue) |
接受萬用字元? |
false |
-Confirm
在執行指令程式之前提示您確認。
必要項? |
false |
位置? |
named |
預設值 |
false |
接受管線輸入? |
false |
接受萬用字元? |
false |
-WhatIf
示範當執行指令程式時會發生什麼事情。此指令程式並未執行。
必要項? |
false |
位置? |
named |
預設值 |
false |
接受管線輸入? |
false |
接受萬用字元? |
false |
<CommonParameters>
這個指令程式支援一般參數:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊,請參閱 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
輸入
輸入類型是可透過管道傳送至指令程式的物件類型。
輸出
輸出類型是指令程式所發出的物件類型。
- None by default; Microsoft.HyperV.PowerShell.VirtualMachine if –PassThru is specified.
範例
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