COMMAND EVERYTHING.

Add-BgpRouteAggregate

Adds a new aggregate route for specific BGP routes.

Networking / Security · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft RemoteAccess reference: Adds a new aggregate route for specific BGP routes. 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-BgpRouteAggregate [-RoutingDomain <String>] -Prefix <String> [-SummaryOnly <SummaryOnly>]
 [-AttributePolicy <String[]>] [-PreserveASPath <PreserveASPath>] [-PassThru] [-Force]
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Add-BgpRouteAggregate. 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.
-AttributePolicy: Specifies a list of policy names that are to be applied to the aggregate route to configure its attributes.
-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.
-Force: Forces the command to run without asking for user confirmation.
-PassThru: Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-Prefix (required): Specifies the classless IP address prefix for the aggregate IP address and its prefix length.
-PreserveASPath: Specifies a flag to keep the aggregated autonomous systems (AS) Paths in the AS Set of the aggregate IP address
-RoutingDomain: Specifies a user-defined unique alphanumeric identifier for the routing domain.
-SummaryOnly: Specifies a flag that indicates that only the aggregate address is to be advertised to peers.
-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.
-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: Add a static custom route aggregation

Add-BgpRouteAggregate -RoutingDomain "Contoso" -Prefix "172.168.0.0/16" -AttributePolicy "P_StaticAggAttrib" -PreserveASPath enable

This command adds a static custom route aggregation. 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-BgpRouteAggregate.md

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

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC