Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Get-BgpRouteInformation

Windows Server 2012 R2 and Windows 8.1

Get-BgpRouteInformation

Gets route information for network prefixes from the BGP router.

Syntax

Parameter Set: Get0
Get-BgpRouteInformation [-AsJob] [-CimSession <CimSession[]> ] [-Network <String[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-BgpRouteInformation cmdlet gets the route information for network prefixes from the Border Gateway Protocol (BGP) routing table. The cmdlet gets information about routes that the BGP router learned through the exchange of information with other routers. If you do not specify the Network parameter, the cmdlet gets route information for all network prefixes from the BGP routing table.

Parameters

-AsJob

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<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.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Network<String[]>

Specifies an array of network prefixes, in Classless InterDomain Routing (CIDR) notation.


Aliases

DestinationNetwork

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RoutingDomain<String>

Specifies the name, as a string, of a routing domain. The name of a routing domain is a unique user-defined alphanumeric string.


Aliases

RoutingDomainName

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#BgpRouteInfo[]

Examples

Example 1: Get learned routes from a BGP router

This command gets information for all learned routes from the local BGP router.


PS C:\> Get-BgpRouteInformation

Example 2: Get BGP learned routes for a routing domain

This command gets information for the learned routes from the router for the routing domain named Rd002.


PS C:\> Get-BgpRouteInformation -RoutingDomain "Rd002"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft