New-NetTransportFilter

Module:

NetTCPIP Module

Creates a transport filter.

Syntax

Default (Default)

New-NetTransportFilter
    -SettingName <String>
    [-Protocol <Protocol>]
    [-LocalPortStart <UInt16>]
    [-LocalPortEnd <UInt16>]
    [-RemotePortStart <UInt16>]
    [-RemotePortEnd <UInt16>]
    [-DestinationPrefix <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-NetTransportFilter cmdlet creates a transport filter. A transport filter specifies the TCP settings, as a NetTcpSetting object, to apply to an IP address prefix or a TCP port range. Specify the setting to apply by name. You can use the Set-NetTCPSetting cmdlet to modify a setting.

Examples

Example 1: Create a transport filter

PS C:\>New-NetTransportFilter -SettingName Datacenter -DestinationPrefix 192.168.0.0/16

This command creates a transport filter for the 192.168.0.0/16 network. The data center TCP settings applies to all TCP connections between the computer and other computers in this network.

Example 2: Create a transport filter for an app

PS C:\>Get-NetTransportFilter -SettingName Compat -LocalPortStart 5000 -LocalPortEnd 5000 -RemotePortStart 6000 -RemotePortEnd 6000

This command creates a transport filter for a compatibility setting. The command specifies port ranges for both local and remote computers.

Parameters

-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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

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

-DestinationPrefix

Specifies a destination prefix of an IP route. The cmdlet associates the transport filter that to the prefix that you specify. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/).

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

-LocalPortEnd

Specifies the upper bound of a range of local TCP ports. The cmdlet assigns the upper bound that you specify to the transport filter. If you do not specify this parameter, the cmdlet uses the lower range value of 1025.

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

-LocalPortStart

Specifies the lower bound of a range of local TCP ports. The cmdlet assigns the lower bound that you specify to the transport filter. If you do not specify this parameter, the cmdlet uses the lower range value of 65535.

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

-Protocol

Specifies the type of routing protocol. The cmdlet assigns the protocol that you specify to the routing filter. The acceptable values for this parameter are:

• Bbn
• Bgp
• Dhcp
• Dvmrp
• Egp
• Eigrp
• EsIs
• Ggp
• Hello
• Icmp
• Idpr
• Igrp
• IsIs
• Local
• NetMgmt
• Ospf
• Rip
• Rpl
• Other

Parameter properties

Type:	Protocol
Default value:	None
Accepted values:	TCP, UDP
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

-RemotePortEnd

Specifies the upper bound of a range of remote TCP ports. The cmdlet assigns the upper bound that you specify to the transport filter.

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

-RemotePortStart

Specifies the lower bound of a range of remote TCP ports. The cmdlet assigns the lower bound that you specify to the transport filter.

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

-SettingName

Specifies a setting name. The cmdlet associates the setting that you specify to the transport filter. The acceptable values for this parameter are:

• Internet
• Datacenter
• Compat
• Custom

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	True
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

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.

Related Links

• Get-NetTransportFilter
• Remove-NetTransportFilter
• Set-NetTCPSetting