Edit

Set-NetQosFlowControl

  • Reference
Module:
DcbQoS

Sets the flow control settings.

Syntax

Set-NetQosFlowControl
   [[-Priority] <Byte[]>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Enabled <Boolean>]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-Confirm]
   [-WhatIf]
Set-NetQosFlowControl
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Enabled <Boolean>]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   -InputObject <CimInstance[]>
   [-Confirm]
   [-WhatIf]

Description

The Set-NetQosFlowControl cmdlet set the enabled state of priority-based flow control (PFC) in Windows Server® 2012 and later. If Windows Server 2012 or later is set to be not willing to accept configurations from a remote device, 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.

Priority-based flow control (PFC) is part of the IEEE data center bridging (DCB) standard.

Examples

EXAMPLE 1

PS C:\> Set-NetQosFlowControl -Priority 5 -Enabled $true

This example enables flow control on traffic tagged with priority 5. This cmdlet is equivalent to the Enable-NetQosFlowControl with priority 5.

EXAMPLE 2

PS C:\> Get-NetQosFlowControl -Priority 5 | Set-NetQosFlowControl -Enabled $false

This example gets the flow control settings for traffic tagged with priority 5 and disables the flow control settings.

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

-Enabled

Sets the enabled state for flow control based on priority values.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

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

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-Priority

Specifies the IEEE 802.1p priority value.

Type:Byte[]
Position:1
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 MSFT_NetQosFlowControlSettingData object contains the flow control setting per priority.

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 MSFT_NetQosFlowControlSettingData object contains flow control settings per priority. Only when the PassThru parameter is specified will this cmdlet return the MSFT_NetQosFlowControlSettingData object.