Microsoft NetTCPIP reference: Gets an IP interface. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Get-NetIPInterface. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / NetTCPIP · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AddressFamily
Specifies an array of IP address families. The cmdlet gets the IP interface that matches the address families. The acceptable values for this parameter are: -- IPv4 -- IPv6
-AdvertiseDefaultRoute
Specifies an array of default router advertisement values for an IP interface. The acceptable values for this parameter are: -- Enabled -- Disabled
-AdvertisedRouterLifetime
Specifies an array of lifetimes, as TimeSpan objects, for default routes. This parameter indicates the lifetime of default routes when advertising routes on the IP interface. The default value is 1800. Valid only for advertising interfaces. To obtain a TimeSpan object, use the New-TimeSpan cmdlet.
-Advertising
Specifies an array of router advertisement values for the IP interface. The acceptable values for this parameter are: -- Enabled -- Disabled The default value is Disabled.
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-AssociatedAdapter
Specifies a network adapter as a CIM object.
-AssociatedIPAddress
Specifies a network IP address as a CIM object. To obtain an IP address object, use the Get-NetIPAddress cmdlet.
-AssociatedNeighbor
Specifies a network neighbor as a CIM object. To obtain a neighbor object, use the Get-NetNeighbor cmdlet.
-AssociatedRoute
Specifies a network route as a CIM object. To obtain a route object, use the Get-NetRoute cmdlet.
-AutomaticMetric
Specifies an array of values for the 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. The acceptable values for this parameter are: -- Enabled -- Disabled
-BaseReachableTimeMs
Specifies an array of base values of random reachable times, in milliseconds. For more information, see RFC 2461. The default value is 30000.
-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.
Prerequisites
Windows with the NetTCPIP module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This is a read-oriented cmdlet; protect any sensitive results and check the documented effects of your selected parameters.
Examples
Example 1: Get IP interface configuration
Get-NetIPInterface
This command gets the IP interface configuration on the computer on which you run the cmdlet. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.
Specifies an array of MSS clamping values for IP interface. This value determines if the IP interface clamps MSS on the forwarded TCP packets that are sent out of the interface. The acceptable values for this parameter are: - Enabled - Disabled
-CompartmentId
Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only gets Net IP interfaces in the default compartment. If you specify a value, the cmdlet gets any matching NetIPInterface in all compartments in this field.
-ConnectionState
Specifies an array of connection states for interfaces that are physically connected to a network.
-CurrentHopLimit
Specifies an array of hop limits. This parameter is the value that the IP interface writes in the hop limit for IPv6, or the Time To Live (TTL) field, for IPv4, in all outbound traffic. When forwarding a packet, routers must decrement the hop limit, or TTL, by 1, and discard the packet when the hop limit reaches 0.
-DadRetransmitTimeMs
Specifies an array of values for the time interval between neighbor solicitation messages.
-DadTransmits
Specifies an array of values for the number of consecutive messages sent while the network driver performs duplicate address detection.
-Dhcp
Specifies the DHCP value for an IP interface. This value is persistent across reboots and only stored in the active policy store. The acceptable values for this parameter are: -- Enabled -- Disabled The default value is Enabled.
-DirectedMacWolPattern
Specifies an array of values for the wake-up packet for an IP interface. This parameter determines if an IP interface is configured to wake up a computer with directed MAC packet patterns. The acceptable values for this parameter are: -- Enabled -- Disabled The default value is Disabled.
-EcnMarking
Specifies an array of values for Explicit Congestion Notification (ECN) marking. 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 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 value 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.
-ForceArpNdWolPattern
Specifies an array of Wake On LAN (WOL) values for the IP interface. This parameter 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 *ForceArpNdWolPattern* set to disabled. The acceptable values for this parameter are: -- Enabled -- Disabled
-Forwarding
Specifies an array of packet forwarding values for the IP interface. This value determines if this IP interface forwards packets that arrive on this interface to other interfaces. The acceptable values for this parameter are: -- Enabled -- Disabled
-IgnoreDefaultRoutes
Specifies an array of values for default route advertisements. If you enable this value, default routes will not be dynamically added to the routing table. The acceptable values for this parameter are: -- Enabled -- Disabled The default value is Disabled.
-IncludeAllCompartments
Indicates that the cmdlet includes all non-default compartments.
-InterfaceAlias
Specifies an array of aliases of network interfaces. The cmdlet gets IP interfaces that match the aliases.
-InterfaceIndex
Specifies an array of indexes of network interfaces. The cmdlet gets IP interfaces that match the indexes.
-InterfaceMetric
Specifies an array of metrics of IP interfaces. 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. The default value is automatic.
-ManagedAddressConfiguration
Specifies an array of values of managed address configurations. This parameter 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 -- Disabled
-NeighborDiscoverySupported
Specifies an array of neighbor discovery values for the IP interface. The acceptable values for this parameter are: -- Enabled -- Disabled
-NeighborUnreachabilityDetection
Specifies an array of values for Neighbor Unreachability Detection (NUD). Use this parameter to determine when a neighbor is no longer reachable. For more information, see RFC 2461. The acceptable values for this parameter are: -- Enabled -- Disabled
-NlMtuBytes
Specifies an array of network layer Maximum Transmission Unit (MTU) values, in bytes, for an IP interface. The IP interface will not transmit packets larger than the maximum value.
-OtherStatefulConfiguration
Specifies an array of values 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 value has 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 -- Disabled
-PolicyStore
Specifies a PolicyStore value. The acceptable values for this parameter are: -- 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.
-ReachableTimeMs
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.
-RetransmitTimeMs
Specifies an array of value for timeout and retransmission, in milliseconds, for Neighbor Solicitation messages. For more information, see RetransTimer in RFC 2461. By default, the value is 1000.
-RouterDiscovery
Specifies the value for router discovery for an IP interface. The acceptable values for this parameter are: -- Enabled -- Disabled -- ControlledByDHCP. IP Interface properties for interfaces that have RouterDiscovery controlled by Dynamic Host Configuration Protocol (DHCP). 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.
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
-WeakHostReceive
Specifies the receive value for a weak host model. By default, an IP 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. The acceptable values for this parameter are: -- Enabled -- Disabled
-WeakHostSend
Specifies the send value for a weak host model. By default, an IP interface 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. The acceptable values for this parameter are: -- Enabled -- Disabled