Get-VMNetwork Adapter

Module:
hyper-v
Gets the virtual network adapters of a virtual machine, snapshot, management operating system, or of a virtual machine and management operating system.

Syntax 

Get-VMNetworkAdapter
   [-IsLegacy <Boolean>]
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-VMName] <String[]>
   [[-Name] <String>]
   [<CommonParameters>]
Get-VMNetworkAdapter
   [-IsLegacy <Boolean>]
   [-VM] <VirtualMachine[]>
   [[-Name] <String>]
   [<CommonParameters>]
Get-VMNetworkAdapter
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [[-Name] <String>]
   [-ManagementOS]
   [-SwitchName <String>]
   [<CommonParameters>]
Get-VMNetworkAdapter
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [[-Name] <String>]
   [-All]
   [<CommonParameters>]
Get-VMNetworkAdapter
   [[-Name] <String>]
   [-VMSnapshot] <VMSnapshot>
   [<CommonParameters>]

Description

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

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 operating system.

Required Parameters

-All

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

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

Specifies the management operating system, i.e. the virtual machine host operating system.

Type: SwitchParameter
Position: Named
Default value: None
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: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VMName

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

Type: String[]
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VMSnapshot

Specifies the snapshot whose network adapters are to be retrieved.

Type: VMSnapshot
Aliases: VMCheckpoint
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional 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
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: None
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
Accept pipeline input: False
Accept wildcard characters: False
-IsLegacy

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

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

Specifies the name of the network adapter to be retrieved.

Type: String
Aliases: VMNetworkAdapterName
Position: 1
Default value: None
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 operating system.)

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

Outputs

Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter if ManagementOS is specified; Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter and Microsoft.HyperV.PowerShell.VMNetworkAdapter if All is specified; Microsoft.HyperV.PowerShell.VMNetworkAdapter in all other cases.