Finding connected network adapters

One of the most fundamental pieces of troubleshooting or security checks to do is to find out which of the many network adapters on a computer are actually connected to a network.

PowerTip : Show ‘up’ physical adapters

Question: You want to see which physical network adapters on your Windows 8.1 computer using Windows PowerShell. How can you do this?

Answer: Use the -physical parameter with the Get-NetAdapter function and filter for a status of up. This technique appears here:

  1. Get-NetAdapter -physical| where status -eq 'up'

Using NetSh

It is pretty easy to use NetSh to retrieve information about the connection status of network adapters. To do so, I use the following command:

  1. netsh interface ipv4 show interfaces

One of the problems, from a management perspective, is that the command returns text. Therefore, if I need to parse the text to pull out specific information, such as the Interface Index number, or the Name of the adapter, then I am going to have to resort to writing a complicated regular expression pattern. If all I need to do is to obtain the information because I am writing to a log file as text, then the command works great, and is the lowest common denominator - I can use it all the way back to Windows 2000 days.

I can even run the netsh commands from within the Windows PowerShell console. This appears in the figure that follows.

image043.png

Using WMI

It is possible to use WMI and the Win32_NetworkAdapter WMI class to retrieve information about the connection status. The NetConnectionStatus property reports backed in a coded value that reports the status. These values are documented on MSDN for the Win32_NetworkAdapter class. Using the Get-WmiObject Windows PowerShell cmdlet, I can work with any operating system that installs Windows PowerShell. This includes Windows XP, Windows Server 2003 and above. The following command returns information similar to the NetSh command.

  1. get-wmiobject win32\_networkadapter|select netconnectionid, name, InterfaceIndex, netconnectionstatus

The command and the output from the command appear in the figure that follows.

  1. ![image045.png](images/image045.png)

The difference is that instead of plain text, the command returns objects that can be further manipulated. Therefore, while the above command actually returns the network connection status of all network adapters, the NetSh command only returns the ones that are connected. If I filter on a netconnectionstatus of 2 I can return only the connected network adapters. The command becomes this one (this is a single line command that I broke at the pipeline character for readability):

  1. get-wmiobject win32\_networkadapter -filter "netconnectionstatus = 2"|
  2. selectnetconnectionid,name,InterfaceIndex,netconnectionstatus

The command and output appear in the figure that follows.

image047.png

If the desire is to obtain the connection status of more than just network adapters that are connected, then the task will require writing a script to do a lookup. The lookup values appear in the table that follows:

Value Meaning
0 Disconnected
1 Connecting
2 Connected
3 Disconnecting
4 Hardware not present
5 Hardware disabled
6 Hardware malfunction
7 Media disconnected
8 Authenticating
9 Authentication succeeded
10 Authentication failed
11 Invalid Address
12 Credentials required

The Get-NetworkAdapterStatus.ps1 script requires at least Windows PowerShell 2.0 which means that it will run on Windows XP SP3 and above.

Get-NetworkAdapterStatus.Ps1

  1. <#
  2. .Synopsis
  3. Produces a listing of network adapters and status on a local or remote machine.
  4. .Description
  5. This script produces a listing of network adapters and status on a local or remote machine.
  6. .Example
  7. Get-NetworkAdapterStatus.ps1 -computer MunichServer
  8. Lists all the network adapters and status on a computer named MunichServer
  9. .Example
  10. Get-NetworkAdapterStatus.ps1
  11. Lists all the network adapters and status on local computer
  12. .Inputs
  13. [string]
  14. .OutPuts
  15. [string]
  16. .Notes
  17. NAME: Get-NetworkAdapterStatus.ps1
  18. AUTHOR: Ed Wilson
  19. LASTEDIT: 1/10/2014
  20. KEYWORDS: Hardware, Network Adapter
  21. .Link
  22. Http://www.ScriptingGuys.com
  23. #Requires -Version 2.0
  24. #>
  25. Param(
  26. [string]$computer=$env:COMPUTERNAME
  27. ) #end param
  28. functionGet-StatusFromValue
  29. {
  30. Param($SV)
  31. switch($SV)
  32. {
  33. 0 { " Disconnected" }
  34. 1 { " Connecting" }
  35. 2 { " Connected" }
  36. 3 { " Disconnecting" }
  37. 4 { " Hardware not present" }
  38. 5 { " Hardware disabled" }
  39. 6 { " Hardware malfunction" }
  40. 7 { " Media disconnected" }
  41. 8 { " Authenticating" }
  42. 9 { " Authentication succeeded" }
  43. 10 { " Authentication failed" }
  44. 11 { " Invalid Address" }
  45. 12 { " Credentials Required" }
  46. Default { "Not connected" }
  47. }
  48. } #end Get-StatusFromValue function
  49. # \*\*\* Entry point to script \*\*\*
  50. Get-WmiObject-Classwin32\_networkadapter-computer$computer|
  51. Select-ObjectName, @{LABEL="Status";
  52. EXPRESSION={Get-StatusFromValue$\_.NetConnectionStatus}}

If my environment is Windows 7 and Windows Server 2008 R2, I can use either Windows PowerShell 3.0 or Windows PowerShell 4.0. The advantage here, is that I gain access to the Get-CimInstance cmdlet which uses WinRM for remoting instead of DCOM that the Get-WmiObject cmdlet uses. The only change to the Get-NetworkAdapterStatus.ps1 script that is required is to replace the Get-WmiObject line with Get-CimInstance. The revision appears here:

  1. # \*\*\* Entry point to script \*\*\*
  2. Get-CimInstance-Classwin32\_networkadapter-computer$computer|
  3. Select-ObjectName, @{LABEL="Status";
  4. EXPRESSION={Get-StatusFromValue$\_.NetConnectionStatus}}

When I run the Get-StatusFromValue.ps1 script, in the Windows PowerShell ISE, I see the output achieved here.

image049.png

Using the NetAdapter module

On Windows 8 and above the NetAdapter module contains the Get-NetAdapter function. To see the status of all network adapters, use the Get-NetAdapter function with no parameters. The command appears here:

  1. Get-NetAdapter

The output from this command appears here.

image051.png

I can reduce the output to only physical adapters by using the -physical parameter. This command appears here.

  1. Get-NetAdapter-Physical

If I only want to see the physical network adapters that are actually up, I pipeline the results to the where-object. This command appears here.

  1. Get-NetAdapter-physical|wherestatus-eq'up'

The commands and the output from the two previous commands appear in the figure that follows.

image053.png