Remove-BgpRoutingPolicy
Remove-BgpRoutingPolicy
Removes routing policies from the policy store.
Syntax
Parameter Set: Remove2
Remove-BgpRoutingPolicy [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-BgpRoutingPolicy cmdlet removes Border Gateway Protocol (BGP) routing policies from the policy store. Specify the names of the routing policies to remove. When you remove a routing policy, the BGP 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 |
-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 |
-Name<String[]>
Specifies an array of names of policies.
Aliases |
PolicyList,PolicyId,PolicyName |
Required? |
true |
Position? |
2 |
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 BGP routing policies
This command removes the BGP routing policies named RTPolicy01 and RTPolicy02. The command prompts the user for confirmation before removing the policies from the policy store.
PS C:\> Remove-BgpRoutingPolicy -Name "RTPolicy01", "RTPolicy02"
Example 2: Remove BGP routing policies without confirmation
This command removes all the BGP routing policies from the policy store. Because the cmdlet uses the Force parameter, the cmdlet removes the routing policies without prompting the user for confirmation.
PS C:\> Get-BgpRoutingPolicy | Remove-BgpRoutingPolicy -Force
Example 3: Remove BGP routing policies for a routing domain
This command removes the routing policy named RTPolicy04 from the BGP router for the routing domain named Rd_001. The command prompts the user for confirmation before removing the policy from the policy store.
PS C:\> Remove-BgpRoutingPolicy -Name "RTPolicy04" -RoutingDomain "Rd_001"