From cfc2a0fe5b0a7e83c9f07dedec62d75655c59192 Mon Sep 17 00:00:00 2001 From: Meghan Stewart <33289333+mestew@users.noreply.github.com> Date: Fri, 27 Oct 2023 13:47:15 -0700 Subject: [PATCH 1/3] get-windowsupdatelog-7670464max --- .../windowsupdate/Get-WindowsUpdateLog.md | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 8f9e914656..95ebb20d38 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -2,7 +2,7 @@ description: Use this topic 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 @@ -18,7 +18,7 @@ Merges Windows Update `.etl` files into a single log file. ``` Get-WindowsUpdateLog [[-ETLPath] ] [[-LogPath] ] -[-ProcessingType ] [-ForceFlush] [-WhatIf] [-Confirm] [] +[-ProcessingType ] [-IncludeAllLogs] [-ForceFlush] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -141,6 +141,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeAllLogs + +Decodes all update related logs: Windows Update, Update Session Orchestrator (USO), and Update UX (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. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +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`. From 2d2ae07780882e4d99a0522e646fe1cf1a362fb4 Mon Sep 17 00:00:00 2001 From: Meghan Stewart <33289333+mestew@users.noreply.github.com> Date: Fri, 27 Oct 2023 13:57:39 -0700 Subject: [PATCH 2/3] wording tweak --- docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 95ebb20d38..21b3c32bd1 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -143,7 +143,7 @@ Accept wildcard characters: False ### -IncludeAllLogs -Decodes all update related logs: Windows Update, Update Session Orchestrator (USO), and Update UX (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. +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. ```yaml From 0734dbca0d540d7f235c274d21fe57ef397453d1 Mon Sep 17 00:00:00 2001 From: Meghan Stewart <33289333+mestew@users.noreply.github.com> Date: Mon, 30 Oct 2023 09:10:39 -0700 Subject: [PATCH 3/3] parameter sets --- .../windowsupdate/Get-WindowsUpdateLog.md | 31 ++++++++++++------- 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 21b3c32bd1..61aa021be4 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -1,5 +1,5 @@ --- -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: 10/31/2023 @@ -16,21 +16,28 @@ Merges Windows Update `.etl` files into a single log file. ## SYNTAX +### ParameterSetDefault ``` Get-WindowsUpdateLog [[-ETLPath] ] [[-LogPath] ] [-ProcessingType ] [-IncludeAllLogs] [-ForceFlush] [-WhatIf] [-Confirm] [] ``` + +### ParameterSetIncludeAllLogs +``` +Get-WindowsUpdateLog [-IncludeAllLogs] [] +``` + ## 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 @@ -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 @@ -112,7 +119,7 @@ The acceptable values for this parameter are: ```yaml Type: String[] -Parameter Sets: (All) +Parameter Sets: Default Aliases: PsPath Required: False @@ -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 @@ -143,12 +150,12 @@ Accept wildcard characters: False ### -IncludeAllLogs -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. +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: (All) +Parameter Sets: IncludeAllLogs Aliases: Required: False @@ -166,7 +173,7 @@ The default value is `WindowsUpdate.log` in the Desktop folder of the current us ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Default Aliases: Required: False @@ -189,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 @@ -203,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