COMMAND EVERYTHING.

Add-BgpRouter

Adds a BGP router for the specified Tenant ID.

Networking / Security · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft RemoteAccess reference: Adds a BGP router for the specified Tenant ID. 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-BgpRouter -BgpIdentifier <IPAddress> -LocalASN <UInt32> [-IPv6Routing <IPv6RoutingState>]
 [-CompareMEDAcrossASN <Boolean>] [-DefaultGatewayRouting <Boolean>] [-PassThru] [-Force]
 [-RoutingDomain <String>] [-LocalIPv6Address <IPAddress>] [-TransitRouting <TransitRouting>]
 [-RouteReflector <RouteReflector>] [-ClusterId <UInt32>]
 [-ClientToClientReflection <ClientToClientReflection>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Add-BgpRouter. 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.
-BgpIdentifier (required): Specifies the local BGP Router identifier. The acceptable value for this parameter is an IPv4 address.
-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.
-ClientToClientReflection: Specifies whether client to client reflection is enabled or disabled.
-ClusterId: Specifies the cluster ID of the router reflector.
-CompareMEDAcrossASN: Indicates whether comparison of Microsoft Enterprise Desktop (MED) values across different autonomous systems (AS) are enabled.
-DefaultGatewayRouting: Indicates whether routing of the unresolvable routes to the default (Internet) gateway is enabled or disabled.
-Force: Forces the command to run without asking for user confirmation.
-IPv6Routing: Specifies a value that enables or disables IPv6 routing for this BGP router. The acceptable values for this parameter are: - Disable - Enable
-LocalASN (required): Specifies the local AS number of the BGP Router instance. See AS numbers by IANA for the list of 32 bit AS numbers.
-LocalIPv6Address: Specifies the local BGP Router's global or site-local IPv6 address. This value is used as the NEXT-HOP value in the IPv6 route advertisements.
-PassThru: Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-RouteReflector: Specifies whether BGP router acts as a route reflector.
-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.
-TransitRouting: Specifies whether transit routing is enabled.

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 local BGP router

Add-BgpRouter -BgpIdentifier 10.1.1.10-LocalASN 64522 -PassThru

This command adds a local BGP router. 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-BgpRouter.md

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

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC