Set-NetIPInterface

Set-NetIPInterface

Modifies an IP interface.

構文

Parameter Set: ByName
Set-NetIPInterface [[-InterfaceAlias] <String[]> ] [-AddressFamily <AddressFamily[]> ] [-AdvertiseDefaultRoute <AdvertiseDefaultRoute> {Disabled | Enabled} ] [-AdvertisedRouterLifetime <TimeSpan> ] [-Advertising <Advertising> {Disabled | Enabled} ] [-AutomaticMetric <AutomaticMetric> {Disabled | Enabled} ] [-BaseReachableTimeMs <UInt32> ] [-CimSession <CimSession[]> ] [-ClampMss <Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetIPInterface.ClampMss> {Disabled | Enabled} ] [-CompartmentId <UInt32[]> ] [-CurrentHopLimit <UInt32> ] [-DadRetransmitTimeMs <UInt32> ] [-DadTransmits <UInt32> ] [-Dhcp <Dhcp> {Disabled | Enabled} ] [-DirectedMacWolPattern <DirectedMacWolPattern> {Disabled | Enabled} ] [-EcnMarking <EcnMarking> {Disabled | UseEct1 | UseEct0 | AppDecide} ] [-ForceArpNdWolPattern <ForceArpNdWolPattern> {Disabled | Enabled} ] [-Forwarding <Forwarding> {Disabled | Enabled} ] [-IgnoreDefaultRoutes <IgnoreDefaultRoutes> {Disabled | Enabled} ] [-IncludeAllCompartments] [-InterfaceIndex <UInt32[]> ] [-InterfaceMetric <UInt32> ] [-ManagedAddressConfiguration <ManagedAddressConfiguration> {Disabled | Enabled} ] [-NeighborDiscoverySupported <NeighborDiscoverySupported[]> ] [-NeighborUnreachabilityDetection <NeighborUnreachabilityDetection> {Disabled | Enabled} ] [-NlMtuBytes <UInt32> ] [-OtherStatefulConfiguration <OtherStatefulConfiguration> {Disabled | Enabled} ] [-PassThru] [-PolicyStore <String> ] [-ReachableTime <UInt32[]> ] [-RetransmitTimeMs <UInt32> ] [-RouterDiscovery <RouterDiscovery> {Disabled | Enabled | ControlledByDHCP} ] [-ThrottleLimit <Int32> ] [-WeakHostReceive <WeakHostReceive> {Disabled | Enabled} ] [-WeakHostSend <WeakHostSend> {Disabled | Enabled} ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: InputObject (cdxml)
Set-NetIPInterface [-AdvertiseDefaultRoute <AdvertiseDefaultRoute> {Disabled | Enabled} ] [-AdvertisedRouterLifetime <TimeSpan> ] [-Advertising <Advertising> {Disabled | Enabled} ] [-AutomaticMetric <AutomaticMetric> {Disabled | Enabled} ] [-BaseReachableTimeMs <UInt32> ] [-CimSession <CimSession[]> ] [-ClampMss <Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetIPInterface.ClampMss> {Disabled | Enabled} ] [-CurrentHopLimit <UInt32> ] [-DadRetransmitTimeMs <UInt32> ] [-DadTransmits <UInt32> ] [-Dhcp <Dhcp> {Disabled | Enabled} ] [-DirectedMacWolPattern <DirectedMacWolPattern> {Disabled | Enabled} ] [-EcnMarking <EcnMarking> {Disabled | UseEct1 | UseEct0 | AppDecide} ] [-ForceArpNdWolPattern <ForceArpNdWolPattern> {Disabled | Enabled} ] [-Forwarding <Forwarding> {Disabled | Enabled} ] [-IgnoreDefaultRoutes <IgnoreDefaultRoutes> {Disabled | Enabled} ] [-InterfaceMetric <UInt32> ] [-ManagedAddressConfiguration <ManagedAddressConfiguration> {Disabled | Enabled} ] [-NeighborUnreachabilityDetection <NeighborUnreachabilityDetection> {Disabled | Enabled} ] [-NlMtuBytes <UInt32> ] [-OtherStatefulConfiguration <OtherStatefulConfiguration> {Disabled | Enabled} ] [-PassThru] [-RetransmitTimeMs <UInt32> ] [-RouterDiscovery <RouterDiscovery> {Disabled | Enabled | ControlledByDHCP} ] [-ThrottleLimit <Int32> ] [-WeakHostReceive <WeakHostReceive> {Disabled | Enabled} ] [-WeakHostSend <WeakHostSend> {Disabled | Enabled} ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

詳細説明

The Set-NetIPInterface cmdlet modifies an IP interface, including Dynamic Host Configuration Protocol (DHCP), IPv6 neighbor discovery settings, router settings and Wake On LAN (WOL) settings.

If you do not specify any parameters, this cmdlet sets all of the IP interface properties on the computer, including virtual interfaces and loopback interfaces.

パラメーター

-AddressFamily<AddressFamily[]>

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

-- IPv4
-- IPv6

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-AdvertiseDefaultRoute<AdvertiseDefaultRoute>

Specifies the default router advertisement for an interface. This parameter value indicates whether the IP interface should advertise itself as a default router regardless of whether the node has a default route itself. This parameter is valid only for advertising interfaces. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-AdvertisedRouterLifetime<TimeSpan>

Specifies a lifetime, as a TimeSpan object, for a default route. This parameter value indicates the lifetime of default routes when advertising routes on the IP interface. The default value is 1800. This parameter is valid only for advertising interfaces. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-Advertising<Advertising>

Specifies the router advertisement value for the IP interface. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

The default value is Disabled.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-AutomaticMetric<AutomaticMetric>

Specifies the value for automatic metric calculation. Automatic metric determines whether TCP/IP automatically calculates a value for an interface metric that is based on the speed of the interface. The fastest interface has the lowest interface metric value. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-BaseReachableTimeMs<UInt32>

Specifies the base value for random reachable time, in milliseconds. For more information, see RFC 2461.
The default value is 30.

Aliases	BaseReachableTime
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-CimSession<CimSession[]>

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

Aliases	Session
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-ClampMss<Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetIPInterface.ClampMss>

Specifies the MSS clamping value for the IP interface. This value determines if this IP interface clamps MSS on the forwarded TCP packets that are sent out of this interface. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-CompartmentId<UInt32[]>

Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only sets Net IP interfaces in the default compartment. If you specify a value, the cmdlet sets any matching NetIPInterface in all compartments in this field.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-CurrentHopLimit<UInt32>

Specifies a hop limit. This parameter is the value that the IP interface writes in the hop limit field for IPv6, or the Time To Live (TTL) field for IPv4, in all outbound traffic. When forwarding a packet, routers decrement the hop limit, or TTL, by 1, and discard the packet when the hop limit reaches 0. The default is defined as DefaultHopLimit in the NetIPv4Protocol and NetIPv6Protocol objects. When this parameter value is set to 0, it uses this default.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-DadRetransmitTimeMs<UInt32>

Specifies a value for the time interval between neighbor solicitation messages.

Aliases	DadRetransmitTime
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-DadTransmits<UInt32>

Specifies a value for the number of consecutive messages sent while the network driver performs duplicate address detection.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-Dhcp<Dhcp>

Specifies the Dynamic Host Configuration Protocol (DHCP) value for an IP interface. This setting is persistent across reboots and only stored in the active policy store. Changes to the persistent store will have no effect. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

The default value is Enabled.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-DirectedMacWolPattern<DirectedMacWolPattern>

Specifies the wake-up packet value for an IP interface. This parameter value determines if an IP interface is configured to wake up a computer with directed MAC packet patterns. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

The default value is Disabled.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-EcnMarking<EcnMarking>

Specifies the value for Explicit Congestion Notification (ECN) marking. This parameter value controls the specific ECN marking in the ECN field of the IP header. このパラメーターに指定できる値は、次のとおりです。

-- AppDecide. Allow an application or higher layer protocol, such as TCP, to decide how to apply ECN marking. In order for an application to fully control ECN capability value in the Network TCP setting must also be set to Enabled.
-- Disabled. Disable the ECN marking on the IP interface.
-- UseEct0. Mark all of the egress IP packets on the IP interface with the Ect0 bit set.
-- UseEct1. Mark all of the egress IP packets on the IP interface with the Ect1 bit set.

The default value is AppDecide.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-ForceArpNdWolPattern<ForceArpNdWolPattern>

Specifies the Wake On LAN (WOL) value for the IP interface. This parameter value determines if an IP interface is configured to wake up a computer with Address Resolution Protocol (ARP) or Neighbor Discovery (ND) packet patterns. The default value is Disabled. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-Forwarding<Forwarding>

Specifies the packet forwarding value for the IP interface. This value determines if this IP interface forwards packets that arrive on this interface to other interfaces. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-IgnoreDefaultRoutes<IgnoreDefaultRoutes>

Specifies a value for Default Route advertisements. If you enable this setting, default routes will not be dynamically added to the routing table. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

The default value is Disabled.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-IncludeAllCompartments

Indicates that the cmdlet includes all non-default compartments.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-InterfaceAlias<String[]>

Specifies an array of aliases of network interfaces. The cmdlet modifies IP interfaces that match the aliases.

Aliases	ifAlias
必須/オプション	false
位置	1
既定値	none
パイプライン入力の受け入れ	True (ByPropertyName)
ワイルドカード文字の受け入れ	false

-InterfaceIndex<UInt32[]>

Specifies an array of indexes of network interfaces. The cmdlet modifies IP interfaces that match the indexes.

Aliases	ifIndex
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	True (ByPropertyName)
ワイルドカード文字の受け入れ	false

-InterfaceMetric<UInt32>

Specifies a metric for an IP interface. When routes are chosen, the overall metric used to determine the preference is the sum of the route metric and the interface metric. Typically, the interface metric gives preference to a particular interface, such as using wired if both wired and wireless are available. This parameter value uses the value generated by AutomaticMetric by default. If this parameter value is set, then the AutomaticMetric parameter is automatically disabled.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-ManagedAddressConfiguration<ManagedAddressConfiguration>

Specifies the value for managed address configuration. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain an address. Setting this parameter has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-NeighborDiscoverySupported<NeighborDiscoverySupported[]>

Specifies an array of neighbor discovery values for the IP interface. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-NeighborUnreachabilityDetection<NeighborUnreachabilityDetection>

Specifies the value for Neighbor Unreachability Detection (NUD). Use this parameter to determine when a neighbor is no longer reachable. For more information, see RFC 2461. For ActiveStore, you can modify the NUD from Disabled to Enabled, but modifying NUD from Enabled to Disabled for ActiveStore fails with an invalid parameter. For the PersistentStore, you can modify the NUD to either Enabled or Disabled, but you will have to restart the interface for the setting to take effect.

このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-NlMtuBytes<UInt32>

Specifies the network layer Maximum Transmission Unit (MTU) value, in bytes, for an IP interface. For IPv4 the minimum value is 576 bytes. For IPv6 the minimum is value is 1280 bytes. For both IPv4 and IPv6, the maximum value is 2^32-1 (4294967295). You cannot set values outside these ranges. If this parameter is set to 0, then it will remain unchanged and maintain its current value. The IP interface will not transmit packets larger than the maximum value.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-OtherStatefulConfiguration<OtherStatefulConfiguration>

Specifies the value for configuration other than addresses. This parameter determines if an IP interface uses a stateful protocol, such as DHCP, to obtain configuration information other than addresses. This parameter setting has no effect on an interface that has router discovery enabled and advertising disabled. In that case, the parameter is controlled by router discovery. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-PassThru

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

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-PolicyStore<String>

Specifies a PolicyStore value. このパラメーターに指定できる値は、次のとおりです。

-- 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.

The default value is ActiveStore. Specify ActiveStore only.

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

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-ReachableTime<UInt32[]>

Specifies an array of reachable time values. This parameter is the time, in milliseconds, that a node assumes that a neighbor is reachable after having received a reachability confirmation. This parameter works with the NeighborUnreachabilityDetection parameter.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-RetransmitTimeMs<UInt32>

Specifies a value for timeout and retransmission, in milliseconds, for Neighbor Solicitation messages. For more information, see RetransTimer in RFC 2461. By default, the value is set to 1000.

Aliases	RetransmitTime
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-RouterDiscovery<RouterDiscovery>

Specifies the value for router discovery for an IP interface, このパラメーターに指定できる値は、次のとおりです。

-- ControlledByDHCP. DHCP determines if the IP Interface can be used by the computer to locate routers that reside on an attached link.
-- Disabled: IP Interface will not be used by the computer to locate routers that reside on an attached link.
-- Enabled. IP Interface can be used by the computer to locate routers that reside on an attached link.

By default, the value of this parameter is ControlledByDHCP for IPv4 and Enabled for IPv6. If the value of this parameter is enabled, an IP host can locate routers that reside on an attached link.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-ThrottleLimit<Int32>

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

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-WeakHostReceive<WeakHostReceive>

Specifies the receive value for a weak host model. By default, interface properties set this parameter to disabled. If this parameter is enabled, an IP host can receive IP packets on an interface that is not assigned the destination IP address of the packet being received. このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-WeakHostSend<WeakHostSend>

Specifies the send value for a weak host model. By default, interface properties set this parameter to disabled. If this parameter is enabled, an IP host can send IP packets on an interface that is not assigned the destination IP address of the packet being sent.このパラメーターに指定できる値は、次のとおりです。

-- Enabled
-- Disabled

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-Confirm

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

必須/オプション	false
位置	named
既定値	false
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-WhatIf

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

必須/オプション	false
位置	named
既定値	false
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

<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_NetIPInterface

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

出力

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

• None

使用例

Example 1: Modify an interface by the index value

This command modifies an IP interface object by using the interface index value of 12. The command also disables DHCP on the interface.

PS C:\> Set-NetIPInterface –InterfaceIndex 12 –Dhcp Disabled

Example 2: Modify the interface metrics

This command modifies all of the network adapters on the computer with a link speed of 100 Mbps and sets the interface metric on them to 21.

PS C:\> Get-NetAdapter | Where-Object –FilterScript {$_.LinkSpeed –Eq "100 Mbps"} | Set-NetIPInterface –InterfaceMetric 21

関連項目

Get-NetAdapter

Get-NetIPInterface

Where-Object