Get-SmbBandwidthLimit
Gets the list of SMB bandwidth caps for each traffic category.
Syntax
Default (Default)
Get-SmbBandwidthLimit
[[-Category] <BandwidthLimitCategory[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Get-SmbBandwidthLimit cmdlet gets the list of Server Message Block (SMB) bandwidth caps for each traffic category. SMB bandwidth caps limit the amount of data that the server can send for each traffic category.
Examples
Example 1: Get SMB bandwidth caps for all categories
PS C:\> Get-SmbBandwidthLimit
This command gets the SMB bandwidth caps for all traffic categories.
Example 2: Get SMB bandwidth caps for a category
PS C:\> Get-SmbBandWidthLimit -Category LiveMigration
This command gets the SMB bandwidth cap for Live Migration traffic.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Category
Specifies an array of categories of SMB bandwidth limits to get. The acceptable values for this parameter are:
- Default
- VirtualMachine
- LiveMigration
Parameter properties
| Type: | BandwidthLimitCategory[] |
| Default value: | None |
| Accepted values: | Default, VirtualMachine, LiveMigration, StorageReplication |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Notes
- Before you can use this cmdlet, you must enable the feature by using the following command:
Install-WindowsFeature -Name FS-SMBBWFor 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.