Remove-VMNetworkAdapter

Article
11/23/2015

Remove-VMNetworkAdapter

Removes one or more virtual network adapters from a virtual machine.

Syntax

Parameter Set: ManagementOS
Remove-VMNetworkAdapter -ManagementOS [-ComputerName <String[]> ] [-Name <String> ] [-Passthru] [-SwitchName <String> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ResourceObject
Remove-VMNetworkAdapter [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMName
Remove-VMNetworkAdapter [-VMName] <String[]> [-ComputerName <String[]> ] [-Name <String> ] [-Passthru] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Remove-VMNetworkAdapter [-VM] <VirtualMachine[]> [-Name <String> ] [-Passthru] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-VMNetworkAdapter cmdlet removes one or more virtual network adapters from a virtual machine.

Parameters

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which the virtual network adapter is to be removed. 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

-ManagementOS

Specifies the management operating system of the virtual network adapter to be removed.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Passthru

Specifies that an object to be passed through to the pipeline representing the virtual machine network adapter to be removed. This is a Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter object, if -ManagementOS is specified; otherwise it is a Microsoft.Virtualization.Powershell.VMNetworkAdapter object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VM<VirtualMachine[]>

Specifies the virtual machine that has the virtual network adapter you want to remove.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-VMName<String[]>

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

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-VMNetworkAdapter<VMNetworkAdapterBase[]>

Specifies the virtual machine network adapter to be removed.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-VMNetworkAdapterName<String>

Specifies the name of the virtual network adapter to be removed.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String>

Specifies the name of the virtual network adapter to be removed.

Aliases	VMNetworkAdapterName
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SwitchName<String>

Specifies the name of the virtual switch connected to the virtual network adapter to be removed.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
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. If –PassThru is specified, Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter, if -ManagementOS is also specified;otherwise Microsoft.Virtualization.Powershell.VMNetworkAdapter.

Examples

Example 1

This example removes network adapter Redmond_NIC1 from a virtual machine named Redmond.

PS C:\> Remove-VMNetworkAdapter -VMName Redmond -VMNetworkAdapterName Redmond_NIC1

Remove-VMNetworkAdapter