Export (0) Print
Expand All
Expand Minimize

Get-BgpRoutingPolicy

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-BgpRoutingPolicy

Gets configuration information of BGP routing policies.

Syntax

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




Detailed Description

The Get-BgpRoutingPolicy cmdlet gets configuration information of BGP routing policies from the policy store. You can specify the names and policy type of the routing policies to return. If you do not specify the Name and PolicyType parameters, the cmdlet returns all routing policies of the local BGP router.

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 of policies.


Aliases

PolicyList,PolicyId,PolicyName

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PolicyType<PolicyType>

Specifies the type of BGP routing policy. The acceptable values for this parameter are: 

-- ModifyAttribute
-- Allow
-- Deny


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RoutingDomain<String>

Specifies a 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#BgpRoutingPolicyConfig[]

Examples

Example 1: Get BGP routing policies by using a name

This command gets the BGP routing policies named RTPolicy01, RTPolicy02, RTPolicy04, and RTPolicy07.


PS C:\> Get-BgpRoutingPolicy -Name "RTPolicy01", "RTPolicy02", "RTPolicy04", "RTPolicy07"
              

Get-BgpRoutingPolicy : Policy RTPolicy07 not found.
At line:1 char:1
+ Get-BgpRoutingPolicy RTPolicy01, RTPolicy02, RTPolicy04, RTPolicy07
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : ObjectNotFound: (PS_BgpRoutingPolicy:root/Microsoft/...gpRoutingPolicy) [Get-BgpRoutingP
olicy], CimException
+ FullyQualifiedErrorId : HRESULT 80070490,Get-BgpRoutingPolicy

PolicyName : RTPolicy04
PolicyType : ModifyAttribute
MatchClauses : MatchPrefix : {10.1.4.0/24}
IgnorePrefix : {10.1.4.16/28}
SetClauses : NewLocalPref : 400

PolicyName : RTPolicy01
PolicyType : ModifyAttribute
MatchClauses : MatchASNRange : {64522, 64555}
SetClauses : NewMED : 100
AddCommunity : {645:2}

PolicyName : RTPolicy02
PolicyType : ModifyAttribute
MatchClauses : MatchASNRange : {64522, 64555}
SetClauses : NewMED : 100
AddCommunity : {645:2}


Example 2: Get all BGP routing policies

This command gets all BGP Routing policies in the policy store.


PS C:\> Get-BgpRoutingPolicy
              



PolicyName : RTPolicy04
PolicyType : ModifyAttribute
MatchClauses : MatchPrefix : {10.1.4.0/24}
IgnorePrefix : {10.1.4.16/28}
SetClauses : NewLocalPref : 400

PolicyName : RTPolicy05
PolicyType : ModifyAttribute
MatchClauses : MatchCommunity : {100:500}
SetClauses : NewMED : 500

PolicyName : RTPolicy01
PolicyType : ModifyAttribute
MatchClauses : MatchASNRange : {64522, 64555}
SetClauses : NewMED : 100
AddCommunity : {645:2}

PolicyName : RTPolicy02
PolicyType : ModifyAttribute
MatchClauses : MatchASNRange : {64522, 64555}
SetClauses : NewMED : 100
AddCommunity : {645:2}

PolicyName : RTPolicy06
PolicyType : Deny
MatchClauses : MatchASNRange : {64545, 64555}
MatchCommunity : {100:500}
SetClauses :


Example 3: Get BGP Routing policies by using a policy type

This command gets the BGP Routing policies in the policy store that are a ModifyAttribute type of policy.


PS C:\> Get-BgpRoutingPolicy -PolicyType ModifyAttribute
              



PolicyName : RTPolicy04
PolicyType : ModifyAttribute
MatchClauses : MatchPrefix : {10.1.4.0/24}
IgnorePrefix : {10.1.4.16/28}
SetClauses : NewLocalPref : 400

PolicyName : RTPolicy05
PolicyType : ModifyAttribute
MatchClauses : MatchCommunity : {100:500}
SetClauses : NewMED : 500

PolicyName : RTPolicy01
PolicyType : ModifyAttribute
MatchClauses : MatchASNRange : {64522, 64555}
SetClauses : NewMED : 100
AddCommunity : {645:2}

PolicyName : RTPolicy02
PolicyType : ModifyAttribute
MatchClauses : MatchASNRange : {64522, 64555}
SetClauses : NewMED : 100
AddCommunity : {645:2}


Example 4: Get BGP Routing policies for a Routing Domain

This command gets all the BGP routing policies in the policy store for the routing domain named Rd_001 in a multi-tenant environment. The command passes the results of the cmdlet to the Format-Table cmdlet by using the pipeline operator. The Format-Table cmdlet formats the output as a table. For more information, type Get-Help Format-Table.


PS C:\> Get-BgpRoutingPolicy -RoutingDomain "Rd_001" | ft
              


PolicyName PolicyType MatchClauses SetClauses
---------- ---------- ------------ ----------
RTPolicy04 ModifyAttribute MatchPrefix : {10.1.4.0/24} NewLocalPref : 300
IgnorePrefix : {10.1.4.16/28}


Related topics

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