The Remove-BgpRoutingPolicyForPeer cmdlet removes Border Gateway Protocol (BGP) routing policies from BGP peers.
If a routing policy is in a multitenant deployment, you must specify the RoutingDomain parameter.
You must specify at least one of the PeerName or PolicyName parameters.
When you remove a routing policy from a BGP peer, the BGP peer router no longer uses the policy to learn and distribute routing information between autonomous systems (AS).
Examples
Example 1: Remove all routing policies from BGP peers
PS C:\> Remove-BgpRoutingPolicyForPeer -PeerName "TenantSite04", "TenantSite05", "TenantSite06"
Confirm
BGP peering session could currently be active for TenantSite04, TenantSite05, TenantSite06. Do you want to remove
these policies and restart corresponding peering sessions?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):
This command removes all the routing policies from the BGP peers named TenantSite04, TenantSite05, and TenantSite06.
The command prompts the user for confirmation before it removes the routing policies.
This command removes the routing policy named RTPolicy04 for only the Egress route advertisements from all the BGP peers.
Example 3: Remove all routing policies for a routing ___domain
PS C:\> Remove-BgpRoutingPolicyForPeer -PeerName "TenantSite01" -RoutingDomain "Rd_001"
Confirm
BGP peering session could currently be active for TenantSite01 for routing ___domain Rd_001. Do you want to remove these
policies and restart corresponding peering sessions?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y
This command removes all the routing policies from the BGP peer named TenantSite01 for the routing ___domain named Rd_001.
The command removes the routing policies for both Ingress and Egress route advertisements.
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 applied.The acceptable values for this parameter are:
Ingress
Egress
Parameter properties
Type:
PolicyDirection
Default value:
None
Accepted values:
Ingress, Egress
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
-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 removes the router policies that you specify in the PolicyName parameter from the BGP peers.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
PeerList, PeerId
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 removes these router policies from 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:
False
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.