Set-NetRoute

Set-NetRoute

Modifies an entry or entries in the IP routing table.

構文

Parameter Set: ByName
Set-NetRoute [[-DestinationPrefix] <String[]> ] [-AddressFamily <AddressFamily[]> ] [-CimSession <CimSession[]> ] [-IncludeAllCompartments] [-InterfaceAlias <String[]> ] [-InterfaceIndex <UInt32[]> ] [-NextHop <String[]> ] [-PassThru] [-PolicyStore <String> ] [-PreferredLifetime <TimeSpan> ] [-Protocol <Protocol[]> ] [-Publish <Publish> {No | Age | Yes} ] [-RouteMetric <UInt16> ] [-ThrottleLimit <Int32> ] [-ValidLifetime <TimeSpan> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: InputObject (cdxml)
Set-NetRoute [-CimSession <CimSession[]> ] [-PassThru] [-PreferredLifetime <TimeSpan> ] [-Publish <Publish> {No | Age | Yes} ] [-RouteMetric <UInt16> ] [-ThrottleLimit <Int32> ] [-ValidLifetime <TimeSpan> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

詳細説明

The Set-NetRoute cmdlet modifies entries in the IP routing table. Specify routes to modify by using the DestinationPrefix parameter or the NextHop parameter. You can also specify routes by using the Get-NetRoute cmdlet. If you do not specify which routes to modify, the cmdlets modifies all of the routes on the computer.

IP routing is the process of forwarding a packet based on the destination IP address. Routing occurs at TCP/IP hosts and at IP routers. The sending host or router determines where to forward the packet. To determine where to forward a packet, the host or router consults a routing table that is stored in memory. When TCP/IP starts, it creates entries in the routing table. You can add entries either manually or automatically.

For more information about routing, see Chapter 5 - IP Routing (https://technet.microsoft.com/library/bb727001.aspx) in the TechNet library.

After you create an entry in the routing table, you cannot modify the destination prefix or the next hop value. If necessary, use the Remove-NetRoute cmdlet to remove the entry, and then recreate it with the desired values by using the New-NetRoute cmdlet.

パラメーター

-AddressFamily<AddressFamily[]>

Specifies an array of IP address families of IP routes. The cmdlet modifies the family that you specify for the IP route. このパラメーターに指定できる値は、次のとおりです。

-- IPv4
-- IPv6

-CimSession<CimSession[]>

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

-DestinationPrefix<String[]>

Specifies an array of destination prefixes of IP routes. The cmdlet modifies settings for this IP route. A destination prefix contains an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway.

-IncludeAllCompartments

Indicates that the cmdlet includes routes from all configured network compartments. If you do not specify this parameter, the cmdlet modifies only routes in the default network compartment.

-InterfaceAlias<String[]>

Specifies an array of aliases of network interfaces. The cmdlet modifies IP routes for the interfaces that have the aliases that you specify.

-InterfaceIndex<UInt32[]>

Specifies an array of indexes of network interfaces. The cmdlet modifies IP routes for the interfaces located at the indexes that you specify.

-NextHop<String[]>

Specifies an array of next hop values. The cmdlet modifies the routes that have these values. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet.

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットから出力は生成されません。

-PolicyStore<String>

Specifies a PolicyStore value. The cmdlet changes the PolicyStore value to the value that you specify. このパラメーターに指定できる値は、次のとおりです。

-- ActiveStore. The IP address information is valid.
-- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.

Specify ActiveStore only.

If you do not specify this parameter, the default entries are created in both the ActiveStore and the PersistentStore.

-PreferredLifetime<TimeSpan>

Specifies a preferred lifetime, as a TimeSpan object, of an IP route. The cmdlet changes the lifetime to the value that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan.

-Protocol<Protocol[]>

Specifies an array of types of routing protocols. The cmdlet changes the protocol to the value you specify. このパラメーターに指定できる値は、次のとおりです。

-- Bbn
-- Bgp
-- Dhcp
-- Dvmrp
-- Egp
-- Eigrp
-- EsIs
-- Ggp
-- Hello
-- Icmp
-- Idpr
-- Igrp
-- IsIs
-- Local
-- NetMgmt
-- Ospf
-- Rip
-- Rpl
-- Other

-Publish<Publish>

Specifies the publish setting of an IP route. The cmdlet changes the publish value to the value that you specify. このパラメーターに指定できる値は、次のとおりです。

-- No. Do not publish or advertise IP route information in router advertisements.
-- Yes. Publish and advertise IP route information with an infinite valid lifetime in router advertisements.
-- Age. Publish and advertise IP route information with a finite valid lifetime, in router advertisements. Specify a valid lifetime by using the ValidLifetime parameter.

-RouteMetric<UInt16>

Specifies an integer route metric for an IP route. The cmdlet changes the metric to the value that you specify. To choose among multiple routes, the computer adds this value to the interface metric value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.

-ThrottleLimit<Int32>

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

-ValidLifetime<TimeSpan>

Specifies a valid lifetime, as a TimeSpan object, for an IP route. The cmdlet changes the lifetime to the value that you specify. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

-WhatIf

コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。

<CommonParameters>

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

<WorkflowParameters>

入力

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

• Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetPrefixPolicy

  Microsoft.Management.Infrastructure.CimInstance オブジェクトは、Windows Management Instrumentation (WMI) オブジェクトを表示するラッパー クラスです。基になる WMI オブジェクトの名前空間とクラス名は、シャープ記号 (#) に続くパスで指定されます。

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

• None

使用例

Example 1: Change the route metric

This command changes the route metric to 257. This route is less preferred than routes that have the default value of 256.

PS C:\> Set-NetRoute –RouteMetric 257

Example 2: Modify the preferred lifetime

The first command uses the New-TimeSpan cmdlet to create a time span of one day, and then stores it in the $TimeSpan variable. For more information, type Get-Help New-TimeSpan.

The second command changes the lifetime of the IP route that has the destination prefix 192.168.0.0/24. The command specifies the object stored in the $TimeSpan variable as the new preferred lifetime.

PS C:\> $TimeSpan = New-TimeSpan –Days 1
PS C:\> Set-NetRoute –DestinationPrefix "192.168.0.0/24" –PreferredLifetime $TimeSpan

関連項目

Find-NetRoute

Get-NetRoute

New-NetRoute

New-TimeSpan

Remove-NetRoute

Set-NetIPInterface