Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Enable-NetAdapterQos

Enable-NetAdapterQos

msft_netadapterqos.cdxml

Synopsis

Enables quality of service (QoS) on the network adapter, specifically data center bridging (DCB).

Syntax

Enable-NetAdapterQos [-Name] [-AsJob] [-CimSession] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Enable-NetAdapterQos [-AsJob] [-CimSession] [-NoRestart] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Enable-NetAdapterQos [-AsJob] [-CimSession] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit] [-InterfaceDescription] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Enable-NetAdapterQos cmdlet enables quality of service (QoS) on a network adapter. The QoS features, which include traffic class bandwidth allocation and priority based flow control, are specified in the IEEE data center bridging (DCB) standard. When QoS is enabled and the computer is configured not to accept configurations from a remote device, the computer will send to the network adapter the user-generated configurations for the QoS features. For more information about the configuring the computer not to accept configurations from a remote device, see the Set-NetQosDcbxSetting cmdlet. Otherwise, the network adapter will enable the QoS features based on either the factory default configurations or what it receives from the remote device.

To configure traffic class bandwidth allocation and priority based flow control on the computer, users can run the New-NetQosTrafficClass and the Enable-NetQosFlowControl cmdlets.

Some switches expect end stations, such as computers running Windows Server® 2012 or later, to accept configurations from the switches. If the switches detect a mismatched configuration via the data center bridging exchange (DCBX) protocol, then the switches disable the DCB functionalities. To overcome this limitation, users can disable DCBX on either the switches or the network adapters and manually configure the features on either end.

Parameters

-AsJob <SwitchParameter>

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

-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

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IncludeHidden <SwitchParameter>

Specifies both visible and hidden network adapters should be included. By default only visible network adapters are included. If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters.

Aliases

None

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

-InterfaceDescription <String[]>

Specifies the network adapter interface description. For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as Contoso 12345 Gigabit Network Device.

Aliases

ifDesc

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-Name <String[]>

Specifies the name of the network adapter.

Aliases

ifAlias, InterfaceA;ias

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-NoRestart <SwitchParameter>

Specifies that the network adapter is not restarted as part of running this cmdlet. Note: Many advanced properties require restarting the network adapter before the new settings take effect.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData[]

Return Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData

Notes

None

Examples

EXAMPLE 1

This example enables QoS on a network adapter named DCBNIC1 and restarts the network adapter.

PS C:\>Enable-NetAdapterQos –Name "DCBNIC1"

EXAMPLE 2

This example gets all network adapters that support QoS, enables QoS on all of them, and restarts the network adapter.
PS C:\> $netadapter1 = Get-NetAdapterQos –Name *
PS C:\> Enable-NetAdapterQos –InputObject $netadapter1

This is a version of the cmdlet that gets all network adapters that support QoS and enables QoS on all of them via the pipeline, then restarts the network adapter.
PS C:\> Get-NetAdapterQos –Name * | Enable-NetAdapterQos

Online Version
Disable-NetAdapterQos
Get-NetAdapter
Get-NetAdapterQos
Enable-NetQosFlowControl
New-NetQosTrafficClass
Set-NetQosDcbxSetting