Get-BgpRoutingPolicy

Get-BgpRoutingPolicy

Gets configuration information of BGP routing policies.

構文

Parameter Set: Get1
Get-BgpRoutingPolicy [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-PolicyType <PolicyType> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

詳細説明

The Get-BgpRoutingPolicy cmdlet gets configuration information of BGP routing policies from the policy store. You can specify the names and policy type of the routing policies to return. If you do not specify the Name and PolicyType parameters, the cmdlet returns all routing policies of the local BGP router.

パラメーター

-AsJob

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-CimSession<CimSession[]>

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

エイリアス

Session

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Name<String[]>

Specifies an array of names of policies.

エイリアス

PolicyList,PolicyId,PolicyName

必須?

false

位置は?

2

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-PolicyType<PolicyType>

Specifies the type of BGP routing policy. このパラメーターに対して使用できる値:

-- ModifyAttribute
-- Allow
-- Deny

エイリアス

なし

必須?

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

<CommonParameters>

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

入力

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

出力

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

  • Microsoft.Management.Infrastructure.CimInstance#BgpRoutingPolicyConfig[]

Example 1: Get BGP routing policies by using a name

This command gets the BGP routing policies named RTPolicy01, RTPolicy02, RTPolicy04, and RTPolicy07.

PS C:\> Get-BgpRoutingPolicy -Name "RTPolicy01", "RTPolicy02", "RTPolicy04", "RTPolicy07"

Example 2: Get all BGP routing policies

This command gets all BGP Routing policies in the policy store.

PS C:\> Get-BgpRoutingPolicy

Example 3: Get BGP Routing policies by using a policy type

This command gets the BGP Routing policies in the policy store that are a ModifyAttribute type of policy.

PS C:\> Get-BgpRoutingPolicy -PolicyType ModifyAttribute

Example 4: Get BGP Routing policies for a Routing Domain

This command gets all the BGP routing policies in the policy store for the routing domain named Rd_001 in a multi-tenant environment. 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:\> Get-BgpRoutingPolicy -RoutingDomain "Rd_001" | ft

関連トピック

Set-BgpRoutingPolicy

Add-BgpRoutingPolicy

Remove-BgpRoutingPolicy