COMMAND EVERYTHING.

Set-BgpRouter

Updates the configuration of the local BGP router for the specified tenant ID.

Networking / Security · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft RemoteAccess reference: Updates the configuration of the local 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.

Set-BgpRouter [-BgpIdentifier <IPAddress>] [-LocalASN <UInt32>] [-CompareMEDAcrossASN <Boolean>]
 [-DefaultGatewayRouting <Boolean>] [-IPv6Routing <IPv6RoutingState>] [-RoutingDomain <String>] [-PassThru]
 [-Force] [-LocalIPv6Address <IPAddress>] [-TransitRouting <TransitRouting>] [-RouteReflector <RouteReflector>]
 [-ClusterId <UInt32>] [-ClientToClientReflection <ClientToClientReflection>] [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-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: 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.
-ClusterId: Specifies the cluster ID of the cluster.
-CompareMEDAcrossASN: Indicates that comparison of Microsoft Enterprise Desktop (MED) values across different autonomous systems (AS) is enabled.
-Confirm: Prompts you for confirmation before running the cmdlet.
-DefaultGatewayRouting: Indicates that 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 whether to enable or disable IPv6 routing for this BGP router.
-LocalASN: Specifies the local AS Number of the BGP Router instance.
-LocalIPv6Address: Specifies the local BGP router's global or site-local IPv6 Address, which is to be 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 will act as a RouteReflector.
-RoutingDomain: Specifies the user-defined unique alphanumeric identifier for the routing domain.
-TransitRouting: Specifies whether Transit routing is enabled.
-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: Set the local BGP router with confirmation

Set-BgpRouter -LocalASN 64513 -PassThru

This command prompts the user for confirmation and on confirmation from user, updates, and then modifies the configuration of the local BGP router and restarts all the active BGP peerings. 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/Set-BgpRouter.md

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

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC