Skip to content

Commit 717f79e

Browse files
tiburdtiburd
authored
Merge branch 'master' into patricka-dism
2 parents 9dedf6d + 98f148d commit 717f79e

File tree

8 files changed

+1534
-12
lines changed

8 files changed

+1534
-12
lines changed

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

Lines changed: 285 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,285 @@
1+
---
2+
description: Disables USO properties of the network adapter.
3+
external help file: MSFT_NetAdapterUso.cdxml-help.xml
4+
Module Name: NetAdapter
5+
ms.date: 09/20/2021
6+
online version: https://docs.microsoft.com/powershell/module/netadapter/disable-netadapteruso?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Disable-NetAdapterUso
9+
---
10+
11+
# Disable-NetAdapterUso
12+
13+
## SYNOPSIS
14+
Disables USO properties of the network adapter.
15+
16+
## SYNTAX
17+
18+
### ByName (Default)
19+
```
20+
Disable-NetAdapterUso [-Name] <String[]> [-IncludeHidden] [-IPv4] [-IPv6] [-NoRestart] [-PassThru]
21+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
22+
```
23+
24+
### ByInstanceID
25+
```
26+
Disable-NetAdapterUso -InterfaceDescription <String[]> [-IncludeHidden] [-IPv4] [-IPv6] [-NoRestart]
27+
[-PassThru] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm]
28+
[<CommonParameters>]
29+
```
30+
31+
### InputObject (cdxml)
32+
```
33+
Disable-NetAdapterUso -InputObject <CimInstance[]> [-IPv4] [-IPv6] [-NoRestart] [-PassThru]
34+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
35+
```
36+
37+
## 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-).
43+
44+
## EXAMPLES
45+
46+
### Example 1: Disable USO for IPv6 on a specified network adapter
47+
```powershell
48+
PS> Disable-NetAdapterUso -Name "MyAdapter" -IPv6
49+
```
50+
51+
This command disables the USO for IPv6 on the network adapter named MyAdapter and restarts the network adapter.
52+
53+
## PARAMETERS
54+
55+
### -AsJob
56+
Runs the cmdlet as a background job.
57+
Use this parameter to run commands that take a long time to complete.
58+
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
59+
You can continue to work in the session while the job completes.
60+
To manage the job, use the `*-Job` cmdlets.
61+
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
62+
For more information about Windows PowerShell&reg; background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
63+
64+
```yaml
65+
Type: SwitchParameter
66+
Parameter Sets: (All)
67+
Aliases:
68+
69+
Required: False
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -CimSession
77+
Runs the cmdlet in a remote session or on a remote computer.
78+
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
79+
The default is the current session on the local computer.
80+
81+
```yaml
82+
Type: CimSession[]
83+
Parameter Sets: (All)
84+
Aliases: Session
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### -IncludeHidden
94+
Indicates that this cmdlet includes both visible and hidden network adapters. By
95+
default only visible network adapters are included. If a wildcard character is
96+
used in identifying a network adapter and this parameter has been specified,
97+
then the wildcard string is matched against both hidden and visible network
98+
adapters.
99+
100+
```yaml
101+
Type: SwitchParameter
102+
Parameter Sets: ByName, ByInstanceID
103+
Aliases:
104+
105+
Required: False
106+
Position: Named
107+
Default value: None
108+
Accept pipeline input: False
109+
Accept wildcard characters: False
110+
```
111+
112+
### -InputObject
113+
Specifies the input to this cmdlet.
114+
You can use this parameter, or you can pipe the input to this cmdlet.
115+
116+
```yaml
117+
Type: CimInstance[]
118+
Parameter Sets: InputObject (cdxml)
119+
Aliases:
120+
121+
Required: True
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: True (ByValue)
125+
Accept wildcard characters: False
126+
```
127+
128+
### -InterfaceDescription
129+
Specifies an array of network adapter interface descriptions. For a physical
130+
network adapter this is typically the name of the vendor of the network adapter
131+
followed by a part number and description, such as
132+
`Contoso 12345 Gigabit Network Device`.
133+
134+
```yaml
135+
Type: String[]
136+
Parameter Sets: ByInstanceID
137+
Aliases: ifDesc, InstanceID
138+
139+
Required: True
140+
Position: Named
141+
Default value: None
142+
Accept pipeline input: True (ByPropertyName)
143+
Accept wildcard characters: False
144+
```
145+
146+
### -IPv4
147+
Indicates that this cmdlet affects IPv4 traffic.
148+
149+
```yaml
150+
Type: SwitchParameter
151+
Parameter Sets: (All)
152+
Aliases:
153+
154+
Required: False
155+
Position: Named
156+
Default value: None
157+
Accept pipeline input: False
158+
Accept wildcard characters: False
159+
```
160+
161+
### -IPv6
162+
Indicates that the cmdlet affects IPv6 traffic.
163+
164+
```yaml
165+
Type: SwitchParameter
166+
Parameter Sets: (All)
167+
Aliases:
168+
169+
Required: False
170+
Position: Named
171+
Default value: None
172+
Accept pipeline input: False
173+
Accept wildcard characters: False
174+
```
175+
176+
### -Name
177+
Specifies an array of network adapter names.
178+
179+
```yaml
180+
Type: String[]
181+
Parameter Sets: ByName
182+
Aliases: ifAlias, InterfaceAlias
183+
184+
Required: True
185+
Position: 0
186+
Default value: None
187+
Accept pipeline input: True (ByPropertyName)
188+
Accept wildcard characters: False
189+
```
190+
191+
### -NoRestart
192+
Indicates that the cmdlet does not restart the network adapter after completing the operation.
193+
Many advanced properties require restarting the network adapter before the new settings take effect.
194+
195+
```yaml
196+
Type: SwitchParameter
197+
Parameter Sets: (All)
198+
Aliases:
199+
200+
Required: False
201+
Position: Named
202+
Default value: None
203+
Accept pipeline input: False
204+
Accept wildcard characters: False
205+
```
206+
207+
### -PassThru
208+
Returns an object representing the item with which you are working.
209+
By default, this cmdlet does not generate any output.
210+
211+
```yaml
212+
Type: SwitchParameter
213+
Parameter Sets: (All)
214+
Aliases:
215+
216+
Required: False
217+
Position: Named
218+
Default value: None
219+
Accept pipeline input: False
220+
Accept wildcard characters: False
221+
```
222+
223+
### -ThrottleLimit
224+
Specifies the maximum number of concurrent operations that can be established to
225+
run the cmdlet. If this parameter is omitted or a value of `0` is entered, then
226+
Windows PowerShell calculates an optimum throttle limit for the cmdlet based on
227+
the number of CIM cmdlets that are running on the computer. The throttle limit
228+
applies only to the current cmdlet, not to the session or to the computer.
229+
230+
```yaml
231+
Type: Int32
232+
Parameter Sets: (All)
233+
Aliases:
234+
235+
Required: False
236+
Position: Named
237+
Default value: None
238+
Accept pipeline input: False
239+
Accept wildcard characters: False
240+
```
241+
242+
### -Confirm
243+
Prompts you for confirmation before running the cmdlet.
244+
245+
```yaml
246+
Type: SwitchParameter
247+
Parameter Sets: (All)
248+
Aliases: cf
249+
250+
Required: False
251+
Position: Named
252+
Default value: None
253+
Accept pipeline input: False
254+
Accept wildcard characters: False
255+
```
256+
257+
### -WhatIf
258+
Shows what would happen if the cmdlet runs.
259+
The cmdlet is not run.
260+
261+
```yaml
262+
Type: SwitchParameter
263+
Parameter Sets: (All)
264+
Aliases: wi
265+
266+
Required: False
267+
Position: Named
268+
Default value: None
269+
Accept pipeline input: False
270+
Accept wildcard characters: False
271+
```
272+
273+
### CommonParameters
274+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
275+
276+
## INPUTS
277+
278+
### System.String[]
279+
### Microsoft.Management.Infrastructure.CimInstance[]
280+
## OUTPUTS
281+
282+
### Microsoft.Management.Infrastructure.CimInstance
283+
## NOTES
284+
285+
## RELATED LINKS

0 commit comments

Comments
 (0)