Stop-BgpPeer

Stop-BgpPeer

Stops routing sessions for BGP peers.

Syntax

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

Detaillierte Beschreibung

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.

Parameter

-AsJob

Aliasse

Keiner

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-CimSession<CimSession[]>

Führt das Cmdlet in einer Remotesitzung oder auf einem Remotecomputer aus. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, z. B. die Ausgabe eines Cmdlets New-CimSession oder Get-CimSession. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.

Aliasse

Session

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-Force

Erzwingt, dass der Befehl ohne Benutzerbestätigung ausgeführt wird.

Aliasse

Keiner

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-Name<String[]>

Specifies an array of names. The cmdlet starts routing sessions for the named peers.

Aliasse

PeerList,PeerId,PeerName

Erforderlich?

true

Position?

2

Standardwert

Keiner

Pipelineeingaben akzeptieren?

True (ByPropertyName)

Platzhalterzeichen akzeptieren?

false

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

Aliasse

RoutingDomainName

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

True (ByPropertyName)

Platzhalterzeichen akzeptieren?

false

-ThrottleLimit<Int32>

Gibt die maximale Anzahl von gleichzeitigen Vorgängen an, die zum Ausführen dieses Cmdlets eingerichtet werden können. Wenn dieser Parameter ausgelassen oder der Wert 0 eingegeben wird, berechnet Windows PowerShell® einen optimalen Drosselungsgrenzwert für das Cmdlet basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden. Die Drosselungsgrenze gilt nur für das aktuelle Cmdlet und nicht für die Sitzung oder den Computer.

Aliasse

Keiner

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-Confirm

Sie werden vor dem Ausführen des Cmdlets zur Bestätigung aufgefordert.

Erforderlich?

false

Position?

named

Standardwert

falsch

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Erforderlich?

false

Position?

named

Standardwert

falsch

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

Beispiele

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"

Verwandte Themen

Add-BgpPeer

Get-BgpPeer

Remove-BgpPeer

Set-BgpPeer

Start-BgpPeer