Remove-BgpPeer

Remove-BgpPeer

Removes BGP peers from a router.

Sintaxis

Parameter Set: Remove2
Remove-BgpPeer [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Descripción detallada

The Remove-BgpPeer cmdlet removes Border Gateway Protocol (BGP) peers from a BGP router. Specify a peer to remove by using its name. This cmdlet does not uninstall the peer router software. When you remove a peer, the router removes all information collected from the peer.

Parámetros

-AsJob

-CimSession<CimSession[]>

Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.

-Force

Fuerza que el comando se ejecute sin pedir confirmación al usuario.

-Name<String[]>

Specifies an array of names. The cmdlet removes the named peers.

-RoutingDomain<String>

Specifies the name of the routing domain as a string. The name is a unique, for the multitenant gateway, user-defined alphanumeric string.

-ThrottleLimit<Int32>

Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.

-Confirm

Solicita confirmación antes de ejecutar el cmdlet.

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

Ejemplos

Example 1: Remove specified peers

This command removes the peers named TenantSite22 and TenantSite23. This command does not specify the Force parameter, so it prompts you before it removes the peers.

PS C:\> Remove-BgpPeer -Name TenantSite22,TenantSite23

Example 2: Remove all peers

This command gets all the peers by using the Get-BgpPeer cmdlet, and passes them to the current cmdlet by using the pipeline operator. The command removes all the peers. Because the command specifies the Force parameter, it does not prompt you for confirmation before it removes the peers.

PS C:\> Get-BgpPeer | Remove-BgpPeer -Force

Example 3: Remove all peers in a routing domain

This command removes the peer named Tenant16 in the routing domain Rd001 without prompting you for confirmation.

PS C:\> Remove-BgpPeer -Name "Tenant16" -Force -RoutingDomain "Rd001"

Temas relacionados

Add-BgpPeer

Get-BgpPeer

Set-BgpPeer

Start-BgpPeer

Stop-BgpPeer