Get-NetTCPConnection

Get-NetTCPConnection

Gets information about current TCP connection statistics.

Syntax

Parameter Set: ByName
Get-NetTCPConnection [[-LocalAddress] <String[]> ] [[-LocalPort] <UInt16[]> ] [-AppliedSetting <AppliedSetting[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-RemoteAddress <String[]> ] [-RemotePort <UInt16[]> ] [-State <State[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-NetTCPConnection cmdlet gets information about current TCP connection statistics. This includes TCP connection properties such as local or remote IP address, local or remote port and connection state. Used without parameters, this cmdlet gets information about all TCP connections.

Parameters

-AppliedSetting<AppliedSetting[]>

Gets TCP connection information only about a specific AppliedSetting. The TCP settings defined in NetTCPSetting are applied to each TCP connection associated with a transport filter. The acceptable values for this parameter are:
-- Internet: The TCP connections that use Internet TCP settings.
-- Datacenter: The TCP connections that use data center TCP settings.
-- Compat: The TCP connections that use compatibility TCP settings.
-- Custom: The TCP connections that use custom TCP settings.

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

-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

-LocalAddress<String[]>

Gets TCP connection information only about connections from a specific local IP address.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-LocalPort<UInt16[]>

Gets TCP connection information only about connections from a specific local TCP port.

Aliases	none
Required?	false
Position?	2
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RemoteAddress<String[]>

Gets TCP connection information only about connections from a specific remote IP address.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RemotePort<UInt16[]>

Gets TCP connection information only about connections from a specific remote TCP port.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-State<State[]>

Gets TCP connection information only about connections in a specific TCP state. Transmission Control Protocol (TCP) and the TCP state machine are described in RFC 793.

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

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

  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

This example gets information about current TCP connection statistics. Used without parameters, this cmdlet gets information about all TCP connections.

PS C:\> Get-NetTCPConnection

EXAMPLE 2

This example gets information about all established TCP connections.

PS C:\> Get-NetTCPConnection –State Established

EXAMPLE 3

This example gets information about all TCP connections that use the Internet TCP settings.

PS C:\> Get-NetTCPConnection –AppliedSetting Internet

Related topics

Get-NetUDPConnection