Export (0) Print
Expand All
Expand Minimize

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

Add-BgpRoutingPolicy

Adds a BGP routing policy to the policy store.

Syntax

Parameter Set: Add0
Add-BgpRoutingPolicy [-Name] <String> [-PolicyType] <PolicyType> [-AddCommunity <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ClearMED] [-Force] [-IgnorePrefix <String[]> ] [-MatchASNRange <UInt32[]> ] [-MatchCommunity <String[]> ] [-MatchNextHop <IPAddress[]> ] [-MatchPrefix <String[]> ] [-NewLocalPref <UInt32> ] [-NewMED <UInt32> ] [-NewNextHop <IPAddress> ] [-PassThru] [-RemoveCommunity <String[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Add-BgpRoutingPolicy cmdlet adds a Border Gateway Protocol (BGP) routing policy to the policy store. The cmdlet selects and configures the routes for the routing policy that match the criteria that you specify for this cmdlet. If you do not set any matching criteria, you must specify the Force parameter to add a BGP routing policy. You can set the criteria by specifying the following parameters:

-- MatchASNRange
-- MatchCommunity
-- MatchNextHop
-- MatchPrefix

Parameters

-AddCommunity<String[]>

Specifies an array of Community attribute values. The routing policy adds the Community attribute values to the BGP routes that match the criteria that you specify for the routing policy.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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

-ClearMED

Indicates that the routing policy removes the Multi-Exit Discriminator (MED) value from the route advertisements of the BGP routes that match the criteria that you specify for the routing policy.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Force

Forces the command to run without asking for user confirmation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IgnorePrefix<String[]>

Specifies an array of network prefixes. The cmdlet does not process routes that have the network prefix that you specify.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MatchASNRange<UInt32[]>

Specifies a range of autonomous system numbers (ASNs). The cmdlet matches these ASNs with the ASNs in the As-Path attribute in the BGP route advertisements. The cmdlet processes the routes that match these criteria.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MatchCommunity<String[]>

Specifies an array of Community attribute values. The cmdlet matches these Community attribute values in the BGP route advertisements. The cmdlet processes the routes that match these criteria.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MatchNextHop<IPAddress[]>

Specifies an array of Next-Hop attribute values. The cmdlet matches these IP addresses in the BGP route advertisements, and it processes the routes that match these criteria.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MatchPrefix<String[]>

Specifies an array of network prefixes. The cmdlet matches these network addresses in the BGP route advertisements, and it processes the routes that match these criteria.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies a name for the routing policy. The name of a routing policy must be unique.


Aliases

PolicyId,PolicyName

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NewLocalPref<UInt32>

Specifies a new value of the Local-Pref attribute of the BGP routes that match the criteria that you specify for this cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NewMED<UInt32>

Specifies a new value of the MED attribute of the BGP routes that match the criteria that you specify for this cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NewNextHop<IPAddress>

Specifies a new IP address value for the Next-Hop attribute of the BGP routes that match the criteria that you specify for this cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PolicyType<PolicyType>

Specifies the type of BGP routing policy or the filtering action that the cmdlet applies to the BGP routes that match the criteria that you specify for this cmdlet. The acceptable values for this parameter are: 

-- ModifyAttribute
-- Allow. The routing policy allows all routes that match the criteria for the BGP best path selection process.
-- Deny. The routing policy filters and drops all routes that match the criteria from the BGP best path selection process.


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RemoveCommunity<String[]>

Specifies an array of Community attribute values. The cmdlet removes the Community attribute values from the BGP routes that match the criteria that you specify for this cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RoutingDomain<String>

Specifies the name, as a string, of the routing domain. The ID of a routing domain is a 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: Add a BGP routing policy that modifies router attributes

This command adds a BGP routing policy named RTPolicy04 to the local BGP router. The routing policy modifies the Local-Pref attribute of the BGP routes that match the value of the MatchPrefix parameter. The command assigns the value of 400 to the Local-Pref attribute of the BGP routes that match the network prefix 10.1.4.0/24. The command specifies that the cmdlet does not modify the Local-Pref attribute of the BGP routes that have the network prefix 10.1.4.16/28.


PS C:\> Add-BgpRoutingPolicy -Name "RTPolicy04" -PolicyType ModifyAttribute -MatchPrefix 10.1.4.0/24 -IgnorePrefix 10.1.4.16/28 -NewLocalPref 400 -PassThru
              



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

Example 2: Add a BGP routing policy that disables routes

This command adds a BGP routing policy named RTPolicy06 to the local BGP router. The routing policy drops the routes that have an ASN in the range of 64545 to 64555 in the As-Path attribute from the BGP best path selection process..


PS C:\> Add-BgpRoutingPolicy -Name RTPolicy06 -PolicyType Deny -MatchASNRange 64545,64555 -PassThru
              



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


Example 3: Add a BGP routing policy for a routing domain

This command adds a BGP routing policy named RTPolicy01 to the BGP router for the routing domain named Rd_001. The routing policy sets the value of the Local-Pref attribute of the BGP routes that match the value of the MatchPrefix parameter. The command specifies that the cmdlet does not modify the Local-Pref attribute of the BGP routes that have the network prefix 10.1.4.16/28. 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:\> Add-BgpRoutingPolicy -Name RTPolicy01 -RoutingDomain "Rd_001" -PolicyType ModifyAttribute -MatchPrefix 10.1.4.0/24 -IgnorePrefix 10.1.4.16/28 -NewLocalPref 400 -PassThru | Format-Table
              


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


Related topics

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