Edit

Share via

Add-BgpRoutingPolicyForPeer

  • Reference
Module:
RemoteAccess

Adds BGP routing policies to BGP peers.

Syntax

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

Description

The Add-BgpRoutingPolicyForPeer cmdlet adds Border Gateway Protocol (BGP) routing policies to BGP peers. Specify the names of the router policies to add to the BGP peers. If you do not specify the PeerName parameter, the cmdlet adds the router policies that you specify to all BGP peers.

Examples

Example 1: Add a routing policy to a BGP peer

PowerShell 
PS C:\> Add-BgpRoutingPolicyForPeer -PolicyName "RTPolicy01" -Direction Ingress -PeerName "TenantSite01"



Confirm
BGP peering session could currently be active for TenantSite01. 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 adds the BGP routing policy named RTPolicy01 to the BGP peer named TenantSite01. The command specifies the direction of the route advertisement for the BGP peer.

Example 2: Add a routing policy to a BGP peer in a routing domain

PowerShell 
PS C:\> Add-BgpRoutingPolicyForPeer -RoutingDomain "Rd_001" -PeerName "TenantSite01" -PolicyName "RoutingPolicy01" -Direction Ingress



Confirm
BGP peering session could currently be active for TenantSite01 for routing domain Rd_001. 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 adds the BGP routing policy named RTPolicy01 to the BGP peer named TenantSite01 for the routing domain named Rd_001. The command specifies the direction of the route advertisement for the BGP peer.

Parameters

-AsJob

ps_cimcommon_asjob

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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-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
Accepted values:Ingress, Egress
Position:Named
Default value:None
Required:True
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
Required:False
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:PeerId, PeerList
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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
Required:True
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

-WhatIf

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

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