Get-BgpRouteInformation
Retrieves BGP route information for one or more network prefixes from the BGP routing table.
Get-BgpRouteInformation
[-Network <String[]>]
[-RoutingDomain <String>]
[-Type <RouteType>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
The Get-BgpRouteInformation cmdlet retrieves Border Gateway Protocol (BGP) route information for one or more network prefixes. This cmdlet returns error information if errors occur while retrieving the BGP route information.
PS C:\>Get-BgpRouteInformation
DestinationNetwork NextHop Origin LocalPref MED
------------------ ------- ------ --------- ---
172.23.90.0/28 172.23.90.9 INCOMPLETE
172.23.90.15/32 172.23.90.9 INCOMPLETE
This command gets the BGP learned routes
PS C:\>Get-BgpRouteInformation -RoutingDomain Rd_002
DestinationNetwork NextHop Origin LocalPref MED
------------------ ------- ------ --------- ---
100.0.0.0/24 172.23.90.5 INCOMPLETE
100.0.0.5/32 172.23.90.5 INCOMPLETE
100.0.0.6/32 172.23.90.5 INCOMPLETE
100.0.0.255/32 172.23.90.5 INCOMPLETE
This command gets the BGP learned routes for the specified routing domain in Multi-Tenant Environment.
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 |
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 |
Specifies a string array of CIDR IPv4 and IPv6 network prefixes along with network masks for which the BGP routing information is to be retrieved.
Type: | String[] |
Aliases: | DestinationNetwork |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies the user-defined unique alphanumeric identifier for the routing domain.
Type: | String |
Aliases: | RoutingDomainName |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
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 |
Specifies the type of routes for which the information needs to be retrieved or listed.
Type: | RouteType |
Accepted values: | All, Best, Damped, Suppressed |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
String[]
Nullable<T>[[Microsoft.PowerShell.Cmdletization.GeneratedTypes.Bgp.RouteType, Microsoft.PowerShell.Cmdletization.GeneratedTypes, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]]