PowerShell Logo Small

Get-NetNeighbor



This is the built-in help made by Microsoft for the command 'Get-NetNeighbor', in PowerShell version 3 - as retrieved from Windows version 'Microsoft Windows Server 2012 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 information about the neighbor cache for IPv4 and IPv6.

SYNTAX


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



Search powershellhelp.space

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.



<

RELATED LINKS

Format-List
New-NetNeighbor
Remove-NetNeighbor
Set-NetNeighbor
Get-NetAdapter

REMARKS

<

Examples


EXAMPLE 1

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 *



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




EXAMPLE 2

PS C:\>Get-NetNeighbor –AddressFamily IPv6



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




EXAMPLE 3

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



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