Remove-SmbBandwidthLimit

  • Reference
Module:
SmbShare

Removes SMB bandwidth caps.

Syntax

Remove-SmbBandwidthLimit
      [[-Category] <BandwidthLimitCategory[]>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-PassThru]
      [<CommonParameters>]
Remove-SmbBandwidthLimit
      -InputObject <CimInstance[]>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-PassThru]
      [<CommonParameters>]

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.

Examples

Example 1: Remove SMB bandwidth caps for all categories

PS C:\> Remove-SmbBandwidthLimit

This command removes defined limits for SMB traffic for all categories.

Example 2: Remove SMB bandwidth caps for a category

PS C:\> Remove-SmbBandwidthLimit -Category LiveMigration
Install-WindowsFeature

This command removes the limit for SMB traffic for Live Migration category.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Category

Specifies an array of categories of the SMB bandwidth limits to remove. The acceptable values for this parameter are:

  • Default
  • VirtualMachine
  • LiveMigration
Type:BandwidthLimitCategory[]
Accepted values:Default, VirtualMachine, LiveMigration, StorageReplication
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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, type Get-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.