Get-BgpStatistics

Get-BgpStatistics

Retrieves BGP peering-related message and route advertisement statistics.

Syntax

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

Detailed Description

The Get-BgpStatistics cmdlet retrieves Border Gateway Protocol (BGP) peering-related message and route advertisement statistics.

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

-PeerName<String[]>

Specifies an array of peer names for which to retrieve the BGP message and route statistics.

Aliases

PeerId,PeerList

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RoutingDomain<String>

Specifies an ID, as a string, for a routing domain. The ID 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 (https://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#BgpStatistics[]

Examples

Example 1: Retrieve all BPG message and route statistics

This command retrieves the BGP message and route statistics.

PS C:\> Get-BgpStatistics


Example 2: Retrieve BGP message and route statistics for a routing domain

This command retrieves the BGP message and route statistics for a routing domain named Rd_02.

PS C:\> Get-BgpStatistics -RoutingDomain Rd_02