external help file | Module Name | ms.date | online version | schema | title |
---|---|---|---|---|---|
MSFT_NetAdapterQos.cdxml-help.xml |
NetAdapter |
10/29/2017 |
2.0.0 |
Set-NetAdapterQos |
Sets the quality of service (QoS) properties of the network adapter, specifically data center bridging (DCB).
Set-NetAdapterQos [-Name] <String[]> [-IncludeHidden] [-Enabled <Boolean>] [-NoRestart]
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-NetAdapterQos -InterfaceDescription <String[]> [-IncludeHidden] [-Enabled <Boolean>] [-NoRestart]
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-NetAdapterQos -InputObject <CimInstance[]> [-Enabled <Boolean>] [-NoRestart] [-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
The Set-NetAdapterQos cmdlet sets the quality of service (QoS) properties on a network adapter. Currently this cmdlet only supports enabling or disabling QoS on a network adapter. The Enable-NetAdapterQos and DisableNetAdapterQos cmdlets can also be used.
PS C:\>Set-NetAdapterQos -Name DCBAdapter2 -Enabled $true
This example enables QoS on the network adapter named DCBAdapter2. Note: The Enable-NetAdapterQos cmdlet is the preferred cmdlet to perform this operation.
PS C:\>Set-NetAdapterQos -Name DCBAdapter2 -Enabled $false
This example disables QoS on the network adapter named DCBAdapter2. Note:The Disable-NetAdapterQos cmdlet is the preferred cmdlet to perform this operation.
ps_cimcommon_asjob
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies the enabled state of the QoS settings on the network adapter, specifically DCB. 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.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: ByName, ByInstanceID
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Type: CimInstance[]
Parameter Sets: InputObject (cdxml)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
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[]
Parameter Sets: ByInstanceID
Aliases: ifDesc, InstanceID
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Specifies the name of the network adapter.
Type: String[]
Parameter Sets: ByName
Aliases: ifAlias, InterfaceAlias
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
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.