Set-NetQosFlowControl
Set-NetQosFlowControl
Sets the flow control settings.
Syntax
Parameter Set: ByPriority
Set-NetQosFlowControl [[-Priority] <Byte[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-Enabled <Boolean> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: __cmdletization_InputObject
Set-NetQosFlowControl -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Enabled <Boolean> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-AsJob
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 |
-Enabled<Boolean>
Sets the enabled state for flow control based on priority values.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance[]>
Specified the object which will be modified by this cmdlet. The object must be piped to the cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Priority<Byte[]>
Specifies the IEEE 802.1p priority value.
Aliases |
none |
Required? |
false |
Position? |
1 |
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
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosFlowControlSettingData[]
The
Microsoft.Management.Infrastructure.CimInstanceobject 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
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosFlowControlSettingData
The
Microsoft.Management.Infrastructure.CimInstanceobject 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.
Examples
EXAMPLE 1
This example enables flow control on traffic tagged with priority 5. This cmdlet is equivalent to the Enable-NetQosFlowControl with priority 5.
PS C:\> Set-NetQosFlowControl –Priority 5 -Enabled $true
EXAMPLE 2
This example gets the flow control settings for traffic tagged with priority 5 and disables the flow control settings.
PS C:\> Get-NetQosFlowControl –Priority 5 | Set-NetQosFlowControl -Enabled $false