Edit

Disable-NetAdapterQos

  • Reference
Module:
NetAdapter

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

Syntax

Disable-NetAdapterQos
       [-Name] <String[]>
       [-AsJob]
       [-CimSession <CimSession[]>]
       [-IncludeHidden]
       [-NoRestart]
       [-PassThru]
       [-ThrottleLimit <Int32>]
       [-Confirm]
       [-WhatIf]
Disable-NetAdapterQos
       [-AsJob]
       [-CimSession <CimSession[]>]
       [-NoRestart]
       [-PassThru]
       [-ThrottleLimit <Int32>]
       -InputObject <CimInstance[]>
       [-Confirm]
       [-WhatIf]
Disable-NetAdapterQos
       [-AsJob]
       [-CimSession <CimSession[]>]
       [-IncludeHidden]
       [-NoRestart]
       [-PassThru]
       [-ThrottleLimit <Int32>]
       -InterfaceDescription <String[]>
       [-Confirm]
       [-WhatIf]

Description

The Disable-NetAdapterQos cmdlet disables quality of service (QoS) on a network adapter. The QoS features, which include bandwidth allocation and priority based flow control, are specified in the IEEE data center bridging (DCB) standard. When QoS is disabled, the computer will not send to the network adapter any configuration for the QoS features. This cmdlet does not stop the network adapter from setting up configurations and utilizing the hardware QoS capabilities.

A network adapter that supports DCB is typically known as a converged network adapter. It supports both storage and networking functionalities. In some use cases the DCB must be enabled to support the storage functionalities. If DCB on a network adapter is disabled from the point of view of a computer, then it may still be functioning on the network adapter.

Examples

EXAMPLE 1

PS C:\>Disable-NetAdapterQos -Name *

This example disables QoS on all network adapters and restarts the network adapters.

EXAMPLE 2

PS C:\>Disable-NetAdapterQos -Name "Ethernet 2"


This is the cmdlet using wildcard characters.
PS C:\>Disable-NetAdapterQos -Name E*2

This example disables QoS on a network adapter named Ethernet 2 and restarts the network adapter.

EXAMPLE 3

PS C:\>$netAdapterQoS1 = Get-NetAdapterQos -Name *



PS C:\>Disable-NetAdapterQos -InputObject $netAdapterQoS1


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

This example gets all of the network adapters that support QoS and disables QoS on all of them and restarts the QoS network adapters.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
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
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeHidden

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.

Type:SwitchParameter
Position:Named
Default value:None
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

-InterfaceDescription

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.

Type:String[]
Aliases:ifDesc
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-Name

Specifies the name of the network adapter.

Type:String[]
Aliases:ifAlias, InterfaceAlias
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-NoRestart

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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.

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

-WhatIf

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

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

Inputs

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.

The input object is a list of network adapter objects, such as output from the Get-NetAdapter cmdlet.

Outputs

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.

The output object contains QoS capabilities and configurations on a network adapter. The output object is returned only when PassThru parameter is specified.