Remove-BgpRoutingPolicyForPeer
Remove-BgpRoutingPolicyForPeer
Removes routing policies from BGP peers.
構文
Parameter Set: Remove1
Remove-BgpRoutingPolicyForPeer [-AsJob] [-CimSession <CimSession[]> ] [-Direction <PolicyDirection> ] [-Force] [-PeerName <String[]> ] [-PolicyName <String[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
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).
パラメーター
-AsJob
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CimSession<CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。
エイリアス |
Session |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Direction<PolicyDirection>
Specifies the direction of the route advertisements to which the policies are applied.このパラメーターに対して使用できる値:
-- Ingress
-- Egress
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
PeerList,PeerId |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
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.
エイリアス |
PolicyList,PolicyId |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
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.
エイリアス |
RoutingDomainName |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-ThrottleLimit<Int32>
このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0
を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドレットを実行する前に、ユーザーに確認を求めます。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
例
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"
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"