< Back
Set-NetAdapterQos
Post
NAME Set-NetAdapterQos
SYNOPSIS
Sets QoS properties on a network adapter.
SYNTAX
Set-NetAdapterQos [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]>] [-Enabled <Boolean>] [-IncludeHidden] [-NoRestart] [-PassThru]
[-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetAdapterQos [-AsJob] [-CimSession <CimSession[]>] [-Enabled <Boolean>] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32>]
-InterfaceDescription <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetAdapterQos [-AsJob] [-CimSession <CimSession[]>] [-Enabled <Boolean>] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32>] -InputObject
<CimInstance[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-NetAdapterQos cmdlet sets the quality of service (QoS) properties on a network adapter, specifically data center bridging (DCB). Currently
this cmdlet only supports enabling or disabling QoS on a network adapter. The Enable-NetAdapterQos and DisableNetAdapterQos cmdlets can also be
used.
PARAMETERS
-AsJob [<SwitchParameter>]
ps_cimcommon_asjob
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Enabled <Boolean>
Indicates whether the QoS settings on the network adapter is enabled. Refer to the Enable-NetAdapterQos and Disable-NetAdapterQos cmdlets for
more details, as setting this parameter to True is equivalent to the Enable-NetAdapterQos cmdlet and setting this parameter to False is
equivalent to the Disable-NetAdapterQos cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IncludeHidden [<SwitchParameter>]
Indicates that the cmdlet includes both visible and hidden network adapters in the operation. 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.
Required? false
Position? named
Default value
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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-InterfaceDescription <String[]>
Specifies an array of network adapter interface descriptions. 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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-Name <String[]>
Specifies an array of network adapter names.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-NoRestart [<SwitchParameter>]
Indicates that the cmdlet does not restart the network adapter after completing the operation. Many advanced properties require restarting the
network adapter before the new settings take effect.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
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.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData[]
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
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData
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 the PassThru
parameter is specified.
Example 1: Enable QoS on the specified network adapter
PS C:\\>Set-NetAdapterQos ????????Name "DCBAdapter2" -Enabled $True
This command enables QoS on the network adapter named DCBAdapter2. The Enable-NetAdapterQos cmdlet is the preferred cmdlet to perform this
operation.
Example 2: Disable QoS on the specified network adapter
PS C:\\>Set-NetAdapterQos ????????Name "DCBAdapter2" -Enabled $False
This command disables QoS on the network adapter named DCBAdapter2. The Disable-NetAdapterQos cmdlet is the preferred cmdlet to perform this
operation.
RELATED LINKS
Online Version:
Disable-NetAdapterQos
Enable-NetAdapterQos
Get-NetAdapter
Get-NetAdapterQos
SYNOPSIS
Sets QoS properties on a network adapter.
SYNTAX
Set-NetAdapterQos [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]>] [-Enabled <Boolean>] [-IncludeHidden] [-NoRestart] [-PassThru]
[-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetAdapterQos [-AsJob] [-CimSession <CimSession[]>] [-Enabled <Boolean>] [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32>]
-InterfaceDescription <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-NetAdapterQos [-AsJob] [-CimSession <CimSession[]>] [-Enabled <Boolean>] [-NoRestart] [-PassThru] [-ThrottleLimit <Int32>] -InputObject
<CimInstance[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-NetAdapterQos cmdlet sets the quality of service (QoS) properties on a network adapter, specifically data center bridging (DCB). Currently
this cmdlet only supports enabling or disabling QoS on a network adapter. The Enable-NetAdapterQos and DisableNetAdapterQos cmdlets can also be
used.
PARAMETERS
-AsJob [<SwitchParameter>]
ps_cimcommon_asjob
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Enabled <Boolean>
Indicates whether the QoS settings on the network adapter is enabled. Refer to the Enable-NetAdapterQos and Disable-NetAdapterQos cmdlets for
more details, as setting this parameter to True is equivalent to the Enable-NetAdapterQos cmdlet and setting this parameter to False is
equivalent to the Disable-NetAdapterQos cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IncludeHidden [<SwitchParameter>]
Indicates that the cmdlet includes both visible and hidden network adapters in the operation. 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.
Required? false
Position? named
Default value
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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-InterfaceDescription <String[]>
Specifies an array of network adapter interface descriptions. 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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-Name <String[]>
Specifies an array of network adapter names.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-NoRestart [<SwitchParameter>]
Indicates that the cmdlet does not restart the network adapter after completing the operation. Many advanced properties require restarting the
network adapter before the new settings take effect.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
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.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData[]
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
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData
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 the PassThru
parameter is specified.
Example 1: Enable QoS on the specified network adapter
PS C:\\>Set-NetAdapterQos ????????Name "DCBAdapter2" -Enabled $True
This command enables QoS on the network adapter named DCBAdapter2. The Enable-NetAdapterQos cmdlet is the preferred cmdlet to perform this
operation.
Example 2: Disable QoS on the specified network adapter
PS C:\\>Set-NetAdapterQos ????????Name "DCBAdapter2" -Enabled $False
This command disables QoS on the network adapter named DCBAdapter2. The Disable-NetAdapterQos cmdlet is the preferred cmdlet to perform this
operation.
RELATED LINKS
Online Version:
Disable-NetAdapterQos
Enable-NetAdapterQos
Get-NetAdapter
Get-NetAdapterQos