Edit

Share via

Set-NetQosTrafficClass

  • Reference
Module:
DcbQoS

Sets the traffic class settings.

Syntax

Set-NetQosTrafficClass
   [[-Name] <String[]>]
   [[-InterfaceAlias] <String>]
   [-Algorithm <Algorithm>]
   [-BandwidthPercentage <Byte>]
   [-Priority <Byte[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetQosTrafficClass
   [[-Name] <String[]>]
   [[-InterfaceIndex] <UInt32>]
   [-Algorithm <Algorithm>]
   [-BandwidthPercentage <Byte>]
   [-Priority <Byte[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetQosTrafficClass
   -InputObject <CimInstance[]>
   [-Algorithm <Algorithm>]
   [-BandwidthPercentage <Byte>]
   [-Priority <Byte[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-NetQosTrafficClass cmdlet modifies the settings of a traffic class, such as the mapping between 802.1p priority and traffic class, the transmission algorithm that must be used, and the bandwidth allocation to the traffic class. If Windows Server® 2012 or later is set to be not willing to accept configurations from a remote device, then Windows Server 2012 or later sends the updated settings to data center bridging (DCB)-capable network adapters in the computer.

For more information about remote device configurations, see the Set-NetQosDcbxSetting cmdlet.

For more information about traffic class, see the New-NetQosTrafficClass cmdlet.

Examples

Example 1: Change the bandwidth allocation for a traffic class

PS C:\> Set-NetQosTrafficClass -Name "SMB" -BandwidthPercentage 50

This command changes the bandwidth allocation to traffic class named SMB to 50 percent.

Example 2: Change the priority mapping for a traffic class

PS C:\> Get-NetQosTrafficClass -Name "SMB" | Set-NetQosTrafficClass -Priority 3,4

This command gets the settings of the traffic class named SMB by using the Get-NetQosTrafficClass cmdlet. The command passes them to the current cmdlet by using the pipeline operator. That cmdlet changes the priority mapping setting so that traffic tagged with 3 or 4 are mapped to the traffic class named SMB.

Parameters

-Algorithm

Type:Algorithm
Aliases:tsa
Accepted values:Strict, ETS
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

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

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

-BandwidthPercentage

Type:Byte
Aliases:Bandwidth, bw
Position:Named
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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-InputObject

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

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InterfaceAlias

Type:String
Aliases:IfAlias
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InterfaceIndex

Type:UInt32
Aliases:IfIndex
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

-Priority

Type:Byte[]
Aliases:p, pri
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

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

-WhatIf

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

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

Inputs

String

UInt32

CimInstance[]

Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetQosTrafficClass.Algorithm

Byte

Byte[]

Outputs

CimInstance

CimInstance

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. This cmdlet returns a MSFT_NetQosTrafficClassSettingData object contains a network traffic class. Only if you specify the PassThru parameter does the cmdlet return the MSFT_NetQosTrafficClassSettingData object.