Set-BgpRouteAggregate

Updates the properties of specified aggregate BGP route.

Syntax

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

Description

The Set-BgpRouteAggregate cmdlet updates the properties of specified aggregate Border Gateway Protocol (BGP) route.

Examples

Example 1: Update the custom route aggregation route properties

PS C:\>Set-BgpRouteAggregate -RoutingDomain "Contoso" -IPAddress "172.168.0.0" -PrefixLength 16 -SummaryOnly Enable -Force

This command updates the custom route aggregation route properties for routing domain named Contoso.

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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AttributePolicy

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indicates no confirmation prompt for updating aggregate route properties.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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
Required:True
Accept pipeline input:True
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
Accepted values:Disabled, Enabled
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RoutingDomain

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

Type:String
Aliases:RoutingDomainName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SummaryOnly

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

Type:SummaryOnly
Accepted values:Disabled, Enabled
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

String[]

Nullable<T>[[Microsoft.PowerShell.Cmdletization.GeneratedTypes.BgpRouteAggregate.PreserveASPath, Microsoft.PowerShell.Cmdletization.GeneratedTypes, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]]

Nullable<T>[[Microsoft.PowerShell.Cmdletization.GeneratedTypes.BgpRouteAggregate.SummaryOnly, Microsoft.PowerShell.Cmdletization.GeneratedTypes, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]]

Outputs

CimInstance

CimInstance