Rename-VMNetworkAdapter
Renames a virtual network adapter on a virtual machine or on the management operating system.
Syntax
Rename-VMNetworkAdapter
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-VMName] <String[]>
[[-Name] <String>]
[-NewName] <String>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-VMNetworkAdapter
[-VMNetworkAdapter] <VMNetworkAdapterBase[]>
[-NewName] <String>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-VMNetworkAdapter
[-ManagementOS]
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[[-Name] <String>]
[-NewName] <String>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-VMNetworkAdapter
[-VM] <VirtualMachine[]>
[[-Name] <String>]
[-NewName] <String>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Rename-VMNetworkAdapter cmdlet renames a virtual network adapter on a virtual machine or on the management operating system.
Examples
Example 1
PS C:\> Rename-VMNetworkAdapter -VMName Redmond -NewName CoreNet
This example renames all the virtual network adapters of virtual machine Redmond to CoreNet.
Example 2
PS C:\> Rename-VMNetworkAdapter -VMName Kirkland -Name Private -NewName CoreNet
This example renames the virtual network adapter Private to CoreNet in virtual machine Kirkland.
Parameters
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ComputerName
Specifies one or more Hyper-V hosts on which the virtual network adapter 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: | None |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
Type: | PSCredential[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ManagementOS
Specifies that you want to rename a virtual network adapter that belongs to the management operating system.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the existing name of the virtual network adapter.
Type: | String |
Aliases: | VMNetworkAdapterName |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NewName
Specifies the new name for the virtual network adapter.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Passthru
Specifies that an object is to be passed through to the pipeline representing the virtual network adapter to be renamed. This is a Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter object, if ManagementOS is specified; otherwise it is a Microsoft.HyperV.PowerShell.VMNetworkAdapter object.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VM
Specifies the virtual machine that has the virtual network adapter you want to rename.
Type: | VirtualMachine[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VMName
Specifies the name of the virtual machine that has the virtual network adapter you want to rename.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VMNetworkAdapter
Specifies the virtual network adapter to be renamed.
Type: | VMNetworkAdapterBase[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
None by default. if PassThru is specified, then a Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter object is passed through to the pipeline if -ManagementOS is also specified; otherwise a Microsoft.HyperV.PowerShell.VMNetworkAdapter is passed.
피드백
https://aka.ms/ContentUserFeedback
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요.다음에 대한 사용자 의견 제출 및 보기