Rename-VMNetworkAdapter

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

Syntax

Rename-VMNetworkAdapter
      [-VMName] <String[]>
      [-NewName] <String>
      [-ComputerName <String[]>]
      [-Name <String>]
      [-Passthru]
      [-VMNetworkAdapterName <String>]
      [-Confirm]
      [-WhatIf]
Rename-VMNetworkAdapter
      [-NewName] <String>
      [-ComputerName <String[]>]
      [-Name <String>]
      [-Passthru]
      [-VMNetworkAdapterName <String>]
      [-ManagementOS]
      [-Confirm]
      [-WhatIf]
Rename-VMNetworkAdapter
      [-VM] <VirtualMachine[]>
      [-NewName] <String>
      [-Name <String>]
      [-Passthru]
      [-VMNetworkAdapterName <String>]
      [-Confirm]
      [-WhatIf]
Rename-VMNetworkAdapter
      [-VMNetworkAdapter] <VMNetworkAdapterBase[]>
      [-NewName] <String>
      [-Passthru]
      [-Confirm]
      [-WhatIf]

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 1

PS C:\>Rename-VMNetworkAdapter -VMName Kirkland -Name Private -NewName CoreNet

This example renames the virtual network adapter Private to CoreNet in virtual machine Kirkland.

Required Parameters

-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
Accept pipeline input:False
Accept wildcard characters:False
-NewName

Specifies the new name for the virtual network adapter.

Type:String
Position:3
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[]
Position:1
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[]
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMNetworkAdapter

Specifies the virtual network adapter to be renamed.

Type:VMNetworkAdapterBase[]
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 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:.
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the existing name of the virtual network adapter.

Type:String
Aliases:VMNetworkAdapterName
Position:Named
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.Virtualization.Powershell.VMInternalNetworkAdapter object, if ManagementOS is specified; otherwise it is a Microsoft.Virtualization.PowerShell.VMNetworkAdapter object.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMNetworkAdapterName

Specifies the existing name of the virtual network adapter you want to rename.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

None by default. If -PassThru is specified, then a Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter object is passed through to the pipeline if -ManagementOS is also specified; otherwise a Microsoft.Virtualization.PowerShell.VMNetworkAdapter is passed.