Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Rename-VMNetworkAdapter

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Renames a virtual network adapter on a virtual machine or on the management operating system.

SYNTAX

VMName (Default)

Rename-VMNetworkAdapter [-CimSession <CimSession[]>] [-ComputerName <String[]>] [-Credential <PSCredential[]>]
 [-VMName] <String[]> [[-Name] <String>] [-NewName] <String> [-Passthru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ResourceObject

Rename-VMNetworkAdapter [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-NewName] <String> [-Passthru] [-WhatIf]
 [-Confirm] [<CommonParameters>]

ManagementOS

Rename-VMNetworkAdapter [-ManagementOS] [-CimSession <CimSession[]>] [-ComputerName <String[]>]
 [-Credential <PSCredential[]>] [[-Name] <String>] [-NewName] <String> [-Passthru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

VMObject

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[]
Parameter Sets: VMName, ManagementOS
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: VMName, ManagementOS
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 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[]
Parameter Sets: VMName, ManagementOS
Aliases: 

Required: False
Position: Named
Default value: None
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
Parameter Sets: ManagementOS
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the existing name of the virtual network adapter.

Type: String
Parameter Sets: VMName, ManagementOS, VMObject
Aliases: VMNetworkAdapterName

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NewName

Specifies the new name for the virtual network adapter.

Type: String
Parameter Sets: (All)
Aliases: 

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 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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: VMObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VMName

Specifies the name of the virtual machine that has the virtual network adapter you want to rename.

Type: String[]
Parameter Sets: VMName
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VMNetworkAdapter

Specifies the virtual network adapter to be renamed.

Type: VMNetworkAdapterBase[]
Parameter Sets: ResourceObject
Aliases: 

Required: True
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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

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.

NOTES

© 2017 Microsoft