Get-BgpRoutingPolicy
Gets configuration information of BGP routing policies.
Syntax
Get-BgpRoutingPolicy
[[-Name] <String[]>]
[-PolicyType <PolicyType>]
[-RoutingDomain <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-BgpRoutingPolicy
[-AllRoutingDomains]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] 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.
Examples
Example 1: Get BGP routing policies by using a name
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}This command gets the BGP routing policies named RTPolicy01, RTPolicy02, RTPolicy04, and RTPolicy07.
Example 2: Get all BGP routing policies
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 :This command gets all BGP Routing policies in the policy store.
Example 3: Get BGP Routing policies by using a policy type
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}This command gets the BGP Routing policies in the policy store that are a ModifyAttribute type of policy.
Example 4: Get BGP Routing policies for a Routing Domain
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}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.
Parameters
-AllRoutingDomains
Use this command to retrieve details about all routing domains.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies an array of names of policies.
| Type: | String[] |
| Aliases: | PolicyList, PolicyId, PolicyName |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PolicyType
Specifies the type of BGP routing policy. The acceptable values for this parameter are:
- ModifyAttribute
- Allow
- Deny
| Type: | PolicyType |
| Accepted values: | Deny, Allow, ModifyAttribute |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RoutingDomain
Specifies a name, as a string, of a routing domain. The name of a routing domain is a unique user-defined alphanumeric string.
| Type: | String |
| Aliases: | RoutingDomainName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ThrottleLimit
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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
String[]
Microsoft.PowerShell.Cmdletization.GeneratedTypes.Bgp.PolicyType