Stop-BgpPeer

Stop-BgpPeer

Stops routing sessions for BGP peers.

Sintaxis

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

Descripción detallada

The Stop-BgpPeer cmdlet stops routing sessions for Border Gateway Protocol (BGP) peers. Use the Start-BgpPeer cmdlet to start a routing session. When you stop a session, both peer routers lose all the information learned from each other.

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 starts routing sessions for 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: Stop a routing session

This command stops the session for the peer named Tenant18. This command specifies the Force parameter, so the command does not prompt you for confirmation.

PS C:\> Stop-BgpPeer -Name "Tenant18" -Force

Example 2: Stop all sessions

This command gets all the peers by using the Get-BgpPeer cmdlet, and then passes them to the current cmdlet by using the pipeline operator. The command stops the sessions for all the peers. This command does not specify the Force parameter, so it prompts the user for confirmation of each session to stop.

PS C:\> Get-BgpPeer | Stop-BgpPeer

Example 3: Stop a routing session in a multitenant evironment

This command stops the routing session for the peer named Tenant22 in the specified routing domain of a multitenant environment.

PS C:\> Stop-BgpPeer -Name "TenantSite22" -RoutingDomain "Rd001"

Temas relacionados

Add-BgpPeer

Get-BgpPeer

Remove-BgpPeer

Set-BgpPeer

Start-BgpPeer