Get-BgpRouteAggregate

Gets all the aggregate BGP routes configured by the administrator.

Syntax

Get-BgpRouteAggregate
   [-RoutingDomain <String>]
   [-Prefix <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-BgpRouteAggregate cmdlet retrieves all the aggregate Border Gateway Protocol (BGP) routes configured by the administrator.

Examples

Example 1: Get a custom aggregate route and its aggregate policies

PS C:\>Get-BgpRouteAggregate -Prefix "172.168.0.0/16", "10.10.10.0/24"

This command gets a custom aggregate route and its aggregate policies for aggregate IP addresses 172.168.0.0/16 and 10.10.10.0/24.

Example 2: Retrieve all aggregate routes and their aggregate policies

PS C:\>Get-BgpRouteAggregate

This command gets all aggregate routes and their aggregate policies.

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
-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
-Prefix

Specifies a string array of the aggregate IP addresses (classless IP address prefixes and their prefix lengths) whose properties are to be retrieved.

Type:String[]
Aliases:AggregatePrefix
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-RoutingDomain

Specifies the 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
-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[]