Export (0) Print
Expand All

Set-NetQosTrafficClass

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-NetQosTrafficClass

Sets the traffic class settings.

Syntax

Parameter Set: ByName
Set-NetQosTrafficClass [[-Name] <String[]> ] [-Algorithm <Algorithm> ] [-AsJob] [-BandwidthPercentage <Byte> ] [-CimSession <CimSession[]> ] [-PassThru] [-Priority <Byte[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-NetQosTrafficClass -InputObject <CimInstance[]> [-Algorithm <Algorithm> ] [-AsJob] [-BandwidthPercentage <Byte> ] [-CimSession <CimSession[]> ] [-PassThru] [-Priority <Byte[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed 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 to 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 will send the updated settings to data center bridging (DCB)-capable network adapters in the computer.

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

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

Parameters

-Algorithm<Algorithm>

Specifies the transmission selection algorithm to assign to the traffic class, such as enhanced transmission selection (ETS).


Aliases

tsa

Required?

false

Position?

named

Default Value

ets

Accept Pipeline Input?

True (ByPropertyName)

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BandwidthPercentage<Byte>

Specifies the percent of total bandwidth to assign to the traffic class.


Aliases

Bandwidth,bw

Required?

false

Position?

named

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

Specified the object which will be modified by this cmdlet. The object must be piped to the cmdlet.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies the name of the traffic class.


Aliases

none

Required?

false

Position?

1

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

-Priority<Byte[]>

Specifies the IEEE 802.1p priority values.


Aliases

p,pri

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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

    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.
    The MSFT_NetQosTrafficClassSettingData object contains a network traffic class.


Outputs

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

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosTrafficClassSettingData

    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.
    The MSFT_NetQosTrafficClassSettingData object contains a network traffic class. Only when the PassThru parameter is specified will the cmdlet return the MSFT_NetQosTrafficClassSettingData object.


Examples

EXAMPLE 1

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


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

EXAMPLE 2

This example gets the settings of the traffic class named SMB and changes the priority mapping setting so that traffic tagged with 3 or 4 are mapped to the traffic class named SMB.


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

Related topics

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