Add-BgpRouteAggregate

Adds a new aggregate route for specific BGP routes.

Syntax

Add-BgpRouteAggregate
   [-AsJob]
   [-AttributePolicy <String[]>]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-Force]
   [-PassThru]
   -Prefix <String>
   [-PreserveASPath <PreserveASPath>]
   [-RoutingDomain <String>]
   [-SummaryOnly <SummaryOnly>]
   [-ThrottleLimit <Int32>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Add-BgpRouteAggregate cmdlet adds a new aggregate route for specific Border Gateway Protocol (BGP) routes.

Examples

Example 1: Add a static custom route aggregation

PS C:\>Add-BgpRouteAggregate -RoutingDomain "Contoso" -Prefix "172.168.0.0/16" -AttributePolicy "P_StaticAggAttrib" -PreserveASPath enable

This command adds a static custom route aggregation.

Required Parameters

-Prefix

Specifies the classless IP address prefix for the aggregate IP address and its prefix length.

Type:String
Aliases:AggregatePrefix
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AttributePolicy

Specifies a list of policy names that are to be applied to the aggregate route to configure its attributes.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PreserveASPath

Specifies a flag to keep the aggregated autonomous systems (AS) Paths in the AS Set of the aggregate IP address

Type:PreserveASPath
Parameter Sets:Disabled, Enabled
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-RoutingDomain

Specifies a user-defined unique alphanumeric identifier for the routing domain.

Type:String
Aliases:RoutingDomainName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SummaryOnly

Specifies a flag that indicates that only the aggregate address is to be advertised to peers.

Type:SummaryOnly
Parameter Sets:Disabled, Enabled
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Management.Infrastructure.CimInstance#BgpRouteAggregateInfo