Skip to content

Commit 0734dbc

Browse files
committed
parameter sets
1 parent 2d2ae07 commit 0734dbc

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md

Lines changed: 19 additions & 12 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: Use this article to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: WindowsUpdateLog.psm1-help.xml
44
Module Name: WindowsUpdate
55
ms.date: 10/31/2023
@@ -16,21 +16,28 @@ Merges Windows Update `.etl` files into a single log file.
1616

1717
## SYNTAX
1818

19+
### ParameterSetDefault
1920
```
2021
Get-WindowsUpdateLog [[-ETLPath] <String[]>] [[-LogPath] <String>]
2122
[-ProcessingType <String>] [-IncludeAllLogs] [-ForceFlush] [-WhatIf] [-Confirm] [<CommonParameters>]
2223
```
2324

25+
26+
### ParameterSetIncludeAllLogs
27+
```
28+
Get-WindowsUpdateLog [-IncludeAllLogs] [<CommonParameters>]
29+
```
30+
2431
## DESCRIPTION
2532

2633
The `Get-WindowsUpdateLog` cmdlet merges and converts Windows Update `.etl` files into a single
2734
readable `WindowsUpdate.log` file. Windows Update Agent uses Event Tracing for Windows (ETW) to
2835
generate diagnostic logs. Windows Update no longer directly produces a `WindowsUpdate.log` file.
29-
Instead, it produces `.etl` files that are not immediately readable as written.
36+
Instead, it produces `.etl` files that aren't immediately readable as written.
3037

3138
For Windows 10 versions prior to 1709 (OS Build 16299), this cmdlet requires access to a Microsoft
3239
symbol server, and log decoding must be run from a Windows 10 version earlier than 1709. Logs from
33-
Windows 10, version 1709 onward do not require a Microsoft symbol server, and need to be decoded
40+
Windows 10, version 1709 onward don't require a Microsoft symbol server, and need to be decoded
3441
from Windows 10, versions 1709 or higher.
3542

3643
## EXAMPLES
@@ -90,7 +97,7 @@ Prompts you for confirmation before running the cmdlet.
9097

9198
```yaml
9299
Type: SwitchParameter
93-
Parameter Sets: (All)
100+
Parameter Sets: Default
94101
Aliases: cf
95102

96103
Required: False
@@ -112,7 +119,7 @@ The acceptable values for this parameter are:
112119

113120
```yaml
114121
Type: String[]
115-
Parameter Sets: (All)
122+
Parameter Sets: Default
116123
Aliases: PsPath
117124
118125
Required: False
@@ -131,7 +138,7 @@ PowerShell with administrative credentials by using the Run as administrator com
131138

132139
```yaml
133140
Type: SwitchParameter
134-
Parameter Sets: (All)
141+
Parameter Sets: Default
135142
Aliases:
136143
137144
Required: False
@@ -143,12 +150,12 @@ Accept wildcard characters: False
143150

144151
### -IncludeAllLogs
145152

146-
Decodes all update related logs: Windows Update, Update Session Orchestrator (USO), and Update user interface (UX). This parameter is mutually exclusive of all other parameters of this cmdlet. Specifying this parameter will use defaults for all other parameters. This paramater causes a folder to be created on the desktop and readable WindowsUpdate.log, USO.log, and UX.log files are written to it.
153+
Decodes all update-related logs: Windows Update, Update Session Orchestrator (USO), and the update user interface (UX). This parameter is mutually exclusive of all other parameters of this cmdlet. Specifying this parameter uses defaults for all other parameters. This parameter causes a folder to be created on the desktop and readable WindowsUpdate.log, USO.log, and UX.log files are written to it.
147154

148155

149156
```yaml
150157
Type: SwitchParameter
151-
Parameter Sets: (All)
158+
Parameter Sets: IncludeAllLogs
152159
Aliases:
153160
154161
Required: False
@@ -166,7 +173,7 @@ The default value is `WindowsUpdate.log` in the Desktop folder of the current us
166173

167174
```yaml
168175
Type: String
169-
Parameter Sets: (All)
176+
Parameter Sets: Default
170177
Aliases:
171178
172179
Required: False
@@ -189,7 +196,7 @@ The temporary files are in `$env:TEMP\WindowsUpdateLog`.
189196

190197
```yaml
191198
Type: String
192-
Parameter Sets: (All)
199+
Parameter Sets: Default
193200
Aliases:
194201
Accepted values: CSV, XML
195202
@@ -203,11 +210,11 @@ Accept wildcard characters: False
203210
### -WhatIf
204211

205212
Shows what would happen if the cmdlet runs.
206-
The cmdlet is not run.
213+
The cmdlet isn't run.
207214

208215
```yaml
209216
Type: SwitchParameter
210-
Parameter Sets: (All)
217+
Parameter Sets: Default
211218
Aliases: wi
212219
213220
Required: False

0 commit comments

Comments
 (0)