Skip to content

Commit

Permalink
Merge pull request #3683 from mestew/get-windowsupdatelog-7670464max
Browse files Browse the repository at this point in the history
updates-to-get-windowsupdatelog
  • Loading branch information
aczechowski authored Oct 31, 2023
2 parents f8d6932 + 0734dbc commit 96d0e12
Showing 1 changed file with 37 additions and 12 deletions.
49 changes: 37 additions & 12 deletions docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
description: Use this article to help manage Windows and Windows Server technologies with Windows PowerShell.
external help file: WindowsUpdateLog.psm1-help.xml
Module Name: WindowsUpdate
ms.date: 12/20/2016
ms.date: 10/31/2023
online version: https://learn.microsoft.com/powershell/module/windowsupdate/get-windowsupdatelog?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Get-WindowsUpdateLog
Expand All @@ -16,21 +16,28 @@ Merges Windows Update `.etl` files into a single log file.

## SYNTAX

### ParameterSetDefault
```
Get-WindowsUpdateLog [[-ETLPath] <String[]>] [[-LogPath] <String>]
[-ProcessingType <String>] [-ForceFlush] [-WhatIf] [-Confirm] [<CommonParameters>]
[-ProcessingType <String>] [-IncludeAllLogs] [-ForceFlush] [-WhatIf] [-Confirm] [<CommonParameters>]
```


### ParameterSetIncludeAllLogs
```
Get-WindowsUpdateLog [-IncludeAllLogs] [<CommonParameters>]
```

## DESCRIPTION

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

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

## EXAMPLES
Expand Down Expand Up @@ -90,7 +97,7 @@ Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Parameter Sets: Default
Aliases: cf

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

```yaml
Type: String[]
Parameter Sets: (All)
Parameter Sets: Default
Aliases: PsPath
Required: False
Expand All @@ -131,7 +138,7 @@ PowerShell with administrative credentials by using the Run as administrator com

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Parameter Sets: Default
Aliases:
Required: False
Expand All @@ -141,14 +148,32 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -IncludeAllLogs

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.


```yaml
Type: SwitchParameter
Parameter Sets: IncludeAllLogs
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```


### -LogPath

Specifies the full path to which `Get-WindowsUpdateLog` writes `WindowsUpdate.log`.
The default value is `WindowsUpdate.log` in the Desktop folder of the current user.

```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Default
Aliases:
Required: False
Expand All @@ -171,7 +196,7 @@ The temporary files are in `$env:TEMP\WindowsUpdateLog`.

```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Default
Aliases:
Accepted values: CSV, XML
Expand All @@ -185,11 +210,11 @@ Accept wildcard characters: False
### -WhatIf

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

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Parameter Sets: Default
Aliases: wi
Required: False
Expand Down

0 comments on commit 96d0e12

Please sign in to comment.