Edit

Share via


Set-NetQosFlowControl

Sets the flow control settings.

Syntax

ByIfAlias (Default)

Set-NetQosFlowControl
    [[-Priority] <Byte[]>]
    [[-InterfaceAlias] <String>]
    [-Enabled <Boolean>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIfIndex

Set-NetQosFlowControl
    [[-Priority] <Byte[]>]
    [[-InterfaceIndex] <UInt32>]
    [-Enabled <Boolean>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject (cdxml)

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

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 sends the updated settings to data center bridging (DCB)-capable network adapters in the computer.

For more information about 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: Enable flow control traffic for a priority

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

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

Example 2: Disable flow control traffic

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

This command gets the flow control settings for traffic tagged with priority 5 by using the Get-NetQosFlowControl cmdlet. The command passes the results to the current cmdlet by using the pipeline operator. That cmdlet disables the flow control settings.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Enabled

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 sends the updated settings to data center bridging (DCB)-capable network adapters in the computer.

For more information about remote device configurations, see the Set-NetQosDcbxSetting cmdlet.

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Parameter properties

Type:

CimInstance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObject (cdxml)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-InterfaceAlias

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 sends the updated settings to data center bridging (DCB)-capable network adapters in the computer.

For more information about remote device configurations, see the Set-NetQosDcbxSetting cmdlet.

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:IfAlias

Parameter sets

ByIfAlias
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InterfaceIndex

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 sends the updated settings to data center bridging (DCB)-capable network adapters in the computer.

For more information about remote device configurations, see the Set-NetQosDcbxSetting cmdlet.

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

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:IfIndex

Parameter sets

ByIfIndex
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PassThru

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 sends the updated settings to data center bridging (DCB)-capable network adapters in the computer.

For more information about remote device configurations, see the Set-NetQosDcbxSetting cmdlet.

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Priority

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 sends the updated settings to data center bridging (DCB)-capable network adapters in the computer.

For more information about remote device configurations, see the Set-NetQosDcbxSetting cmdlet.

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

Parameter properties

Type:

Byte[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIfAlias
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIfIndex
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ThrottleLimit

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 sends the updated settings to data center bridging (DCB)-capable network adapters in the computer.

For more information about remote device configurations, see the Set-NetQosDcbxSetting cmdlet.

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

UInt32

CimInstance

Boolean

Outputs

CimInstance

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. This cmdlet returns a MSFT_NetQosFlowControlSettingData object that contains flow control settings per priority. Only if you specify the PassThru parameter does this cmdlet return the MSFT_NetQosFlowControlSettingData object.