Remove-BgpPeer

Remove-BgpPeer

Removes BGP peers from a router.

構文

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

詳細説明

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.

パラメーター

-AsJob

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

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

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

例

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"

関連トピック

Add-BgpPeer

Get-BgpPeer

Set-BgpPeer

Start-BgpPeer

Stop-BgpPeer