Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Remove-BgpRoutingPolicyForPeer

Brian Lich|Last Updated: 4/3/2017

SYNOPSIS

Removes routing policies from BGP peers.

SYNTAX

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

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).

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.

Example 2: Remove an egress routing policies

PS C:\> Remove-BgpRoutingPolicyForPeer -Direction Egress -PolicyName "RTPolicy04" -Force

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Direction

Specifies the direction of the route advertisements to which the policies are applied.The acceptable values for this parameter are:

  • Ingress
  • Egress
Type: PolicyDirection
Parameter Sets: (All)
Aliases: 
Accepted values: Ingress, Egress

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String[]
Parameter Sets: (All)
Aliases: PeerList, PeerId

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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.

Type: String[]
Parameter Sets: (All)
Aliases: PolicyList, PolicyId

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases: RoutingDomainName

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Add-BgpRoutingPolicyForPeer

Set-BgpRoutingPolicyForPeer

© 2017 Microsoft