Set-NetNeighbor

Set-NetNeighbor

Modifies a neighbor cache entry.

Syntax

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

Parameter Set: InputObject (cdxml)
Set-NetNeighbor -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-LinkLayerAddress <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-NetNeighbor cmdlet modifies a neighbor cache entry for IPv4 or IPv6. The neighbor cache maintains a list of information for each on-link neighbor, including the IP address and the associated link-layer address. It is only possible to modify neighbor cache entries in a permanent state on interfaces that have link-layer addresses.

Parameters

-AddressFamily<AddressFamily[]>

Modifies an IP address family of the neighbor cache entry. This property is automatically generated if unspecified. The acceptable values for this parameter are:
-- IPv4: IPv4 address information.
-- IPv6: IPv6 address information.

-AsJob

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

-IPAddress<String[]>

Specifies the IP address of the neighbor cache entry.

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

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

-InterfaceAlias<String[]>

Specifies the interface to which the neighbor is connected, using InterfaceAlias.

-InterfaceIndex<UInt32[]>

Specifies the interface to which the neighbor is connected, using InterfaceIndex.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

-State<State[]>

Specifies the state of the neighbor cache entry. It is only possible to modify neighbor cache entries that are in a permanent state.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

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

Outputs

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

• None

Examples

EXAMPLE 1

This example sets a neighbor cache entry with a specific IP address, and updates, or sets, the MAC address property.

PS C:\> Set-NetNeighbor –InterfaceIndex 12 –IPAddress 192.168.0.5 –MACaddress 00-00-12-00-00-ff

This cmdlet is an alternative method.

PS C:\> Get-NetNeighbor –InterfaceIndex 12 –IPAddress 192.168.0.5 | Set-NetNeighbor –MACAddress 00-00-12-00-00-ff

Related topics

Get-NetNeighbor

New-NetNeighbor

Remove-NetNeighbor