Export (0) Print
Expand All
Expand Minimize

Get-BgpPeer

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-BgpPeer

Gets configuration information for BGP peers.

Syntax

Parameter Set: Get1
Get-BgpPeer [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-BgpPeer cmdlet gets configuration information for Border Gateway Protocol (BGP) peers. You can specify peers to get by using names or routing domains.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


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

-Name<String[]>

Specifies an array of names. The cmdlet gets configuration information for the named peers.


Aliases

PeerList,PeerId,PeerName

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RoutingDomain<String>

Specifies the name of the routing domain as a string. The name is a unique, for the multitenant gateway, 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.

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#BgpPeerConfig[]

Examples

Example 1: Get configuration information for a peer

This command gets configuration information for the peer named TenantSite17.


PS C:\> Get-BgpPeer -Name "TenantSite17"
PeerName            LocalIPAddress      PeerIPAddress       PeerASN             OperationMode       ConnectivityStatus
-------- -------------- ------------- ------- ------------- ------------------
TenantSite17 192.168.1.10 10.1.1.10 64512 Mixed Connecting

Example 2: Get configuration information for all peers

This command gets the configuration information for all peers.


PS C:\> Get-BgpPeer
PeerName            LocalIPAddress      PeerIPAddress       PeerASN             OperationMode       ConnectivityStatus
-------- -------------- ------------- ------- ------------- ------------------
TenantSite17 192.168.1.10 10.1.1.10 64512 Mixed Connecting
TenantSite22 192.168.1.10 10.1.2.10 64522 Mixed Connecting

Example 3: View formatted configuration information

This command gets configuration information for all peers, and then passes them to the Format-List cmdlet by using the pipeline operator. That cmdlet formats the output to the console. For more information, type Get-Help Format-List.


PS C:\> Get-BgpPeer "TenantSite17" | Format-List
PeerName           : TenantSite17
LocalIPAddress : 192.168.1.10
PeerIPAddress : 10.1.1.10
PeerASN : 64512
OperationMode : Server
PeeringMode : Manual
HoldTime(s) : 180
ConnectivityStatus : Stopped
IngressPolicyList : {Policy11}
EgressPolicyList :
MaxAllowedPrefix :


Example 4: Get configuration information for all peers in a routing domain

This command gets configuration information for all peers of the specified routing domain. This domain contains only a single peer named Tenant46.


PS C:\> Get-BgpPeer -RoutingDomain "Rd001"
PeerName            LocalIPAddress      PeerIPAddress       PeerASN             OperationMode       ConnectivityStatus
-------- -------------- ------------- ------- ------------- ------------------
Tenant46 10.1.1.10 192.168.1.2 64513 Mixed Connecting

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft