Export (0) Print
Expand All

Set-NetIPInterface

Applies To: Windows Server 2012

Set-NetIPInterface

Modifies IP interface properties.

Syntax

Parameter Set: ByName
Set-NetIPInterface [[-InterfaceAlias] <String[]> ] [-AddressFamily <AddressFamily[]> ] [-AdvertiseDefaultRoute <AdvertiseDefaultRoute> ] [-AdvertisedRouterLifetime <TimeSpan> ] [-Advertising <Advertising> ] [-AsJob] [-AutomaticMetric <AutomaticMetric> ] [-BaseReachableTimeMs <UInt32> ] [-CimSession <CimSession[]> ] [-CurrentHopLimit <UInt32> ] [-DadTransmits <UInt32> ] [-Dhcp <Dhcp> ] [-DirectedMacWolPattern <DirectedMacWolPattern> ] [-EcnMarking <EcnMarking> ] [-ForceArpNdWolPattern <ForceArpNdWolPattern> ] [-Forwarding <Forwarding> ] [-IgnoreDefaultRoutes <IgnoreDefaultRoutes> ] [-InterfaceIndex <UInt32[]> ] [-InterfaceMetric <UInt32> ] [-ManagedAddressConfiguration <ManagedAddressConfiguration> ] [-NeighborDiscoverySupported <NeighborDiscoverySupported[]> ] [-NeighborUnreachabilityDetection <NeighborUnreachabilityDetection> ] [-NlMtuBytes <UInt32> ] [-OtherStatefulConfiguration <OtherStatefulConfiguration> ] [-PassThru] [-PolicyStore <String> ] [-ReachableTime <UInt32[]> ] [-RetransmitTimeMs <UInt32> ] [-RouterDiscovery <RouterDiscovery> ] [-ThrottleLimit <Int32> ] [-WeakHostReceive <WeakHostReceive> ] [-WeakHostSend <WeakHostSend> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-NetIPInterface -InputObject <CimInstance[]> [-AdvertiseDefaultRoute <AdvertiseDefaultRoute> ] [-AdvertisedRouterLifetime <TimeSpan> ] [-Advertising <Advertising> ] [-AsJob] [-AutomaticMetric <AutomaticMetric> ] [-BaseReachableTimeMs <UInt32> ] [-CimSession <CimSession[]> ] [-CurrentHopLimit <UInt32> ] [-DadTransmits <UInt32> ] [-Dhcp <Dhcp> ] [-DirectedMacWolPattern <DirectedMacWolPattern> ] [-EcnMarking <EcnMarking> ] [-ForceArpNdWolPattern <ForceArpNdWolPattern> ] [-Forwarding <Forwarding> ] [-IgnoreDefaultRoutes <IgnoreDefaultRoutes> ] [-InterfaceMetric <UInt32> ] [-ManagedAddressConfiguration <ManagedAddressConfiguration> ] [-NeighborUnreachabilityDetection <NeighborUnreachabilityDetection> ] [-NlMtuBytes <UInt32> ] [-OtherStatefulConfiguration <OtherStatefulConfiguration> ] [-PassThru] [-RetransmitTimeMs <UInt32> ] [-RouterDiscovery <RouterDiscovery> ] [-ThrottleLimit <Int32> ] [-WeakHostReceive <WeakHostReceive> ] [-WeakHostSend <WeakHostSend> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-NetIPInterface cmdlet modifies IP interface properties such as is DHCP, IPv6 neighbor discovery settings, router settings and Wake on LAN (WoL) settings. The NetIPInterface object is automatically created by the computer and thus the NetIPInterface object has no New or Remove verbs.

Without identifier parameters, this cmdlet sets all of the IP interface properties on the computer, including virtual interfaces and loopback interfaces.

Parameters

-AddressFamily<AddressFamily[]>

Specifies the IP address family of the IP interface. The acceptable values for this parameter are: 
-- IPv4: IP Interface properties for interfaces with IPv4 addresses.
-- IPv6: IP Interface properties for interfaces with IPv6 addresses.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AdvertiseDefaultRoute<AdvertiseDefaultRoute>

Modifies the IP interface advertise default route property. 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. Valid only for advertising interfaces. The acceptable values for this parameter are: 
-- Enabled: The IP interface advertises itself as the default router.
-- Disabled: The IP interface does not advertise itself as the default router.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AdvertisedRouterLifetime<TimeSpan>

Modifies IP interface advertised router lifetime property. This parameter value indicates the lifetime of default routes when advertising routes on the IP interface, in seconds. The default value is 1800. Valid only for advertising interfaces. AdvertisedRouterLifetime uses time as defined by the TimeSpan structure.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Advertising<Advertising>

Modifies IP interface properties only for interfaces that send or do not send Router Advertisements. By default, interface properties have advertising set to Disabled. The acceptable values for this parameter are: 
-- Enabled: IP Interface is enabled to send Router Advertisements.
-- Disabled: IP Interface has Router Advertisements disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutomaticMetric<AutomaticMetric>

Modifies the automatic metric property. This parameter value determines whether TCP/IP automatically calculates a value for an interface metric that is based on the speed of the interface. The highest-speed interface has the lowest interface metric value. The acceptable values for this parameter are: 
-- Enabled: TCP/IP automatically calculates a value for an InterfaceMetric that is based on the speed of the interface.
-- Disabled: TCP/IP uses the manual setting for InterfaceMetric.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BaseReachableTimeMs<UInt32>

Modifies the BaseReachableTime property. BaseReachableTime is the base for random reachable time, in milliseconds. This parameter is described in RFC 2461.
The default value is 30.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CurrentHopLimit<UInt32>

Modifies the current hop limit property. This parameter value is the value that the IP interface writes in the hop limit (for IPv6) or TTL (for IPv4) field in all outbound traffic. When forwarding a packet, routers are required to decrease the Hop Limit or TTL by 1 and to discard the packet when the Hop Limit or TTL is 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

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DadTransmits<UInt32>

Modifies the dad transmits property. This parameter value is the number of duplicate address detection transmits.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Dhcp<Dhcp>

Modifies the enabled state for the IP interface of the Dynamic Host Configuration Protocol (DHCP).
Note: This setting is persistent across reboots and only stored in the active policy store.
Changes to the persistent store will have no effect.
The acceptable values for this parameter are: 
-- Enabled: IP Interface properties for interfaces that have DHCP enabled.
-- Disabled: IP Interface properties for interfaces that have DHCP disabled.
The default value is Enabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DirectedMacWolPattern<DirectedMacWolPattern>

Modifies the directed MAC WoL pattern. This parameter value determines if an IP interface is configured to wake up a computer with directed MAC packet patterns. By default, IP interface properties have this parameter value set to Disabled. The acceptable values for this parameter are: 
-- Enabled: IP Interface properties for interfaces that have DirecteMacWolPattern enabled.
-- Disabled: IP Interface properties for interfaces that have DirecteMacWolPattern disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EcnMarking<EcnMarking>

Modifies the ECN marking value. This parameter value controls the specific ECN marking in the ECN field of the IP header. The acceptable values for this parameter are: 
-- AppDecide: Allow an application or higher layer 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

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ForceArpNdWolPattern<ForceArpNdWolPattern>

Modifies the force ARP ND WoL pattern parameter. This parameter value determines if an IP interface is configured to wake up a computer with Address Resolution Protocol (ARP) and Neighbor Discovery (ND) packet patterns. By default, IP interface properties have this parameter value set to Disabled. The acceptable values for this parameter are: 
-- Enabled: IP Interface properties for interfaces that have ForceArpNdWolPattern enabled.
-- Disabled: IP Interface properties for interfaces that have ForceArpNdWolPattern disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Forwarding<Forwarding>

Modifies the forwarding property. The acceptable values for this parameter are: 
-- Enabled: Packets arriving on this IP interface can be forwarded to other interfaces.
-- Disabled: Packets arriving on this IP interface cannot be forwarded to other interfaces.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IgnoreDefaultRoutes<IgnoreDefaultRoutes>

Modifies the ignore default routes property. The acceptable values for this parameter are: 
-- Enabled: Ensures that default routes will not be dynamically added to the routing table.
-- Disabled: Allows default routes to be dynamically added to the routing table. This is the default.


Aliases

none

Required?

false

Position?

named

Default Value

Disabled

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-InterfaceAlias<String[]>

Specifies the IP interface properties by interface, as defined by the InterfaceAlias property.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-InterfaceIndex<UInt32[]>

Specifies the IP interface properties by interface, as defined by the InterfaceIndex number property.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-InterfaceMetric<UInt32>

Modifies the interface metric property. 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 AutomaticMetric is automatically disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ManagedAddressConfiguration<ManagedAddressConfiguration>

Modifies the managed address configuration property. This parameter value determines if an IP interface uses a stateful protocol (such as DHCP) to obtain an address. Setting this parameter will have no effect on an interface that has router discovery enabled and advertising disabled. In that case the parameter is controlled by router discovery. The acceptable values for this parameter are: 
-- Enabled: The IP interface uses a stateful protocol (such as DHCP) to obtain an address.
-- Disabled: The IP interface does not use a stateful protocol (such as DHCP) to obtain an address.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NeighborDiscoverySupported<NeighborDiscoverySupported[]>

Specifies the neighbor discovery supported property of the IP interface. This parameter value specifies if the IP interface supports neighbor discovery. The acceptable values for this parameter are: 
-- Enabled: IP Interface properties for interfaces that have NeighborDiscoverySupported enabled.
-- Disabled: IP Interface properties for interfaces that have NeighborDiscoverySupported disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NeighborUnreachabilityDetection<NeighborUnreachabilityDetection>

Modifies the neighbor unreachablility netection (NUD) property. NUD is how nodes determine that a neighbor is no longer reachable. Default depends on type of interface. This parameter is described in RFC 2461. Note For the ActiveStore, the NUD modification is allowed only from Disabled to Enabled state, but modifying NUD from Enabled to Disabled for ActiveStore fails with Invalid Parameter. For the PersistentStore, the NUD can be modified to either Enabled or Disabled. But the interface will need to be restarted for the setting to take effect.
The acceptable values for this parameter are: 
-- Enabled: NeighborUnreachabilityDetection is enabled.
-- Disabled: NeighborUnreachabilityDetection is disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NlMtuBytes<UInt32>

Modifies the Network Layer MTU (NlMtu) property. This parameter value is the network layer Maximum Transmission Unit, in bytes. 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). Values outside these ranges will not be set. 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 NlMtuBytes.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OtherStatefulConfiguration<OtherStatefulConfiguration>

Modifies the other stateful property. This parameter value determines if an IP interface uses a stateful protocol (such as DHCP) to obtain configuration information other than addresses. Setting this parameter will have no effect on an interface that has router discovery enabled and advertising disabled. In that case the parameter is controlled by router discovery. The acceptable values for this parameter are: 
-- Enabled: The IP interface uses a stateful protocol (such as DHCP) to obtain configuration information other than addresses.
-- Disabled: The IP Interface does not a stateful protocol (such as DHCP) to obtain configuration information other than addresses.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PolicyStore<String>

Specifies the PolicyStore value. The acceptable values for this parameter are: 
-- ActiveStore: The IP address information is currently valid.
-- PersistentStore: The IP address information is persistent across reboots. When the computer starts, the PersistentStore settings are copied to the ActiveStore.
The default value is ActiveStore.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReachableTime<UInt32[]>

Specifies the base reachable time property of the IP interface. This parameter value is the time, in milliseconds, that a node assumes that a neighbor is reachable after having received a reachability confirmation. Used by neighbor unreachability detection.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RetransmitTimeMs<UInt32>

Modifies the retransmit time. This parameter value defines the timeout and retransmission of Neighbor Solicitation messages, in milliseconds. This parameter is described as RetransTimer in RFC 2461. The default value is 1000.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RouterDiscovery<RouterDiscovery>

Modifies the router discovery property. By default, interface properties have router discovery controlled by DHCP for IPv4 and Enabled for IPv6. The acceptable values for this parameter are: 
-- 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WeakHostReceive<WeakHostReceive>

Modifies the weak host receive property. By default, interface properties have this parameter value set to disabled. The acceptable values for this parameter are: 
-- Enabled: A computer can receive IP packets on the IP interface that is not assigned the destination IP address of the packet being received.
-- Disabled: A computer cannot receive IP packets on the IP interface that is not assigned the destination IP address of the packet being received.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WeakHostSend<WeakHostSend>

Modifies the weak host send property. By default, interface properties have this parameter value set to disabled. The acceptable values for this parameter are: 
-- Enabled: A computer can send IP packets on an interface that is not assigned the destination IP address of the packet being sent.
-- Disabled: A computer cannot send IP packets on an interface that is not assigned the destination IP address of the packet being sent.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

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

    The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Examples

EXAMPLE 1

This example gets information IP interface object for the InterfaceIndex 12 and disabled DHCP on it.


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

EXAMPLE 2

This example gets information about IP interface configuration for all of the IP interfaces that have IPv6 addresses configured.


PS C:\> Set-NetIPInterface –AddressFamily IPv6

EXAMPLE 3

This example gets 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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft