PowerShell Logo Small

Get-NetNeighbor



This is the built-in help made by Microsoft for the command 'Get-NetNeighbor', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Gets neighbor cache entries.

SYNTAX


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



Search powershellhelp.space

DESCRIPTION


The Get-NetNeighbor cmdlet gets neighbor cache entries. The cmdlet returns information about IP addresses and link-layer addresses for the neighbor cache entries.


The neighbor cache maintains 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 the Address Resolution Protocol (ARP) cache.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=288385
New-NetNeighbor
Remove-NetNeighbor
Set-NetNeighbor
Get-NetAdapter

REMARKS

<

Examples


Example 1: Get all neighbor cache entries

PS C:\>Get-NetNeighbor



This command gets all the neighbor cache entries. The default output for the cmdlet does not include all properties of the NetNeighbor object.




Example 2: Output all properties for neighbor cache entries

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



This command gets all the neighbor cache entries. The command uses the Format-List cmdlet to display all the properties in the output in the form of a table. For more
information, type Get-Help Format-Table.




Example 3: Get neighbor cache entries that have an IPv6 address

PS C:\>Get-NetNeighbor –AddressFamily IPv6



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




Example 4: Get network adapters that have reachable neighbors

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



This command gets a NetNeighbor object that contains neighbor cache entries that are reachable. The command passes the NetNeighbor object to the Get-NetAdapter cmdlet by
using the pipeline operator. The Get-NetAdapter cmdlet gets the network adapters that have the interface index number for the network neighbors stored the NetNeighbor object.