Edit

Share via


Get-NetTCPConnection

Gets TCP connections.

Syntax

Default (Default)

Get-NetTCPConnection
    [[-LocalAddress] <String[]>]
    [[-LocalPort] <UInt16[]>]
    [-RemoteAddress <String[]>]
    [-RemotePort <UInt16[]>]
    [-State <State[]>]
    [-AppliedSetting <AppliedSetting[]>]
    [-OwningProcess <UInt32[]>]
    [-CreationTime <DateTime[]>]
    [-OffloadState <OffloadState[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

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.

Examples

Example 1: Get all connections

PS C:\>Get-NetTCPConnection

This command gets all current TCP connections.

Example 2: Get established connections

PS C:\>Get-NetTCPConnection -State Established

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

Example 3: Get Internet TCP connections

PS C:\>Get-NetTCPConnection -AppliedSetting Internet

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

Example 4: Get Owning Process

PS C:\>Get-NetTcpConnection -OwningProcess 18948

This command gets all Owning Process with PID 18948

Parameters

-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

Parameter properties

Type:

AppliedSetting[]

Default value:None
Accepted values:Internet, Datacenter, Compat, DatacenterCustom, InternetCustom
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreationTime

Specifies an array of DateTime objects. To get a DateTime object, use the Get-Date cmdlet.

Parameter properties

Type:

DateTime[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocalAddress

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:IPAddress

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-LocalPort

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

Parameter properties

Type:

UInt16[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OffloadState

Specifies the offload state of a TCP connection.

Parameter properties

Type:

OffloadState[]

Default value:None
Accepted values:InHost, Offloading, Offloaded, Uploading
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OwningProcess

Specifies the PID of the owning process of a TCP connection.

Parameter properties

Type:

UInt32[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoteAddress

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemotePort

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

Parameter properties

Type:

UInt16[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

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

Parameter properties

Type:

State[]

Default value:None
Accepted values:Closed, Listen, SynSent, SynReceived, Established, FinWait1, FinWait2, CloseWait, Closing, LastAck, TimeWait, DeleteTCB, Bound
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ThrottleLimit

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

CimInstance

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.