Get-NetAdapter

Get-NetAdapter

Gets the basic network adapter properties.

Syntax

Parameter Set: ByName
Get-NetAdapter [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-Physical] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByIfIndex
Get-NetAdapter -InterfaceIndex <UInt32[]> [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-Physical] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByInstanceID
Get-NetAdapter -InterfaceDescription <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-IncludeHidden] [-Physical] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-NetAdapter cmdlet gets the basic network adapter properties. By default only visible adapters are returned. To see the common network adapter properties, pipe the output into the Format-List cmdlet. To see all the properties, pipe the output to the Format-List cmdlet with the Property parameter specified as the wildcard character "*". This cmdlet supports multiple views. The default view is as a table. To see more information regarding various network adapter identifiers use the names view using the Format-Table cmdlet with the View parameter specified as name. To see more information regarding the miniport, device driver, such as driver date or version use the driver view using the Format-Table cmdlet with the View parameter specified as driver.

Parameters

-AsJob

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IncludeHidden

Indicates that the cmdlet includes both visible and hidden network adapters in the operation. By default only visible network adapters are included. If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InterfaceDescription<String[]>

Specifies an array of network adapter interface descriptions. For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as Contoso 12345 Gigabit Network Device.


Aliases

ifDesc

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-InterfaceIndex<UInt32[]>

Specifies the network adapter interface index number as an array.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of network adapter names.


Aliases

ifAlias, InterfaceAlias

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-Physical

Indicates that the cmdlet gets all physical network adapters.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

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

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/NetAdapter

    The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.


Examples

Example 1: Get all visible network adapters

This command gets all of the visible network adapters.


PS C:\> Get-NetAdapter -Name "*"

Example 2: Get all visible and hidden network adapters

This command gets all of the network adapters.


PS C:\> Get-NetAdapter -Name "*" -IncludeHidden

Example 3: Get all physical network adapters

This command gets all of the physical network adapters.


PS C:\> Get-NetAdapter -Name "*" -Physical

Example 4: Get a network adapter by the specified name

This command gets the network adapter named Ethernet 2.


 

PS C:\> Get-NetAdapter -Name "Ethernet 2"

 

This command is a version that uses wildcard characters.


PS C:\> Get-NetAdapter -Name "E*2"

Example 5: Display the common properties for the specified network adapter

This command displays the common properties for the network adapter named Ethernet 3 and formats the list using the Format-List cmdlet.


PS C:\> Get-NetAdapter –Name "Ethernet 3" | Format-List –Property "*"

Example 6: Display all properties for the specified network adapter

This command displays all of the properties for the network adapter named Ethernet 6.


PS C:\> Get-NetAdapter –Name "Ethernet 6" | Format-List -Property "*"

Example 7: Get all network adapters using the interface description that matches a prefix pattern

This command gets all of the network adapters using the interface description that matches the prefix pattern VendorAdapter.


PS C:\> Get-NetAdapter -Name "*" -InterfaceDescription "VendorAdapter*"

Example 8: Display parameter values for all network adapters

This command displays the Name, InterfaceDescription, and InterfaceName parameter values for all network adapters.


PS C:\> Get-NetAdapter -Name "*" -IncludeHidden | Format-List -Property "Name", "InterfaceDescription", "InterfaceName"

Example 9: Get the visible network adapters on the specified server

This command gets the visible network adapters on the server named Server5. The server named Server5 can be a remote computer.


PS C:\> Get-NetAdapter -Name "*" –CimSession "Server5"

Example 10: Get the visible network adapters and format the output

This command gets the visible network adapters and formats the output to present driver information.


PS C:\> Get-NetAdapter -Name "*" | Format-Table –View Driver

Example 11: Gets visible network adapters and format the output

This command gets the visible network adapters and formats the output to present various names by which a network adapter can be identified such as the Name, InterfaceDescription, and InterfaceName parameter values.


PS C:\> Get-NetAdapter -Name "*" | Format-Table –View Name

Related topics

Community Additions

ADD
Show: