Export (0) Print
Expand All

Remove-NetTransportFilter

Applies To: Windows Server 2012

Remove-NetTransportFilter

Deletes a transport filter.

Syntax

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

Parameter Set: InputObject (cdxml)
Remove-NetTransportFilter -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Remove-NetTransportFilter cmdlet deletes 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

-AssociatedTCPSetting<CimInstance>

Removes all of the transport filters that are associated with a specific network TCP setting CIM object. This is typically as input through a pipeline.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

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[]>

Deletes transport filters by destination prefix. This parameter value determines if a transport filter is applied to TCP connections to addresses in that range. This parameter value 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

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-LocalPortEnd<UInt16[]>

Deletes transport filters 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[]>

Deletes transport filters by local TCP port. This parameter value 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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Protocol<Protocol[]>

Specifies 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[]>

Deletes transport filters by remote TCP port. This parameter value 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[]>

Deletes transport filters by remote TCP port. This parameter value 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[]>

Deletes transport filters by setting name. The TCP settings defined in NetTCPSetting are applied to each TCP connection associated with a transport filter. The acceptable values for this parameter are: 
-- Compat: The transport filters that apply compatibility TCP settings.
-- Custom: The transport filters that apply custom TCP settings.
-- Datacenter: The transport filters that apply data center TCP settings.
-- Internet: The transport filters that apply Internet TCP settings.


Aliases

none

Required?

false

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.

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


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Examples

EXAMPLE 1

This example removes all of the transport filters on the server that are associated with the custom NetTcpSetting.


PS C:\> Remove-NetTransportFilter –SettingName Custom

EXAMPLE 2

This example gets all of the NetTcpSettings that have an initial congestion window of 4 MSS and removes their associated transport filters.


PS C:\> Get-NetTCPSetting –InitialCongestionWindowMss 4 | Remove-NetTransportFilter

Related topics

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