Get-NetIPInterface

Get-NetIPInterface

Gets an IP interface.

Syntaxe

Parameter Set: ByName
Get-NetIPInterface [[-InterfaceAlias] <String[]> ] [-AddressFamily <AddressFamily[]> ] [-AdvertiseDefaultRoute <AdvertiseDefaultRoute[]> ] [-AdvertisedRouterLifetime <TimeSpan[]> ] [-Advertising <Advertising[]> ] [-AutomaticMetric <AutomaticMetric[]> ] [-BaseReachableTimeMs <UInt32[]> ] [-CimSession <CimSession[]> ] [-ClampMss <ClampMss[]> ] [-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>] [ <WorkflowParameters>]

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

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

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

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

Description détaillée

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.

Paramètres

-AddressFamily<AddressFamily[]>

Specifies an array of IP address families. The cmdlet gets the IP interface that matches the address families. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- IPv4
-- IPv6

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-AdvertiseDefaultRoute<AdvertiseDefaultRoute[]>

Specifies an array of default router advertisement values for an IP interface. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-Advertising<Advertising[]>

Specifies an array of router advertisement values for the IP interface. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

The default value is Disabled.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-AssociatedAdapter<CimInstance>

Specifies a network adapter as a CIM object.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

True (ByValue)

Accepter les caractères génériques ?

false

-AssociatedIPAddress<CimInstance>

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

True (ByValue)

Accepter les caractères génériques ?

false

-AssociatedNeighbor<CimInstance>

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

True (ByValue)

Accepter les caractères génériques ?

false

-AssociatedRoute<CimInstance>

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

True (ByValue)

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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.

Alias

BaseReachableTime

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-CimSession<CimSession[]>

Exécute l'applet de commande dans une session distante ou sur un ordinateur distant. Entrez un nom d'ordinateur ou un objet de session, tels que le résultat d'une applet de commande New-CimSession ou Get-CimSession. La valeur par défaut est la session en cours sur l'ordinateur local.

Alias

Session

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-ClampMss<ClampMss[]>

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-ConnectionState<ConnectionState[]>

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-DadRetransmitTimeMs<UInt32[]>

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

Alias

DadRetransmitTime

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-DadTransmits<UInt32[]>

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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.
Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

The default value is Enabled.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

The default value is Disabled.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

The default value is Disabled.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-IncludeAllCompartments

Indicates that the cmdlet includes all non-default compartments.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-InterfaceAlias<String[]>

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

Alias

ifAlias

Requis ?

false

Position ?

1

Valeur par défaut

none

Accepter l'entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

false

-InterfaceIndex<UInt32[]>

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

Alias

ifIndex

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

True (ByPropertyName)

Accepter les caractères génériques ?

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.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-NeighborDiscoverySupported<NeighborDiscoverySupported[]>

Specifies an array of neighbor discovery values for the IP interface. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-PolicyStore<String>

Specifies a PolicyStore value. Les valeurs acceptables pour ce paramètre sont les suivantes : 

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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.

Alias

ReachableTime

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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.

Alias

RetransmitTime

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-RouterDiscovery<RouterDiscovery[]>

Specifies the value for router discovery for an IP interface. Les valeurs acceptables pour ce paramètre sont les suivantes : 

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-ThrottleLimit<Int32>

Spécifie le nombre maximal d'opérations simultanées qui peuvent être établies pour exécuter l'applet de commande. Si ce paramètre est omis ou si la valeur 0 est entrée, Windows PowerShell® calcule un seuil de limitation optimal pour l'applet de commande en fonction du nombre d'applets de commande CIM exécutées sur l'ordinateur. Le seuil de limitation s'applique uniquement à l'applet de commande en cours, non pas à la session ou à l'ordinateur.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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. Les valeurs acceptables pour ce paramètre sont les suivantes : 

-- Enabled
-- Disabled

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez  . about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

<WorkflowParameters>

Entrées

Le type d'entrée correspond au type des objets que vous pouvez adresser à l'applet de commande.

  • None

Sorties

Le type de sortie correspond au type des objets que l'applet de commande émet.

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

    L'objet Microsoft.Management.Infrastructure.CimInstance est une classe de wrapper qui affiche les objets WMI (Windows Management Instrumentation). Le chemin après le symbole # fournit l'espace de noms et le nom de classe de l'objet WMI sous-jacent.

Exemples

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 }

Rubriques connexes

Format-List

Format-Table

Get-NetRoute

Set-NetIPInterface

Sort-Object

Where-Object