Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Get-NetIPInterface

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-NetIPInterface

Gets an IP interface.

Syntax

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

Parameter Set: ByAdapter
Get-NetIPInterface [-AsJob] [-AssociatedAdapter <CimInstance> ] [-CimSession <CimSession[]> ] [-IncludeAllCompartments] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByIPAddress
Get-NetIPInterface [-AsJob] [-AssociatedIPAddress <CimInstance> ] [-CimSession <CimSession[]> ] [-IncludeAllCompartments] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByNeighbor
Get-NetIPInterface [-AsJob] [-AssociatedNeighbor <CimInstance> ] [-CimSession <CimSession[]> ] [-IncludeAllCompartments] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByRoute
Get-NetIPInterface [-AsJob] [-AssociatedRoute <CimInstance> ] [-CimSession <CimSession[]> ] [-IncludeAllCompartments] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-NetIPInterface cmdlet gets an IP interface, including IPv4 and IPv6 addresses, and the associated address configuration for the IP interfaces. Without parameters, this cmdlet gets all of the IP interface properties on the computer, including virtual interfaces and loopback interfaces.

Parameters

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AdvertiseDefaultRoute<AdvertiseDefaultRoute[]>

Specifies an array of default router advertisement values for an IP interface. The acceptable values for this parameter are: 

-- Enabled
-- Disabled


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AdvertisedRouterLifetime<TimeSpan[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


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

-AssociatedAdapter<CimInstance>

Specifies a network adapter as a CIM object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-AssociatedIPAddress<CimInstance>

Specifies a network IP address as a CIM object. To obtain an IP address object, use the Get-NetIPAddress cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-AssociatedNeighbor<CimInstance>

Specifies a network neighbor as a CIM object. To obtain a neighbor object, use the Get-NetNeighbor cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-AssociatedRoute<CimInstance>

Specifies a network route as a CIM object. To obtain a route object, use the Get-NetRoute cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BaseReachableTimeMs<UInt32[]>

Specifies an array of base values of random reachable times, in milliseconds. For more information, see RFC 2461. The default value is 30.


Aliases

BaseReachableTime

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

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CompartmentId<UInt32[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ConnectionState<ConnectionState[]>

Specifies an array of connection states for interfaces that are physically connected to a network.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CurrentHopLimit<UInt32[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DadRetransmitTimeMs<UInt32[]>

Specifies an array of values for the time interval between neighbor solicitation messages.


Aliases

DadRetransmitTime

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DadTransmits<UInt32[]>

Specifies an array of values for the number of consecutive messages sent while the network driver performs duplicate address detection.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

Disabled

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IncludeAllCompartments

Indicates that the cmdlet includes all non-default compartments.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InterfaceAlias<String[]>

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


Aliases

ifAlias

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InterfaceIndex<UInt32[]>

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


Aliases

ifIndex

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InterfaceMetric<UInt32[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NeighborDiscoverySupported<NeighborDiscoverySupported[]>

Specifies an array of neighbor discovery values for the IP interface. The acceptable values for this parameter are: 

-- Enabled
-- Disabled


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NlMtuBytes<UInt32[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PolicyStore<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

ReachableTime

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RetransmitTimeMs<UInt32[]>

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.


Aliases

RetransmitTime

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

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.

  • None

Outputs

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

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


Examples

Example 1: Get IP interface configuration

This command gets the IP interface configuration on the computer on which you run the cmdlet.


 

PS C:\> Get-NetIPInterface

Example 2: Get IP interface information for IPv6 addresses

This command gets information about the IP interface configuration for all IP interfaces for which you have configured IPv6 addresses.


PS C:\> Get-NetIPInterface –AddressFamily IPv6

Example 3: Get IP interface information and format the output

This command gets information about IP interface configuration, and displays that information in a table.


PS C:\> Get-NetIPInterface | Format-Table

Example 4: Get IP interface information by interface index

This command gets information about the IP interface configuration for a specific interface index.


PS C:\> Get-NetIPInterface –InterfaceIndex 12

Example 5: Get and sort IP interface information

This command gets information about IP address configuration, sorts them numerically by the interface index in the cmdlet name, and then displays them in a table format.


PS C:\> Get-NetIPInterface | Sort-Object –Property InterfaceIndex | Format-Table

Example 6: Get the IP interface by specifying the router lifetime

This command gets information about IP address configuration for all IP interfaces that have a default AdvertisedRouterLifetime.


PS C:\> Get-NetIPInterface | Where-Object -FilterScript { $_.AdvertisedRouterLifetime.TotalSeconds -Eq 1800 }

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.