Get-NetIPAddress
Get-NetIPAddress
Gets information about IP address configuration.
Syntax
Parameter Set: Query (cdxml)
Get-NetIPAddress [[-IPAddress] <String[]> ] [-AddressFamily <AddressFamily[]> ] [-AddressState <AddressState[]> ] [-AsJob] [-AssociatedIPInterface <CimInstance> ] [-CimSession <CimSession[]> ] [-InterfaceAlias <String[]> ] [-InterfaceIndex <UInt32[]> ] [-PolicyStore <String> ] [-PreferredLifetime <TimeSpan[]> ] [-PrefixLength <Byte[]> ] [-PrefixOrigin <PrefixOrigin[]> ] [-SkipAsSource <Boolean[]> ] [-SuffixOrigin <SuffixOrigin[]> ] [-ThrottleLimit <Int32> ] [-Type <Type[]> ] [-ValidLifetime <TimeSpan[]> ] [ <CommonParameters>]
Detailed Description
The Get-NetIPAddress cmdlet gets the IP address information such as IPv4 addresses, IPv6 addresses and the IP interfaces with which addresses are associated.
This cmdlet also gets the PrefixLength, also known as a subnet mask. For more information on subnetting, see Subnetting on TechNet (https://technet.microsoft.com/library/bb726997.aspx) on TechNet.
This cmdlet does not get the gateway as that is a routing concept covered by the Get-NetRoute cmdlet. For IP endpoints, the gateway specifies the forwarding address or the next hop IP address over which the set of addresses defined by the network destination and subnet mask are reachable.
Without parameters, this cmdlet gets all of the IP address configuration information on the computer.
Parameters
-AddressFamily<AddressFamily[]>
Gets IP address information only about a specific IP address family. The acceptable values for this parameter are:
-- IPv4: IPv4 address information.
-- IPv6: IPv6 address information.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AddressState<AddressState[]>
Gets information about the duplicate address detection (DAD) state for an IPv4 and IPv6 address. This parameter can be used to filter this cmdlet output based on addresses that are valid and available for use. The acceptable values for this parameter are:
-- Invalid: IP address configuration information for addresses that are not valid and will not be used.
-- Tentative: IP address configuration information for addresses that are not used for communication, as the uniqueness of those IP addresses is being verified.
-- Duplicate: IP address configuration information for addresses for which a duplicate IP address has been detected and the current IP address will not be used.
-- Deprecated: IP address configuration information for addresses that will no longer be used to establish new connections, but will continue to be used with existing connections.
-- Preferred: IP address configuration information for addresses that are valid and available for use.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AssociatedIPInterface<CimInstance>
Gets IP address information only about a specific network IP interface CIM object. This is typically as input through the pipeline.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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 |
-InterfaceAlias<String[]>
Gets IP address information only about a specific interface, as defined by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InterfaceIndex<UInt32[]>
Gets IP address information only about a specific interface, as defined by this cmdlet number.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IPAddress<String[]>
Gets the information about a specific IPv4 or IPv6 address.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
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 |
-PreferredLifetime<TimeSpan[]>
Gets IP address information by a specific preferred lifetime. This parameter 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 |
-PrefixLength<Byte[]>
Gets the IP address information for IP addresses that have a specific prefix length. This parameter defines the local subnet size, and is also known as a subnet mask.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PrefixOrigin<PrefixOrigin[]>
Gets the IP address information for IP addresses that have a specific prefix origin. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual: The IP address prefix was manually specified.
-- WellKnown: The IP address prefix is from a well-known source.
-- DHCP: The IP address prefix was provided by DHCP settings.
-- RouterAdvertisement: The IP address prefix was obtained through a router advertisement (RA).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SkipAsSource<Boolean[]>
Gets the IP address information for IP addresses that have the SkipAsSource flag set to True or False. This parameter is used in a multiple IP address scenario in which the only the primary IP address for outgoing traffic. The IP addresses that have this parameter set to True are not used for outgoing traffic and are not registered in DNS.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SuffixOrigin<SuffixOrigin[]>
Gets the IP address information for IP addresses that have a specific suffix origin. IP addresses are divided into two parts, the prefix and the suffix. The address prefix identifies the network portion of an IP address, and the address suffix identifies the host portion. The acceptable values for this parameter are:
-- Manual: The IP address prefix was manually specified.
-- WellKnown: The IP address suffix is from a well-known source.
-- DHCP: The IP address suffix was provided by DHCP settings.
-- Link: The IP address suffix was obtained from the link-layer address.
-- Random: The IP address suffix was obtained from a random source.
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 |
-Type<Type[]>
Specifies a specific IP address type. The acceptable values for this parameter are:
-- Unicast: Marks the address as a unicast address.
-- Anycast: Marks the address as an anycast address.
The default value is Unicast.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ValidLifetime<TimeSpan[]>
Gets IP address information by a specific valid lifetime. This parameter 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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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_NetIPAddress
The
Microsoft.Management.Infrastructure.CimInstanceobject 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
This example gets information about IP address configuration for all IPv6 addresses on the computer.
PS C:\> Get-NetIPAddress –AddressFamily IPv6
EXAMPLE 2
This example gets information about IP address configuration, and it displays some of that information in a table. The table format provides a convenient overview for computers with many IP addresses.
PS C:\> Get-NetIPAddress | Format-Table
EXAMPLE 3
This example gets information about IP address configuration for a specific interface index.
PS C:\> Get-NetIPAddress –InterfaceIndex 12
EXAMPLE 4
This example 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. This display can help you find IP address information by interface index.
PS C:\> Get-NetIPAddress | Sort-Object -Property InterfaceIndex | Format-Table
EXAMPLE 5
This example gets information about IP address configuration for IP addresses that have a ValidLifetime of less than one day.
PS C:\> Get-NetIPAddress | Where-Object -FilterScript { $_.ValidLifetime -Lt ([TimeSpan]::FromDays(1)) }
Similarly, this cmdlet can be used to get information about IP address configuration for IP addresses that have an Infinite ValidLifetime.
PS C:\> Get-NetIPAddress | Where-Object -FilterScript { $_.ValidLifetime -Eq ([TimeSpan]::MaxValue) }