Set-BgpRoutingPolicyForPeer
Set-BgpRoutingPolicyForPeer
Modifies BGP routing policies for BGP peers.
構文
Parameter Set: Set2
Set-BgpRoutingPolicyForPeer -Direction <PolicyDirection> -PolicyName <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PeerName <String[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Set-BgpRoutingPolicyForPeer cmdlet modifies BGP routing policies for BGP peer routers. Specify the names of the router policies and the direction of the route advertisements to which to add the policies. The cmdlet clears all the existing routing policies for peers before it applies the new set of policies. If you do not specify the PeerName parameter, the cmdlet adds the router policies that you specify to all BGP peer routers.
パラメーター
-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 added.このパラメーターに対して使用できる値:
-- Ingress. The routing policy applies its criteria to incoming route advertisements.
-- Egress. The routing policy applies its criteria to outgoing route advertisements.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PeerName<String[]>
Specifies an array of names of BGP peers. The cmdlet adds the router policies that you specify in the PolicyName parameter to the BGP peers.
エイリアス |
PeerList,PeerId |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-PolicyName<String[]>
Specifies an array of names of router policies. The cmdlet adds these routers to the peers that you specify in the PeerName parameter.
エイリアス |
PolicyList,PolicyId |
必須? |
true |
位置は? |
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: Apply router policies to BGP peers
This command applies the specified router policies to the Ingress route advertisements of the BGP peer named TenantSite03. The cmdlet clears all the routing policies that you previously applied to the peers before it applies the new set of policies. The command prompts the user for confirmation before it applies the router policies.
PS C:\> Set-BgpRoutingPolicyForPeer -Direction Ingress -PeerName "TenantSite03" -PolicyName "RTPolicy02", "RTPolicy04", "RTPolicy05"
Example 2: Apply policies to BGP peers without confirmation
This command applies the specified router policies to the Ingress route advertisements of the BGP peer named TenantSite01. The cmdlet clears all the routing policies that you previously applied to the peers before it applies the new set of policies. Because the command includes the Force parameter, it prompts the user for confirmation before it applies the routing policies.
PS C:\> Set-BgpRoutingPolicyForPeer -Direction Ingress -PeerName "TenantSite01" -PolicyName "RTPolicy01","RTPolicy02" -Force