Skip to content

Commit aa09062

Browse files
PatAltimorePatAltimore
committed
Add USO descriptions
1 parent db29188 commit aa09062

File tree

5 files changed

+61
-38
lines changed

5 files changed

+61
-38
lines changed

‎docset/winserver2022-ps/netadapter/Disable-NetAdapterUso.md‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
2+
description: Disables USO properties of the network adapter.
33
external help file: MSFT_NetAdapterUso.cdxml-help.xml
44
Module Name: NetAdapter
55
ms.date: 09/20/2021
@@ -11,7 +11,7 @@ title: Disable-NetAdapterUso
1111
# Disable-NetAdapterUso
1212

1313
## SYNOPSIS
14-
{{ Fill in the Synopsis }}
14+
Disables USO properties of the network adapter.
1515

1616
## SYNTAX
1717

@@ -35,16 +35,20 @@ Disable-NetAdapterUso -InputObject <CimInstance[]> [-IPv4] [-IPv6] [-NoRestart]
3535
```
3636

3737
## DESCRIPTION
38-
{{ Fill in the Description }}
38+
The **Disable-NetAdapterUso** cmdlet disables the state of the UDP Segmentation Offload (USO) on the network adapter.
39+
40+
If neither IPv4 or IPv6 is specified, then both are disabled.
41+
42+
For more information, see [UDP Segmentation Offload (USO)](/windows-hardware/drivers/network/udp-segmentation-offload-uso-).
3943

4044
## EXAMPLES
4145

42-
### Example 1
46+
### Example 1: Disable USO for IPv6 on a specified network adapter
4347
```powershell
44-
PS C:\> {{ Add example code here }}
48+
PS> Disable-NetAdapterUso -Name "MyAdapter" -IPv6
4549
```
4650

47-
{{ Add example description here }}
51+
This command disables the USO for IPv6 on the network adapter named MyAdapter and restarts the network adapter.
4852

4953
## PARAMETERS
5054

@@ -55,7 +59,7 @@ Use this parameter to run commands that take a long time to complete.
5559
You can continue to work in the session while the job completes.
5660
To manage the job, use the `*-Job` cmdlets.
5761
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
58-
For more information about Windows PowerShell® background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
62+
For more information about Windows PowerShell&reg; background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5963

6064
```yaml
6165
Type: SwitchParameter
@@ -219,7 +223,7 @@ Accept wildcard characters: False
219223
### -ThrottleLimit
220224
Specifies the maximum number of concurrent operations that can be established to
221225
run the cmdlet. If this parameter is omitted or a value of `0` is entered, then
222-
Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on
226+
Windows PowerShell&reg; calculates an optimum throttle limit for the cmdlet based on
223227
the number of CIM cmdlets that are running on the computer. The throttle limit
224228
applies only to the current cmdlet, not to the session or to the computer.
225229

‎docset/winserver2022-ps/netadapter/Enable-NetAdapterUso.md‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
2+
description: Enables USO properties of the network adapter.
33
external help file: MSFT_NetAdapterUso.cdxml-help.xml
44
Module Name: NetAdapter
55
ms.date: 09/20/2021
@@ -11,7 +11,7 @@ title: Enable-NetAdapterUso
1111
# Enable-NetAdapterUso
1212

1313
## SYNOPSIS
14-
{{ Fill in the Synopsis }}
14+
Enables USO properties of the network adapter.
1515

1616
## SYNTAX
1717

@@ -34,16 +34,20 @@ Enable-NetAdapterUso -InputObject <CimInstance[]> [-IPv4] [-IPv6] [-NoRestart] [
3434
```
3535

3636
## DESCRIPTION
37-
{{ Fill in the Description }}
37+
The **Enable-NetAdapterUso** cmdlet enables the state of the UDP Segmentation Offload (USO) on the network adapter.
38+
39+
If neither IPv4 or IPv6 is specified, then both are enabled.
40+
41+
For more information, see [UDP Segmentation Offload (USO)](/windows-hardware/drivers/network/udp-segmentation-offload-uso-).
3842

3943
## EXAMPLES
4044

41-
### Example 1
45+
### Example 1: Enable USO for IPv4 and IPv6 on all visible network adapters
4246
```powershell
43-
PS C:\> {{ Add example code here }}
47+
PS> Enable-NetAdapterUso -Name "*" -IPv4 -IPv6
4448
```
4549

46-
{{ Add example description here }}
50+
This command enables USO for both IPv4 and IPv6 on all visible network adapters by explicitly specifying the parameters and then restarts the network adapters.
4751

4852
## PARAMETERS
4953

@@ -54,7 +58,7 @@ Use this parameter to run commands that take a long time to complete.
5458
You can continue to work in the session while the job completes.
5559
To manage the job, use the `*-Job` cmdlets.
5660
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
57-
For more information about Windows PowerShell® background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
61+
For more information about Windows PowerShell&reg; background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5862

5963
```yaml
6064
Type: SwitchParameter
@@ -218,7 +222,7 @@ Accept wildcard characters: False
218222
### -ThrottleLimit
219223
Specifies the maximum number of concurrent operations that can be established to
220224
run the cmdlet. If this parameter is omitted or a value of `0` is entered, then
221-
Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on
225+
Windows PowerShell&reg; calculates an optimum throttle limit for the cmdlet based on
222226
the number of CIM cmdlets that are running on the computer. The throttle limit
223227
applies only to the current cmdlet, not to the session or to the computer.
224228

‎docset/winserver2022-ps/netadapter/Get-NetAdapterUso.md‎

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
2+
description: Gets the USO properties of the network adapter.
33
external help file: MSFT_NetAdapterUso.cdxml-help.xml
44
Module Name: NetAdapter
55
ms.date: 09/20/2021
@@ -11,7 +11,7 @@ title: Get-NetAdapterUso
1111
# Get-NetAdapterUso
1212

1313
## SYNOPSIS
14-
{{ Fill in the Synopsis }}
14+
Gets the USO properties of the network adapter.
1515

1616
## SYNTAX
1717

@@ -28,16 +28,31 @@ Get-NetAdapterUso -InterfaceDescription <String[]> [-IncludeHidden] [-CimSession
2828
```
2929

3030
## DESCRIPTION
31-
{{ Fill in the Description }}
31+
The **Get-NetAdapterUso** cmdlet gets the UDP Segmentation Offload (USO) that enables network interface cards (NICs) to offload the segmentation of UDP datagrams that are larger than the maximum transmission unit (MTU) of the network medium. By doing so, Windows reduces CPU utilization associated with per-packet TCP/IP processing. For more information, see [UDP Segmentation Offload (USO)](/windows-hardware/drivers/network/udp-segmentation-offload-uso-).
3232

3333
## EXAMPLES
3434

35-
### Example 1
35+
### Example 1: Get the USO properties for the specified network adapter
3636
```powershell
37-
PS C:\> {{ Add example code here }}
37+
PS> Get-NetAdapterUso -Name "MyAdapter"
3838
```
3939

40-
{{ Add example description here }}
40+
This command gets the USO properties of the network adapter named MyAdapter.
41+
42+
### Example 2: Display all the USO properties for the specified network adapter
43+
```
44+
PS> Get-NetAdapterUso -Name "MyAdapter" | Format-List -Property "*"
45+
```
46+
47+
This command displays all of the USO properties of the network adapter named MyAdapter.
48+
49+
### Example 3: Get all network adapters that have USO enabled
50+
```
51+
PS> Get-NetAdapterUso -Name "*" | Where-Object -FilterScript { $_.Enabled }
52+
```
53+
54+
This command gets all network adapters with USO enabled.
55+
4156

4257
## PARAMETERS
4358

@@ -48,7 +63,7 @@ Use this parameter to run commands that take a long time to complete.
4863
You can continue to work in the session while the job completes.
4964
To manage the job, use the `*-Job` cmdlets.
5065
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
51-
For more information about Windows PowerShell® background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
66+
For more information about Windows PowerShell&reg; background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5267

5368
```yaml
5469
Type: SwitchParameter
@@ -134,7 +149,7 @@ Accept wildcard characters: False
134149
### -ThrottleLimit
135150
Specifies the maximum number of concurrent operations that can be established to
136151
run the cmdlet. If this parameter is omitted or a value of `0` is entered, then
137-
Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on
152+
Windows PowerShell&reg; calculates an optimum throttle limit for the cmdlet based on
138153
the number of CIM cmdlets that are running on the computer. The throttle limit
139154
applies only to the current cmdlet, not to the session or to the computer.
140155

‎docset/winserver2022-ps/netadapter/NetAdapter.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Disables RSS on a network adapter.
5151
Disables SR-IOV on a network adapter.
5252

5353
### [Disable-NetAdapterUso](Disable-NetAdapterUso.md)
54-
{{ Fill in the Synopsis }}
54+
Disables USO properties of the network adapter.
5555

5656
### [Disable-NetAdapterVmq](Disable-NetAdapterVmq.md)
5757
Disables the VMQ feature on a network adapter.
@@ -93,7 +93,7 @@ Enables RSS on a network adapter.
9393
Enables SR-IOV on a network adapter.
9494

9595
### [Enable-NetAdapterUso](Enable-NetAdapterUso.md)
96-
{{ Fill in the Synopsis }}
96+
Enables USO properties of the network adapter.
9797

9898
### [Enable-NetAdapterVmq](Enable-NetAdapterVmq.md)
9999
Enables VMQ on a network adapter.
@@ -150,7 +150,7 @@ Displays the SR-IOV virtual function settings for a network adapter.
150150
Gets statistics from a network adapter.
151151

152152
### [Get-NetAdapterUso](Get-NetAdapterUso.md)
153-
{{ Fill in the Synopsis }}
153+
Gets the USO properties of the network adapter.
154154

155155
### [Get-NetAdapterVmq](Get-NetAdapterVmq.md)
156156
Gets the VMQ properties of a network adapter.
@@ -219,7 +219,7 @@ Sets the RSS properties on a network adapter.
219219
Sets the SR-IOV properties of the network adapter, such as the number of virtual functions, the number of VPorts, and the number of queue pairs for default and non-default VPorts.
220220

221221
### [Set-NetAdapterUso](Set-NetAdapterUso.md)
222-
{{ Fill in the Synopsis }}
222+
Sets the USO properties of a network adapter.
223223

224224
### [Set-NetAdapterVmq](Set-NetAdapterVmq.md)
225225
Sets the VMQ properties of a network adapter.

‎docset/winserver2022-ps/netadapter/Set-NetAdapterUso.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
2+
description: Sets the USO properties of a network adapter.
33
external help file: MSFT_NetAdapterUso.cdxml-help.xml
44
Module Name: NetAdapter
55
ms.date: 09/20/2021
@@ -11,7 +11,7 @@ title: Set-NetAdapterUso
1111
# Set-NetAdapterUso
1212

1313
## SYNOPSIS
14-
{{ Fill in the Synopsis }}
14+
Sets the USO properties of a network adapter.
1515

1616
## SYNTAX
1717

@@ -37,16 +37,16 @@ Set-NetAdapterUso -InputObject <CimInstance[]> [-IPv4Enabled <Boolean>] [-IPv6En
3737
```
3838

3939
## DESCRIPTION
40-
{{ Fill in the Description }}
40+
The **Set-NetAdapterUso** cmdlet manages the UDP Segmentation Offload (USO) that enables network interface cards (NICs) to offload the segmentation of UDP datagrams that are larger than the maximum transmission unit (MTU) of the network medium. By doing so, Windows reduces CPU utilization associated with per-packet TCP/IP processing. For more information, see [UDP Segmentation Offload (USO)](/windows-hardware/drivers/network/udp-segmentation-offload-uso-).
4141

4242
## EXAMPLES
4343

44-
### Example 1
44+
### Example 1: Enable USO for IPv4 and disable USO for IPv6 on the specified network adapter
4545
```powershell
46-
PS C:\> {{ Add example code here }}
46+
PS> Set-NetAdapterUso -Name "MyAdapter" -IPv4Enabled $True -IPv6Enabled $False
4747
```
4848

49-
{{ Add example description here }}
49+
This command enables USO for IPv4 and disables USO for IPv6 on the network adapter named *MyAdapter*.
5050

5151
## PARAMETERS
5252

@@ -57,7 +57,7 @@ Use this parameter to run commands that take a long time to complete.
5757
You can continue to work in the session while the job completes.
5858
To manage the job, use the `*-Job` cmdlets.
5959
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
60-
For more information about Windows PowerShell® background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
60+
For more information about Windows PowerShell&reg; background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
6161

6262
```yaml
6363
Type: SwitchParameter
@@ -142,7 +142,7 @@ Accept wildcard characters: False
142142
```
143143

144144
### -IPv4Enabled
145-
{{ Fill IPv4Enabled Description }}
145+
Indicates whether USO for IPv4 traffic is enabled.
146146

147147
```yaml
148148
Type: Boolean
@@ -157,7 +157,7 @@ Accept wildcard characters: False
157157
```
158158

159159
### -IPv6Enabled
160-
{{ Fill IPv6Enabled Description }}
160+
Indicates whether USO for IPv6 traffic is enabled.
161161

162162
```yaml
163163
Type: Boolean
@@ -221,7 +221,7 @@ Accept wildcard characters: False
221221
### -ThrottleLimit
222222
Specifies the maximum number of concurrent operations that can be established to
223223
run the cmdlet. If this parameter is omitted or a value of `0` is entered, then
224-
Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on
224+
Windows PowerShell&reg; calculates an optimum throttle limit for the cmdlet based on
225225
the number of CIM cmdlets that are running on the computer. The throttle limit
226226
applies only to the current cmdlet, not to the session or to the computer.
227227

0 commit comments

Comments
 (0)