Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-NetTransportFilter

New-NetTransportFilter

msft_nettransportfilter.cdxml

Synopsis

Creates a transport filter.

Syntax

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

Detailed 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 to modify a setting.

Parameters

-AsJob <SwitchParameter>

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

-DestinationPrefix <String>

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 (/).

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-LocalPortEnd <UInt16>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-LocalPortStart <UInt16>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RemotePortEnd <UInt16>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RemotePortStart <UInt16>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SettingName <String>

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

Aliases

None

Required?

true

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

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetTransportFilter

Notes

None

Examples

Example 1: Create a transport filter

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.

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

Example 2: Create a transport filter for an app

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

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

Online Version
Get-NetTransportFilter
Remove-NetTransportFilter
Set-NetTCPSetting