Add-BgpRoutingPolicy

Add-BgpRoutingPolicy

Adds a BGP routing policy to the policy store.

構文

Parameter Set: Add0
Add-BgpRoutingPolicy [-Name] <String> [-PolicyType] <PolicyType> [-AddCommunity <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ClearMED] [-Force] [-IgnorePrefix <String[]> ] [-MatchASNRange <UInt32[]> ] [-MatchCommunity <String[]> ] [-MatchNextHop <IPAddress[]> ] [-MatchPrefix <String[]> ] [-NewLocalPref <UInt32> ] [-NewMED <UInt32> ] [-NewNextHop <IPAddress> ] [-PassThru] [-RemoveCommunity <String[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

詳細説明

The Add-BgpRoutingPolicy cmdlet adds a Border Gateway Protocol (BGP) routing policy to the policy store. The cmdlet selects and configures the routes for the routing policy that match the criteria that you specify for this cmdlet. If you do not set any matching criteria, you must specify the Force parameter to add a BGP routing policy. You can set the criteria by specifying the following parameters:

-- MatchASNRange
-- MatchCommunity
-- MatchNextHop
-- MatchPrefix

パラメーター

-AddCommunity<String[]>

Specifies an array of Community attribute values. The routing policy adds the Community attribute values to the BGP routes that match the criteria that you specify for the routing policy.

-AsJob

-CimSession<CimSession[]>

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

-ClearMED

Indicates that the routing policy removes the Multi-Exit Discriminator (MED) value from the route advertisements of the BGP routes that match the criteria that you specify for the routing policy.

-Force

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

-IgnorePrefix<String[]>

Specifies an array of network prefixes. The cmdlet does not process routes that have the network prefix that you specify.

-MatchASNRange<UInt32[]>

Specifies a range of autonomous system numbers (ASNs). The cmdlet matches these ASNs with the ASNs in the As-Path attribute in the BGP route advertisements. The cmdlet processes the routes that match these criteria.

-MatchCommunity<String[]>

Specifies an array of Community attribute values. The cmdlet matches these Community attribute values in the BGP route advertisements. The cmdlet processes the routes that match these criteria.

-MatchNextHop<IPAddress[]>

Specifies an array of Next-Hop attribute values. The cmdlet matches these IP addresses in the BGP route advertisements, and it processes the routes that match these criteria.

-MatchPrefix<String[]>

Specifies an array of network prefixes. The cmdlet matches these network addresses in the BGP route advertisements, and it processes the routes that match these criteria.

-Name<String>

Specifies a name for the routing policy. The name of a routing policy must be unique.

-NewLocalPref<UInt32>

Specifies a new value of the Local-Pref attribute of the BGP routes that match the criteria that you specify for this cmdlet.

-NewMED<UInt32>

Specifies a new value of the MED attribute of the BGP routes that match the criteria that you specify for this cmdlet.

-NewNextHop<IPAddress>

Specifies a new IP address value for the Next-Hop attribute of the BGP routes that match the criteria that you specify for this cmdlet.

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

-PolicyType<PolicyType>

Specifies the type of BGP routing policy or the filtering action that the cmdlet applies to the BGP routes that match the criteria that you specify for this cmdlet. このパラメーターに対して使用できる値:

-- ModifyAttribute
-- Allow. The routing policy allows all routes that match the criteria for the BGP best path selection process.
-- Deny. The routing policy filters and drops all routes that match the criteria from the BGP best path selection process.

-RemoveCommunity<String[]>

Specifies an array of Community attribute values. The cmdlet removes the Community attribute values from the BGP routes that match the criteria that you specify for this cmdlet.

-RoutingDomain<String>

Specifies the name, as a string, of the routing domain. The ID of a routing domain is a user-defined alphanumeric string.

-ThrottleLimit<Int32>

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

<CommonParameters>

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

入力

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

出力

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

• Microsoft.Management.Infrastructure.CimInstance#BgpRoutingPolicyConfig

例

Example 1: Add a BGP routing policy that modifies router attributes

This command adds a BGP routing policy named RTPolicy04 to the local BGP router. The routing policy modifies the Local-Pref attribute of the BGP routes that match the value of the MatchPrefix parameter. The command assigns the value of 400 to the Local-Pref attribute of the BGP routes that match the network prefix 10.1.4.0/24. The command specifies that the cmdlet does not modify the Local-Pref attribute of the BGP routes that have the network prefix 10.1.4.16/28.

PS C:\> Add-BgpRoutingPolicy -Name "RTPolicy04" -PolicyType ModifyAttribute -MatchPrefix 10.1.4.0/24 -IgnorePrefix 10.1.4.16/28 -NewLocalPref 400 -PassThru

Example 2: Add a BGP routing policy that disables routes

This command adds a BGP routing policy named RTPolicy06 to the local BGP router. The routing policy drops the routes that have an ASN in the range of 64545 to 64555 in the As-Path attribute from the BGP best path selection process..

PS C:\> Add-BgpRoutingPolicy -Name RTPolicy06 -PolicyType Deny -MatchASNRange 64545,64555 -PassThru

Example 3: Add a BGP routing policy for a routing domain

This command adds a BGP routing policy named RTPolicy01 to the BGP router for the routing domain named Rd_001. The routing policy sets the value of the Local-Pref attribute of the BGP routes that match the value of the MatchPrefix parameter. The command specifies that the cmdlet does not modify the Local-Pref attribute of the BGP routes that have the network prefix 10.1.4.16/28. The command passes the results of the cmdlet to the Format-Table cmdlet by using the pipeline operator. The Format-Table cmdlet formats the output as a table. For more information, type Get-Help Format-Table.

PS C:\> Add-BgpRoutingPolicy -Name RTPolicy01 -RoutingDomain "Rd_001" -PolicyType ModifyAttribute -MatchPrefix 10.1.4.0/24 -IgnorePrefix 10.1.4.16/28 -NewLocalPref 400 -PassThru | Format-Table

関連トピック

Get-BgpRoutingPolicy

Set-BgpRoutingPolicy

Remove-BgpRoutingPolicy