Set-NetVirtualizationCustomerRoute

Set-NetVirtualizationCustomerRoute

Changes the metric value for virtual routes.

構文

Parameter Set: ByName
Set-NetVirtualizationCustomerRoute [-AsJob] [-CimSession <CimSession[]> ] [-DestinationPrefix <String[]> ] [-Metric <UInt32> ] [-NextHop <String[]> ] [-PassThru] [-RoutingDomainID <String[]> ] [-ThrottleLimit <Int32> ] [-VirtualSubnetID <UInt32[]> ] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-NetVirtualizationCustomerRoute -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Metric <UInt32> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

詳細説明

The Set-NetVirtualizationCustomerRoute cmdlet changes the metric value for virtual routes in a virtual network. Network Virtualization allows more than one virtual network to exist on the same physical network. Computers can exchange network traffic with a virtual machine (VM) by using a Customer Address within a virtual network. Network Virtualization uses the metric to choose a preferred route from several possible routes. For more information, see Network Virtualization technical details (https://technet.microsoft.com/library/jj134174.aspx) on TechNet.

You can use the Get-NetVirtualizationCustomerRoute cmdlet to get routes to modify, or you can use any combination of the following values to specify which routes to modify:

-- Destination prefix. A range of IP addresses as an IP prefix.
-- Next hop. A next hop gateway for the specified destionation addresses.
-- Routing domain ID. An ID for a virtual network that can include multiple virtual subnets.
-- Virtual subnet ID. An ID for a virtual subnet.

パラメーター

-AsJob

-CimSession<CimSession[]>

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

-DestinationPrefix<String[]>

Specifies an array of IP prefixes, as strings, for destination networks. You can specify IPv4 and IPv6 addresses. Use prefix notation: 0.0.0.0/0.

-InputObject<CimInstance[]>

このコマンドレットへの入力を指定します。このパラメーターを使用するか、パイプを使用して入力をこのコマンドレットに渡すことができます。

-Metric<UInt32>

Specifies a new value for the metric of a route.

-NextHop<String[]>

Specifies an array of IP addresses for next hop gateways for routes.

-PassThru

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

-RoutingDomainID<String[]>

Specifies an array of IDs for routing domains. Routing domains use a GUID style ID: {11111111-2222-3333-4444-000000000000}.

-ThrottleLimit<Int32>

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

-VirtualSubnetID<UInt32[]>

Specifies an array of IDs for virtual subnets. このパラメーターに対して使用できる値:integers from 4096 through 16777214.

<CommonParameters>

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

入力

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

出力

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

例

Example 1: Change a metric value

This command changes the metric value to 3 for a Customer Route that has the specified destination prefix.

PS C:\> Set-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16" -Metric 3

Example 2: Change a metric value for mulitple Customer Routes

This command uses the Get-NetVirtualizationCustomerRoute to get all the Customer Routes that have a next hop gateway of 172.16.0.1. The command passes them by using the pipe operator to the Set-NetVirtualizationCustomerRoute cmdlet, which changes the metric value to 3 for those Customer Routes.

PS C:\> Get-NetVirtualizationCustomerRoute -NextHop "172.16.0.1" | Set-NetVirtualizationCustomerRoute -Metric 3

関連トピック

Get-NetVirtualizationCustomerRoute

New-NetVirtualizationCustomerRoute

Remove-NetVirtualizationCustomerRoute