Get-NetTransportFilter

Get-NetTransportFilter

Gets information about transport filters.

Syntax

Parameter Set: ByName
Get-NetTransportFilter [-AsJob] [-AssociatedTCPSetting <CimInstance> ] [-CimSession <CimSession[]> ] [-DestinationPrefix <String[]> ] [-LocalPortEnd <UInt16[]> ] [-LocalPortStart <UInt16[]> ] [-Protocol <Protocol[]> ] [-RemotePortEnd <UInt16[]> ] [-RemotePortStart <UInt16[]> ] [-SettingName <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-NetTransportFilter cmdlet gets information about transport filters. A transport filter determines how TCP settings from NetTcpSetting are applied to an IP address prefix or a TCP port range.

Without parameters, this cmdlet returns all transport filters on the computer.

Parameters

-AsJob

-AssociatedTCPSetting<CimInstance>

Gets transport filter information that applies to a specific network TCP setting CIM object. This is typically as input through the pipeline.

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

-DestinationPrefix<String[]>

Gets transport filter information only about a specific DestinationPrefix. The DestinationPrefix determines if a transport filter is applied to TCP connections to addresses in that range. The DestinationPrefix includes a destination network identifier and a prefix length, separated by a slash (/).

-LocalPortEnd<UInt16[]>

Gets transport filter information only about a specific LocalPortEnd. The LocalPortEnd determines if a transport filter is applied to TCP connections based on the local port number that sets the upper bound of a range.

-LocalPortStart<UInt16[]>

Gets transport filter information only about a specific LocalPortStart. The LocalPortStart determines if a transport filter is applied to TCP connections based on the local port number that sets the lower bound of a range.

-Protocol<Protocol[]>

Gets transport filter based on protocol. Protocol is a read-only setting set to TCP.

-RemotePortEnd<UInt16[]>

Gets transport filter information only about a specific RemotePortEnd. The RemotePortEnd determines if a transport filter is applied to TCP connections based on the remote port number that sets the upper bound of a range.

-RemotePortStart<UInt16[]>

Gets transport filter information only about a specific RemotePortStart. The RemotePortStart determines if a transport filter is applied to TCP connections based on the remote port number that sets the lower bound of a range.

-SettingName<String[]>

Gets transport filter information only about a specific SettingName. 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 transport filters that apply Internet TCP settings.
-- Datacenter: The transport filters that apply data center TCP settings.
-- Compat: The transport filters that apply compatibility TCP settings.
-- Custom: The transport filters that apply custom TCP settings.

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

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

  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 transport filters. Without parameters, this cmdlet returns all transport filters on the computer.

PS C:\> Get-NetTransportFilter

EXAMPLE 2

This example gets information about the transport filters that apply Internet settings.

PS C:\> Get-NetTransportFilter –SettingName Internet

Related topics

Get-NetUDPSetting

New-NetTransportFilter

Remove-NetTransportFilter

Set-NetTCPSetting

Set-NetUDPSetting