COMMAND EVERYTHING.

Set-BgpRoutingPolicyForPeer

Modifies BGP routing policies for BGP peers.

Networking / Security · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft RemoteAccess reference: Modifies BGP routing policies for BGP peers. 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-BgpRoutingPolicyForPeer -PolicyName <String[]> [-PeerName <String[]>] [-RoutingDomain <String>]
 -Direction <PolicyDirection> [-Force] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-BgpRoutingPolicyForPeer. 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.
-Confirm: Prompts you for confirmation before running the cmdlet.
-Direction (required): Specifies the direction of the route advertisements to which the policies are added.The acceptable values for this parameter are: - Ingress. The routing policy applies its criteria to incoming route advertisements. - Egress. The routing policy applies its criteria to outgoing route advertisements.
-Force: Forces the command to run without asking for user confirmation.
-PeerName: Specifies an array of names of BGP peers. The cmdlet adds the router policies that you specify in the PolicyName parameter to the BGP peers.
-PolicyName (required): Specifies an array of names of router policies. The cmdlet adds these routers to the peers that you specify in the PeerName parameter.
-RoutingDomain: Specifies a name, as a string, of a routing domain. The name of a routing domain is a unique user-defined alphanumeric string.
-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.
-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: Apply router policies to BGP peers

Set-BgpRoutingPolicyForPeer -Direction Ingress -PeerName "TenantSite03" -PolicyName "RTPolicy02", "RTPolicy04", "RTPolicy05"

This command applies the specified router policies to the Ingress route advertisements of the BGP peer named TenantSite03. The cmdlet clears all the routing policies that you previously applied to the peers before it applies the new set of policies. The command prompts the user for confirmation before it applies the router policies. 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-BgpRoutingPolicyForPeer.md

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

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC