Get-BgpRouteInformation
Retrieves BGP route information for one or more network prefixes from the BGP routing table.
Syntax
Default (Default)
Get-BgpRouteInformation
[-Network <String[]>]
[-RoutingDomain <String>]
[-Type <RouteType>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
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.
Examples
Example 1:Get all BGP learned routes
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
Example 2: Get the BGP learned routes for a specified routing ___domain
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.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Network
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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DestinationNetwork |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-RoutingDomain
Specifies the user-defined unique alphanumeric identifier for the routing ___domain.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RoutingDomainName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
Specifies the type of routes for which the information needs to be retrieved or listed.
Parameter properties
| Type: | RouteType |
| Default value: | None |
| Accepted values: | All, Best, Damped, Suppressed |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.