Set-BgpRoutingPolicyForPeer

Modifies BGP routing policies for BGP peers.

Syntax

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

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.

Examples

Example 1: Apply router policies to BGP peers

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

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.

Example 2: Apply policies to BGP peers without confirmation

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

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.

Required Parameters

-Direction

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.
Type:PolicyDirection
Parameter Sets:Ingress, Egress
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PolicyName

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

Type:String[]
Aliases:PolicyList, PolicyId
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-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
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
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PeerName

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.

Type:String[]
Aliases:PeerList, PeerId
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False