COMMAND EVERYTHING.

Add-BgpPeer

Adds a new BGP peer.

Networking / Security · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft RemoteAccess reference: Adds a new 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.

Add-BgpPeer [-Name] <String> -LocalIPAddress <IPAddress> -PeerIPAddress <IPAddress> [-LocalASN <UInt32>]
 -PeerASN <UInt32> [-OperationMode <OperationMode>] [-PeeringMode <PeeringMode>] [-HoldTimeSec <UInt16>]
 [-IdleHoldTimeSec <UInt16>] [-MaxAllowedPrefix <UInt32>] [-PassThru] [-RoutingDomain <String>]
 [-Weight <UInt16>] [-RouteReflectorClient <Boolean>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Add-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.
-HoldTimeSec: Specifies the configured value of HoldTime in seconds after the BGP session expires if no BGP message is received.
-IdleHoldTimeSec: Specifies the configured value of IdleHoldTime in seconds after 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 (required): Specifies the local BGP Router's peering IP Address. It can be 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 unique name for the peering with specified BGP neighbor.
-OperationMode: Specifies the BGP Router's mode of operation. Operating modes include: - 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 (required): Specifies the neighbor BGP Router's AS Number.
-PeerIPAddress (required): Specifies the neighbor BGP router's peering IP address. It can be of IPv4 or IPv6 address type.
-PeeringMode: Specifies the parameter to configure peering mode for the given peer.
-RouteReflectorClient: Specifies whether the current peer is a Route Reflector 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.

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: Add a BGP peer to the BGP router and establish a session

Add-BgpPeer -Name "RedTenantSite1" -LocalIPAddress 192.168.1.10 -PeerIPAddress 14.1.1.10 -PeerASN 64512 -PassThru

This command adds a BGP peer to the BGP router and automatically starts establishing BGP peering session with that neighbor. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/RemoteAccess/Add-BgpPeer.md

https://learn.microsoft.com/powershell/module/remoteaccess/add-bgppeer?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC