Export (0) Print
Expand All
Expand Minimize

Set-BgpRoutingPolicyForPeer

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

Set-BgpRoutingPolicyForPeer

Modifies BGP routing policies for BGP peers.

Syntax

Parameter Set: Set2
Set-BgpRoutingPolicyForPeer -Direction <PolicyDirection> -PolicyName <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PeerName <String[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-BgpRoutingPolicyForPeer cmdlet modifies BGP routing policies for BGP peer routers. Specify the names of the router policies and the direction of the route advertisements to which to add the policies. The cmdlet clears all the existing routing policies for peers before it applies the new set of policies. If you do not specify the PeerName parameter, the cmdlet adds the router policies that you specify to all BGP peer routers.

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

-Direction<PolicyDirection>

Specifies the direction of the route advertisements to which the policies are added.The acceptable values for this parameter are: 

-- Ingress. The routing policy applies its criteria to incoming route advertisements.
-- Egress. The routing policy applies its criteria to outgoing route advertisements.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

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

-PeerName<String[]>

Specifies an array of names of BGP peers. The cmdlet adds the router policies that you specify in the PolicyName parameter to the BGP peers.


Aliases

PeerList,PeerId

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PolicyName<String[]>

Specifies an array of names of router policies. The cmdlet adds these routers to the peers that you specify in the PeerName parameter.


Aliases

PolicyList,PolicyId

Required?

true

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

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

Examples

Example 1: Apply router policies to BGP peers

This command applies the specified router policies to the Ingress route advertisements of the BGP peer named TenantSite03. The cmdlet clears all the routing policies that you previously applied to the peers before it applies the new set of policies. The command prompts the user for confirmation before it applies the router policies.


PS C:\> Set-BgpRoutingPolicyForPeer -Direction Ingress -PeerName "TenantSite03" -PolicyName "RTPolicy02", "RTPolicy04", "RTPolicy05" 
              


Confirm
BGP peering session could currently be active for TenantSite03. Do you want to apply these policies and restart
corresponding peering sessions?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y

Example 2: Apply policies to BGP peers without confirmation

This command applies the specified router policies to the Ingress route advertisements of the BGP peer named TenantSite01. The cmdlet clears all the routing policies that you previously applied to the peers before it applies the new set of policies. Because the command includes the Force parameter, it prompts the user for confirmation before it applies the routing policies.


PS C:\> Set-BgpRoutingPolicyForPeer -Direction Ingress -PeerName "TenantSite01" -PolicyName "RTPolicy01","RTPolicy02" -Force

Related topics

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