Set-NetNeighbor
Modifies a neighbor cache entry.
Syntax
Set-NetNeighbor
[[-IPAddress] <String[]>]
[-AddressFamily <AddressFamily[]>]
[-AsJob]
[-CimSession <CimSession[]>]
[-InterfaceAlias <String[]>]
[-InterfaceIndex <UInt32[]>]
[-LinkLayerAddress <String>]
[-PassThru]
[-PolicyStore <String>]
[-State <State[]>]
[-ThrottleLimit <Int32>]
[-Confirm]
[-WhatIf]
Set-NetNeighbor
[-AsJob]
[-CimSession <CimSession[]>]
[-LinkLayerAddress <String>]
[-PassThru]
[-ThrottleLimit <Int32>]
-InputObject <CimInstance[]>
[-Confirm]
[-WhatIf]
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.
Examples
EXAMPLE 1
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
This example sets a neighbor cache entry with a specific IP address, and updates, or sets, the MAC address property.
Parameters
-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.
Type: | AddressFamily[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AsJob
ps_cimcommon_asjob
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Type: | CimInstance[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InterfaceAlias
Specifies the interface to which the neighbor is connected, using InterfaceAlias.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InterfaceIndex
Specifies the interface to which the neighbor is connected, using InterfaceIndex.
Type: | UInt32[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IPAddress
Specifies the IP address of the neighbor cache entry.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LinkLayerAddress
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PolicyStore
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-State
Specifies the state of the neighbor cache entry. It is only possible to modify neighbor cache entries that are in a permanent state.
Type: | State[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ThrottleLimit
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.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
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
None