Remove-BgpRoutingPolicyForPeer
Remove-BgpRoutingPolicyForPeer
Removes routing policies from BGP peers.
Syntax
Parameter Set: Remove1
Remove-BgpRoutingPolicyForPeer [-AsJob] [-CimSession <CimSession[]> ] [-Direction <PolicyDirection> ] [-Force] [-PeerName <String[]> ] [-PolicyName <String[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
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).
Parameters
-AsJob
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 applied.The acceptable values for this parameter are:
-- Ingress
-- Egress
Aliases |
none |
Required? |
false |
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 removes the router policies that you specify in the PolicyName parameter from 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 removes these router policies from the peers that you specify in the PeerName parameter.
Aliases |
PolicyList,PolicyId |
Required? |
false |
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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: Remove all routing policies from BGP peers
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.
PS C:\> Remove-BgpRoutingPolicyForPeer -PeerName "TenantSite04", "TenantSite05", "TenantSite06"
Example 2: Remove an egress routing policies
This command removes the routing policy named RTPolicy04 for only the Egress route advertisements from all the BGP peers.
PS C:\> Remove-BgpRoutingPolicyForPeer -Direction Egress -PolicyName "RTPolicy04" -Force
Example 3: Remove all routing policies for a routing domain
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.
PS C:\> Remove-BgpRoutingPolicyForPeer -PeerName "TenantSite01" -RoutingDomain "Rd_001"