Get-NetNeighbor

Get-NetNeighbor

Gets information about the neighbor cache for IPv4 and IPv6.

Syntax

Parameter Set: ByName
Get-NetNeighbor [[-IPAddress] <String[]> ] [-AddressFamily <AddressFamily[]> ] [-AsJob] [-AssociatedIPInterface <CimInstance> ] [-CimSession <CimSession[]> ] [-InterfaceAlias <String[]> ] [-InterfaceIndex <UInt32[]> ] [-LinkLayerAddress <String[]> ] [-PolicyStore <String> ] [-State <State[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-NetNeighbor cmdlet gets the list of on-link neighbors and displays IP and link-layer address information about them in a table. This includes properties such as the InterfaceIndex with which the neighbor is associated and the state of the entry.

The Neighbor cache maintains a list of information for each on-link neighbor, including the IP address and the associated link-layer address. In IPv4, the neighbor cache is commonly known as an ARP cache.

Parameters

-AddressFamily<AddressFamily[]>

Gets neighbor cache information only about a specific IP address family. The acceptable values for this parameter are:
-- IPv4: IPv4 Address information.
-- IPv6: IPv6 address information.

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

-AsJob

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

-AssociatedIPInterface<CimInstance>

Gets neighbor cache information only about a specific network IP interface CIM object. This is typically as input through the pipeline.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
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

-IPAddress<String[]>

Gets neighbor cache information only about a specific neighbor IP address.

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

-LinkLayerAddress<String[]>

Specifies the link layer address of the neighbor cache entry. This is also known as a MAC address. A link-layer address that uses IPv4 address syntax is a tunnel technology that encapsulates packets over an IPv4 tunnel, such as ISATAP or Teredo. A link-layer address of all zeroes indicates that the neighbor is unreachable and the neighbor cache entry does not have a link-layer address entry. An empty link-layer address indicates that the link layer does not use link-layer addresses, such as on a loopback interface.

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

-PolicyStore<String>

Specifies the PolicyStore value. The acceptable values for this parameter are:
-- ActiveStore: The IP address information is currently valid.
-- PersistentStore: The IP address information is persistent across reboots. When the computer starts, the PersistentStore settings are copied to the ActiveStore.
The default value is ActiveStore.

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

-InterfaceAlias<String[]>

Gets neighbor cache information only about a specific interface, as defined by the InterfaceAlias.

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

-InterfaceIndex<UInt32[]>

Gets neighbor cache information only about a specific interface, as defined by the InterfaceIndex number.

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

-State<State[]>

Gets neighbor cache information only about a specific state. The Neighbor Cache contains information maintained by Neighbor Unreachability Detection. A key piece of information is the reachability state of a neighbor. The acceptable values for this parameter are:
-- Unreachable: The IP address is unreachable.
-- Incomplete: Address resolution is in progress and the link-layer address of the neighbor has not yet been determined.
-- Probe: The neighbor is no longer known to be reachable, and unicast Neighbor Solicitation probes are being sent to verify reachability.
-- Delay: The neighbor is no longer known to be reachable, and traffic has recently been sent to the neighbor. Rather than probe the neighbor immediately, however, the system will delay sending probes for a short while in order to give upper layer protocols a chance to provide reachability confirmation.
-- Stale: The neighbor is no longer known to be reachable but until traffic is sent to the neighbor, no attempt should be made to verify its reachability.
-- Reachable: The neighbor is known to have been reachable recently (within tens of seconds).
-- Permanent: The neighbor is statically provisioned and will not expire unless deleted through configuration.
-- Maximum: A maximum value for testing purposes.

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

• None

Outputs

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

• Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetNeighbor

  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

This example gets information about the neighbor cache for IPv4 and IPv6.

PS C:\> Get-NetNeighbor

The default output omits some properties. Run this cmdlet to display all of the fields (all of the properties of the object).

PS C:\> Get-NetNeighbor | Format-List –Property *

EXAMPLE 2

This example gets information about the neighbor cache for neighbors that have an IPv6 address.

PS C:\> Get-NetNeighbor –AddressFamily IPv6

EXAMPLE 3

This example gets NetAdapter information for all of the adapters that have reachable neighbors.

PS C:\> Get-NetNeighbor –State Reachable | Get-NetAdapter

Related topics

New-NetNeighbor

Remove-NetNeighbor

Set-NetNeighbor

Get-NetAdapter

Format-List