Export (0) Print
Expand All
Expand Minimize

Get-BgpRouter

Windows Server 2012 R2 and Windows 8.1

Updated: September 24, 2014

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

Get-BgpRouter

Gets configuration information for BGP routers.

Syntax

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




Detailed Description

The Get-BgpRouter cmdlet gets router configuration information for Border Gateway Protocol (BGP) routers. In a multitenant deployment, the cmdlet adds a BGP router for the routing domain or a tenant. In a non-multitenant deployment, the cmdlet configures the BGP router for the local computer. In a multitenant deployment, you must specify the RoutingDomain parameter. In a non-multitenant deployment, do not specify the RoutingDomain parameter.

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

-RoutingDomain<String[]>

Specifies an 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.

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

Examples

Example 1: Get configuration information of a BGP router

This command gets the configuration information of the local BGP router.


PS C:\> Get-BgpRouter
              


RoutingDomain :
BgpIdentifier : 192.168.1.10
LocalASN : 64513
CompareMEDAcrossASN : False
DefaultGatewayRouting : False
IPv6Routing : Disabled
LocalIPv6Address :
PeerName :
PolicyName :

Example 2: Get configuration information of a router for a routing domain

This command gets the configuration information of the BGP router for the routing domain that has the ID Rd_001.


PS C:\> Get-BgpRouter -RoutingDomain "Rd_001"
              



RoutingDomain : Rd_001
BgpIdentifier : 172.22.226.39
LocalASN : 64522
CompareMEDAcrossASN : False
DefaultGatewayRouting : False
IPv6Routing : Disabled
LocalIPv6Address :
PeerName : {Tenant01}
PolicyName :


Related topics

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