Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft RemoteAccess reference: Adds BGP routing policies to 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.
Use an account with the target resource permissions documented for Add-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.
This command adds the BGP routing policy named RTPolicy01 to the BGP peer named TenantSite01. The command specifies the direction of the route advertisement for the BGP peer. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.