Export (0) Print
Expand All

New-NetTransportFilter

Applies To: Windows Server 2012

New-NetTransportFilter

Creates a transport filters.

Syntax

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




Detailed Description

The New-NetTransportFilter cmdlet creates a transport filter. A transport filter determines how TCP settings from NetTcpSetting are applied to an IP address prefix or a TCP port range.

Parameters

-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

-DestinationPrefix<String>

Creates transport filter by 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 (/).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LocalPortEnd<UInt16>

Creates a transport filter by local TCP port. 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LocalPortStart<UInt16>

Creates a transport filter by local TCP port. The LocalPortEnd determines if a transport filter is applied to TCP connections based on the local port number that sets the lower bound of a range.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Protocol<Protocol>

Represents a read-only setting set to TCP.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemotePortEnd<UInt16>

Creates a transport filter by remote TCP port. 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemotePortStart<UInt16>

Creates a transport filter by remote TCP port. 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SettingName<String>

Associates a transport filter with 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.


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

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

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_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 creates a transport filter for the 192.168.0.0/16 network. The data center TCP settings will apply to all TCP connections that are between the computer and other computers in this network.


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

EXAMPLE 2

This example creates a transport filter for an app that needs conservative TCP settings to ensure compatibility.


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

Related topics

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