Get-VMNetworkAdapter

Reference

Module:: Hyper-V

Gets the virtual network adapters of a virtual machine, snapshot, management OS, or of a virtual machine and management OS.

Syntax

Get-VMNetworkAdapter
   [-VMName] <String[]>
   [[-Name] <String>]
   [-ComputerName <String[]>]
   [-IsLegacy <Boolean>]

Get-VMNetworkAdapter
   [[-Name] <String>]
   [-All]
   [-ComputerName <String[]>]

Get-VMNetworkAdapter
   [[-Name] <String>]
   [-ComputerName <String[]>]
   [-SwitchName <String>]
   [-ManagementOS]

Get-VMNetworkAdapter
   [-VM] <VirtualMachine[]>
   [[-Name] <String>]
   [-IsLegacy <Boolean>]

Get-VMNetworkAdapter
   [-VMSnapshot] <VMSnapshot>
   [[-Name] <String>]

Description

The Get-VMNetworkAdapter cmdlet gets the virtual network adapters of the specified virtual machine, snapshot, or management OS.

Examples

Example 1

PS C:\>Get-VMNetworkAdapter -VMName *

Gets virtual network adapters from all virtual machines on the local Hyper-V host.

Example 2

PS C:\>Get-VMNetworkAdapter -ManagementOS

Gets the virtual network adapters in the ManagementOS (i.e. the local Hyper-V host).

Example 3

PS C:\>Get-VMNetworkAdapter -All

Gets virtual network adapters from all virtual machines as well as the management OS.

Parameters

-All

Specifies all virtual network adapters in the system, regardless of whether the virtual network adapter is in the management OS or in a virtual machine.

Type:	SwitchParameter
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ComputerName

Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. 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:	.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IsLegacy

Specify as $TRUE to retrieve only legacy network adapters, or as $FALSE to retrieve only synthetic network adapters. If not specified, virtual network adapters of both types are retrieved.

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

-ManagementOS

Specifies the management OS, i.e. the virtual machine host OS.

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

-Name

Specifies the name of the network adapter to be retrieved.

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SwitchName

Specifies the name of the virtual switch whose network adapters are to be retrieved. (This parameter is available only for virtual network adapters in the management OS.)

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

-VM

Specifies the virtual machine whose virtual network adapters are to be retrieved. . The asterisk, "*", is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system.

Type:	VirtualMachine[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMName

Specifies the name of the virtual machine whose network adapters are to be retrieved.

Type:	String[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

-VMSnapshot

Specifies the snapshot whose network adapters are to be retrieved.

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

Outputs

Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter if ManagementOS is specified; Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter and Microsoft.Virtualization.Powershell.VMNetworkAdapter if All is specified;Microsoft.Virtualization.Powershell.VMNetworkAdapter in all other cases.