Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix incorrect (ThrottleRateActionBytesPerSecond) parameter to correct one (ThrottleRateActionBitsPerSecond) in New-NetQosPolicy #3700

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docset/winserver2012-ps/netqos/New-NetQosPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ New-NetQosPolicy [-Name] <String> [-AppPathNameMatchCondition <String>] [-AsJob]
[-IPSrcPortMatchCondition <UInt16>] [-IPSrcPortStartMatchCondition <UInt16>]
[-IPSrcPrefixMatchCondition <String>] [-MinBandwidthWeightAction <Byte>] [-NetworkProfile <NetworkProfile>]
[-PolicyStore <String>] [-Precedence <UInt32>] [-PriorityValue8021Action <SByte>] [-ThrottleLimit <Int32>]
[-ThrottleRateActionBytesPerSecond <UInt64>] [-UserMatchCondition <String>] [-Confirm] [-WhatIf]
[-ThrottleRateActionBitsPerSecond <UInt64>] [-UserMatchCondition <String>] [-Confirm] [-WhatIf]
```

### UNNAMED_PARAMETER_SET_2
```
New-NetQosPolicy [-Name] <String> [-AppPathNameMatchCondition <String>] [-AsJob] [-CimSession <CimSession[]>]
[-DSCPAction <SByte>] [-IPProtocolMatchCondition <Protocol>] [-MinBandwidthWeightAction <Byte>]
[-NetworkProfile <NetworkProfile>] [-PolicyStore <String>] [-Precedence <UInt32>]
[-PriorityValue8021Action <SByte>] [-ThrottleLimit <Int32>] [-ThrottleRateActionBytesPerSecond <UInt64>]
[-PriorityValue8021Action <SByte>] [-ThrottleLimit <Int32>] [-ThrottleRateActionBitsPerSecond <UInt64>]
[-UserMatchCondition <String>] -IPPortMatchCondition <UInt16> [-Confirm] [-WhatIf]
```

Expand All @@ -38,15 +38,15 @@ New-NetQosPolicy [-Name] <String> [-AppPathNameMatchCondition <String>] [-AsJob]
New-NetQosPolicy [-Name] <String> [-AsJob] [-CimSession <CimSession[]>] [-DSCPAction <SByte>]
[-MinBandwidthWeightAction <Byte>] [-NetworkProfile <NetworkProfile>] [-PolicyStore <String>]
[-Precedence <UInt32>] [-PriorityValue8021Action <SByte>] [-ThrottleLimit <Int32>]
[-ThrottleRateActionBytesPerSecond <UInt64>] [-SMB] [-Confirm] [-WhatIf]
[-ThrottleRateActionBitsPerSecond <UInt64>] [-SMB] [-Confirm] [-WhatIf]
```

### UNNAMED_PARAMETER_SET_4
```
New-NetQosPolicy [-Name] <String> [-AsJob] [-CimSession <CimSession[]>] [-DSCPAction <SByte>]
[-MinBandwidthWeightAction <Byte>] [-NetworkProfile <NetworkProfile>] [-PolicyStore <String>]
[-Precedence <UInt32>] [-PriorityValue8021Action <SByte>] [-ThrottleLimit <Int32>]
[-ThrottleRateActionBytesPerSecond <UInt64>] [-Default] [-Confirm] [-WhatIf]
[-ThrottleRateActionBitsPerSecond <UInt64>] [-Default] [-Confirm] [-WhatIf]
```

### UNNAMED_PARAMETER_SET_5
Expand All @@ -60,7 +60,7 @@ New-NetQosPolicy [-Name] <String> [-AsJob] [-CimSession <CimSession[]>] [-Networ
```
New-NetQosPolicy [-Name] <String> [-AsJob] [-CimSession <CimSession[]>] [-DSCPAction <SByte>]
[-IPDstPrefixMatchCondition <String>] [-NetworkProfile <NetworkProfile>] [-PolicyStore <String>]
[-Precedence <UInt32>] [-ThrottleLimit <Int32>] [-ThrottleRateActionBytesPerSecond <UInt64>]
[-Precedence <UInt32>] [-ThrottleLimit <Int32>] [-ThrottleRateActionBitsPerSecond <UInt64>]
[-URIRecursiveMatchCondition <Boolean>] -URIMatchCondition <String> [-Confirm] [-WhatIf]
```

Expand All @@ -76,23 +76,23 @@ New-NetQosPolicy [-Name] <String> [-AsJob] [-CimSession <CimSession[]>] [-Networ
New-NetQosPolicy [-Name] <String> [-AsJob] [-CimSession <CimSession[]>] [-DSCPAction <SByte>]
[-MinBandwidthWeightAction <Byte>] [-NetworkProfile <NetworkProfile>] [-PolicyStore <String>]
[-Precedence <UInt32>] [-PriorityValue8021Action <SByte>] [-ThrottleLimit <Int32>]
[-ThrottleRateActionBytesPerSecond <UInt64>] [-NFS] [-Confirm] [-WhatIf]
[-ThrottleRateActionBitsPerSecond <UInt64>] [-NFS] [-Confirm] [-WhatIf]
```

### UNNAMED_PARAMETER_SET_9
```
New-NetQosPolicy [-Name] <String> [-AsJob] [-CimSession <CimSession[]>] [-DSCPAction <SByte>]
[-MinBandwidthWeightAction <Byte>] [-NetworkProfile <NetworkProfile>] [-PolicyStore <String>]
[-Precedence <UInt32>] [-PriorityValue8021Action <SByte>] [-ThrottleLimit <Int32>]
[-ThrottleRateActionBytesPerSecond <UInt64>] [-LiveMigration] [-Confirm] [-WhatIf]
[-ThrottleRateActionBitsPerSecond <UInt64>] [-LiveMigration] [-Confirm] [-WhatIf]
```

### UNNAMED_PARAMETER_SET_10
```
New-NetQosPolicy [-Name] <String> [-AsJob] [-CimSession <CimSession[]>] [-DSCPAction <SByte>]
[-MinBandwidthWeightAction <Byte>] [-NetworkProfile <NetworkProfile>] [-PolicyStore <String>]
[-Precedence <UInt32>] [-PriorityValue8021Action <SByte>] [-ThrottleLimit <Int32>]
[-ThrottleRateActionBytesPerSecond <UInt64>] [-iSCSI] [-Confirm] [-WhatIf]
[-ThrottleRateActionBitsPerSecond <UInt64>] [-iSCSI] [-Confirm] [-WhatIf]
```

## DESCRIPTION
Expand Down Expand Up @@ -131,7 +131,7 @@ The **SMB** parameter is a built-in filter that matches TCP port `445`, which is

### EXAMPLE 2
```
PS C:\> New-NetQosPolicy -Name "FTP" -AppPathNameMatchCondition ftp.exe -ThrottleRateActionBytesPerSecond 1MB -PolicyStore ActiveStore
PS C:\> New-NetQosPolicy -Name "FTP" -AppPathNameMatchCondition ftp.exe -ThrottleRateActionBitsPerSecond 1MB -PolicyStore ActiveStore
Name : FTP
Owner : PowerShell / WMI
NetworkProfile : All
Expand All @@ -143,7 +143,7 @@ ThrottleRate : 1.049 MBits/sec
This example creates a QoS policy named FTP, that matches an application path at ftp.exe and throttles the traffic at 1,000,000 bytes per second.
This policy is ActiveStore, meaning that it is not persistent after reboot of the computer.

An alias for the **ThrottleRateActionBytesPerSecond** parameter is `MaxBw`.
An alias for the **ThrottleRateActionBitsPerSecond** parameter is `MaxBw`.

### EXAMPLE 3
```
Expand All @@ -162,7 +162,7 @@ This policy is effective only on traffic sent on a domain-joined network adapter

### EXAMPLE 4
```
PS C:\> New-NetQosPolicy -Name "HTTP" -IPPort 80 -IPProtocol TCP -ThrottleRateActionBytesPerSecond 10MB
PS C:\> New-NetQosPolicy -Name "HTTP" -IPPort 80 -IPProtocol TCP -ThrottleRateActionBitsPerSecond 10MB
Name : HTTP
Owner : Group Policy (Machine)
NetworkProfile : All
Expand All @@ -189,7 +189,7 @@ This example creates a QoS policy named Wildcard, that catches all the traffic t

### EXAMPLE 6
```
PS C:\> New-NetQosPolicy -Name "IIS" -URIMatchCondition "http://training" -ThrottleRateActionBytesPerSecond 500KB
PS C:\> New-NetQosPolicy -Name "IIS" -URIMatchCondition "http://training" -ThrottleRateActionBitsPerSecond 500KB
Name : IIS
Owner : Group Policy (Machine)
NetworkProfile : Domain
Expand Down Expand Up @@ -689,7 +689,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ThrottleRateActionBytesPerSecond
### -ThrottleRateActionBitsPerSecond
Specifies a throttle rate in bytes per second, also known as maximum bandwidth.

```yaml
Expand Down
8 changes: 4 additions & 4 deletions docset/winserver2012r2-ps/netqos/New-NetQosPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ The **SMB** parameter is a built-in filter that matches TCP port `445`, which is

### EXAMPLE 2
```
PS C:\> New-NetQosPolicy -Name "FTP" -AppPathNameMatchCondition ftp.exe -ThrottleRateActionBytesPerSecond 1MB -PolicyStore ActiveStore
PS C:\> New-NetQosPolicy -Name "FTP" -AppPathNameMatchCondition ftp.exe -ThrottleRateActionBitsPerSecond 1MB -PolicyStore ActiveStore
Name : FTP
Owner : PowerShell / WMI
NetworkProfile : All
Expand All @@ -154,7 +154,7 @@ ThrottleRate : 1.049 MBits/sec
This example creates a QoS policy named FTP, that matches an application path at ftp.exe and throttles the traffic at 1,000,000 bytes per second.
This policy is ActiveStore, meaning that it is not persistent after reboot of the computer.

An alias for the **ThrottleRateActionBytesPerSecond** parameter is `MaxBw`.
An alias for the **ThrottleRateActionBitsPerSecond** parameter is `MaxBw`.

### EXAMPLE 3
```
Expand All @@ -173,7 +173,7 @@ This policy is effective only on traffic sent on a domain-joined network adapter

### EXAMPLE 4
```
PS C:\> New-NetQosPolicy -Name "HTTP" -IPPort 80 -IPProtocol TCP -ThrottleRateActionBytesPerSecond 10MB
PS C:\> New-NetQosPolicy -Name "HTTP" -IPPort 80 -IPProtocol TCP -ThrottleRateActionBitsPerSecond 10MB
Name : HTTP
Owner : Group Policy (Machine)
NetworkProfile : All
Expand All @@ -200,7 +200,7 @@ This example creates a QoS policy named Wildcard, that catches all the traffic t

### EXAMPLE 6
```
PS C:\> New-NetQosPolicy -Name "IIS" -URIMatchCondition "http://training" -ThrottleRateActionBytesPerSecond 500KB
PS C:\> New-NetQosPolicy -Name "IIS" -URIMatchCondition "http://training" -ThrottleRateActionBitsPerSecond 500KB
Name : IIS
Owner : Group Policy (Machine)
NetworkProfile : Domain
Expand Down