Updates the configuration of the specified BGP peer.
Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft RemoteAccess reference: Updates the configuration of the specified BGP peer. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Set-BgpPeer. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / RemoteAccess · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-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.
-ClearPrefixLimit
Indicates that the cmdlet clears the maximum limit on prefixes learned from the peer. The cmdlet will reset the prefix learning to an unlimited number.
-Confirm
Prompts you for confirmation before running the cmdlet.
-Force
Forces the command to run without asking for user confirmation.
-HoldTimeSec
Specifies the configured value of the HoldTime parameter in seconds after which the BGP Session expires if no BGP message is received.
-IdleHoldTimeSec
Specifies the configured value of the IdleHoldTime in seconds after which the BGP Session expires if no BGP message is received.
-LocalASN
Specifies the local autonomous systems (AS) number of the BGP Router instance for this peer.
-LocalIPAddress
Specifies the local BGP router's peering IP address. It can be of IPv4 or IPv6 address type.
-MaxAllowedPrefix
Specifies the maximum number of allowed IPv4 or IPv6 network prefixes that can be learned from the given neighbor.
-Name (required)
Specifies the peer name for which the configuration is to be modified.
-OperationMode
Specifies the BGP router's mode of operation. The acceptable values for this parameter are: - Peering Initiator as well as peering acceptor - Only acting as a passive peering request acceptor.
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-PeerASN
Specifies the neighbor BGP router's AS number.
-PeerIPAddress
Specifies the neighbor BGP router's peering IP address. Acceptable values are an IPv4 or IPv6 address type.
-PeeringMode
Specifies a value to configure peering mode for the given peer. The acceptable values for this parameter are: - Automatic - Manual
-RouteReflectorClient
Specifies whether peer is a client peer or non-client peer.
-RoutingDomain
Specifies the user-defined unique alphanumeric identifier for the routing domain.
-ThrottleLimit
Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used. The throttle limit applies only to the current command, not to the session or to the computer.
-Weight
Specifies administrative preference assigned to the routes received from this peer.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Prerequisites
Windows with the RemoteAccess module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
Examples
Example 1: Update the BGP peer configuration for the specified neighbor
This command updates and modifies the BGP peer configuration for the specified neighbor. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.