Export (0) Print
Expand All
Expand Minimize

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

Set-BgpRoutingPolicy

Modifies a routing policy configuration.

Syntax

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




Detailed Description

The Set-BgpRoutingPolicy cmdlet modifies the configuration of a BGP routing policy. The cmdlet selects and configures the routes for the routing policy that match the criteria that you specify for this cmdlet. 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 cmdlet adds the Community attribute values to 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

-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 cmdlet removes the Multi-Exit Discriminator (MED) value from the route advertisements 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

-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 processes the routes that match this criteria.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a routing policy.


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 anew 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 of 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?

false

Position?

named

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

-RemovePolicyClause<String[]>

Specified an array of policy clauses. The cmdlet removes these policy clauses from the routing policy.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RoutingDomain<String>

Specifies a name, as a string, for 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

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

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: Modify a BGP routing policy

This command modifies the routing policy named RTPolicy01. The command sets the ModifyAttribute policy type of the routing policy, and specifies the value 100 for the MED attribute of the BGP routes that match the criteria that you specify for the routing policy.


PS C:\> Set-BgpRoutingPolicy -Name "RTPolicy01" -PolicyType ModifyAttribute -NewMED 100 -PassThru
              


Confirm
BGP routing policy RTPolicy01 could currently be active. Do you want to apply these changes and restart corresponding
peerings?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):


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

Example 2: Modify the community attribute of a BGP routing policy

This command modifies the MatchCommunity attribute for the BGP routing policy named RTPolicy06. Because the cmdlet uses the Force parameter, the cmdlet modifies the routing policy without prompting the user for confirmation.


PS C:\> Set-BgpRoutingPolicy -Name "RTPolicy06" -MatchCommunity 100:500 -Force -PassThru
              



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

Example 3: Modify a BGP routing policy of a routing domain

This command removes the routing policy named RTPolicy04 from the BGP router for the routing domain named Rd_001. The command prompts the user for confirmation before it removes the routing policy.


PS C:\> Set-BgpRoutingPolicy -Name "RTPolicy04" -RoutingDomain "Rd_001" -NewLocalPref 300 -PassThru
              


Confirm
BGP routing policy RTPolicy04 could currently be active. Do you want to apply these changes and restart corresponding
peerings for routing domain Rd_001?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):


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



Related topics

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