Remove-SmbBandwidthLimit
Remove-SmbBandwidthLimit
Removes SMB bandwidth caps.
Syntax
Parameter Set: Query (cdxml)
Remove-SmbBandwidthLimit [[-Category] <BandwidthLimitCategory[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Remove-SmbBandwidthLimit -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Remove-SmbBandwidthLimit cmdlet removes Server Message Block (SMB) bandwidth caps for the traffic categories that you specify. SMB bandwidth caps limit the amount of data that the server can send for each traffic category.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Category<BandwidthLimitCategory[]>
Specifies an array of categories of the SMB bandwidth limits to remove. The acceptable values for this parameter are:
-- Default
-- VirtualMachine
-- LiveMigration
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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 |
Session |
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 |
-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 |
-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 |
<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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Notes
- Before you can use this cmdlet, you must enable the feature by using the following command:
Add-WindowsFeature -Name FS-SMBBW
For more information, typeGet-Help Install-WindowsFeature. When you enable the feature, the SMB server creates a new SMB performance counter set that has an instance per category. The performance counters in this set use the same counters as the SMB Client Shares performance counters.
Examples
Example 1: Remove SMB bandwidth caps for all categories
This command removes defined limits for SMB traffic for all categories.
PS C:\> Remove-SmbBandwidthLimit
Example 2: Remove SMB bandwidth caps for a category
This command removes the limit for SMB traffic for Live Migration category.
PS C:\> Remove-SmbBandwidthLimit -Category LiveMigration