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
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
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
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
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.
Parameter properties
Type:
CimSession[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Session
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
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.
Parameter properties
Type:
PolicyDirection
Default value:
None
Accepted values:
Ingress, Egress
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
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.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
PeerId, PeerList
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
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.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
PolicyList, PolicyId
Parameter sets
(All)
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
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.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
RoutingDomainName
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
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.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.