Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-BgpRoutingPolicyForPeer

Remove-BgpRoutingPolicyForPeer

ps_bgproutingpolicyforpeer_v1.0.cdxml

Synopsis

Removes routing policies from BGP peers.

Syntax

Remove-BgpRoutingPolicyForPeer [-AsJob] [-CimSession] [-Direction] [-Force] [-PeerName] [-PolicyName] [-RoutingDomain] [-ThrottleLimit] [-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 <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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 <SwitchParameter>

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 <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

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"



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"):

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"



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



Online Version
Add-BgpRoutingPolicyForPeer
Set-BgpRoutingPolicyForPeer