Export (0) Print
Expand All

Get-NetTCPConnection

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

Gets TCP connections.

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 current TCP connections. Use this cmdlet to view TCP connection properties such as local or remote IP address, local or remote port, and connection state.

Parameters

-AppliedSetting<AppliedSetting[]>

Specifies an array of values of applied settings. The cmdlet gets connections that match the settings that you specify. The acceptable values for this parameter are: 

-- Internet
-- Datacenter
-- Compat
-- Custom


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

-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[]>

Specifies an array of local IP addresses. The cmdlet gets connections for the addresses that you specify.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-LocalPort<UInt16[]>

Specifies an array of local ports. The cmdlet gets connections for the ports that you specify.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemoteAddress<String[]>

Specifies an array of remote IP addresses. The cmdlet gets connections for the addresses that you specify.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemotePort<UInt16[]>

Specifies an array of remote ports. The cmdlet gets connections for the ports that you specify.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-State<State[]>

Specifies an array of TCP states. The cmdlet gets connections that match the states that you specify. The acceptable values for this parameter are: 

-- Closed
-- CloseWait
-- Closing
-- DeleteTCB
-- Established
-- FinWait1
-- FinWait2
-- LastAck
-- Listen
-- SynReceived
-- SynSent
-- TimeWait


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.

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: Get all connections

This command gets all current TCP connections.


PS C:\> Get-NetTCPConnection

Example 2: Get established connections

This command gets all TCP connections that have an Established state.


PS C:\> Get-NetTCPConnection –State Established

Example 3: Get Internet TCP connections

This command gets all TCP connections that use a TCP applied setting of Internet.


PS C:\> Get-NetTCPConnection –AppliedSetting Internet

Related topics


Get-NetUDPConnection

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft