Merge pull request #16266 from LouisBerner/v-loberner-ado-322688-update-support-tool-version-23h2

Updated content for Azure Local support tool.

Author: JamesJBarnett

azure-stack/hci/manage/support-tools.md

@@ -1,77 +1,97 @@
 ---
-title: Support tool for Azure Stack HCI (22H2)
-description: This article provides guidance on the Azure Stack HCI Support Diagnostic Tool for Azure Stack HCI, version 22H2.
+title: Support tool for Azure Local instance running version 22H2
+description: This article provides guidance on the Support Diagnostic Tool for Azure Local.
 author: alkohli
 ms.author: alkohli
 ms.topic: how-to
-ms.date: 03/06/2024
+ms.date: 11/08/2024
 ---
 
-# Use the Azure Stack HCI Support Diagnostic tool to troubleshoot issues 
-
-[!INCLUDE [applies-to](../../hci/includes/hci-applies-to-22h2.md)]
-
-This article provides information on the Azure Stack HCI Support Diagnostic Tool that helps you troubleshoot and diagnose complex issues on your Azure Stack HCI. The tool consists of a set of PowerShell commands that simplify data collection, troubleshooting, and resolution of common issues in Azure Stack HCI.
-
-> [!NOTE]
-> This tool is currently only available for Azure Stack HCI, version 22H2.
-
-This tool is designed to simplify the support and troubleshooting process and isn't a substitute for expert knowledge. If you encounter any issues, we recommend that you reach out to Microsoft Support for assistance.
+# Use the Support Diagnostic Tool to troubleshoot Azure Local issues
 
+This article provides information to download and use the Azure Local Support Diagnostic Tool. The tool is a set of PowerShell commands to simplify data collection, troubleshooting, and resolution of common issues.
 
+This tool isn't a substitute for expert knowledge. If you encounter any issues, contact Microsoft Support for assistance.
 
 ## Benefits
 
-The Azure Stack HCI Support Diagnostic Tool simplifies the support and troubleshooting process by providing simple commands that don't require any knowledge of the underlying product. This means that you can quickly get a first glance at what might be causing an issue, without needing to be an expert on the product.
+The Azure Local Support Diagnostic Tool uses simple commands to identify issues without expert product knowledge.
 
-The tool currently offers the following features:
+The tool provides:
 
-- **Easy installation and updates**: Can be installed and updated natively using PowerShell Gallery, without any extra requirements.
+- **Easy installation and updates**: Install and update natively using PowerShell Gallery, without extra requirements.
 
-- **Diagnostic checks**: Offers diagnostic checks based on common issues, incidents, and telemetry data.
+- **Diagnostic checks**: Provides diagnostic checks based on common issues, incidents, and telemetry data.
 
-- **Automatic data collection**: Automatically collects important data in case you want to reach out to Microsoft Customer Support.
+- **Automatic data collection**: Automatically collects important data to provide to Microsoft Support.
 
-- **Regular updates**: Is regularly updated with new checks and useful commands to manage, troubleshoot, and diagnose issues on Azure Stack HCI.
+- **Regular updates**: Updates with new checks and useful commands to manage, troubleshoot, and diagnose issues on Azure Local.
 
 ## Prerequisites
 
-The following prerequisites must be completed to ensure the PowerShell module runs properly:
+Before you use the PowerShell module, make sure to:
+
+- Download the Azure Local Support Diagnostic Tool from the [PowerShell Gallery](https://www.powershellgallery.com/packages?q=hci).
 
-- Download the Azure Stack HCI Support Diagnostic tool from the [PowerShell Gallery](https://www.powershellgallery.com/packages?q=hci).
+- Import the module into an elevated PowerShell window using an account with administrator privileges on the local system.
 
-- Import the module into an elevated PowerShell window by an account with administrator privileges on the local system.
+- Install the module on each node of the Azure Local system.
 
-- Install the  module on each node of the Azure Stack HCI system.
+## Install and use the Azure Local Support Diagnostic Tool
 
-## Install and use the tool
+Run PowerShell as an administrator and then run the following commands:
 
-To install the tool, run the following command in PowerShell:
+To install the tool, run the following command:
 
 ```powershell
 Install-Module –Name Microsoft.AzureStack.HCI.CSSTools
 ```
 
-To list all diagnostic checks that are available, run the following command:
+To list all available diagnostic checks, run the following command:
 
 ```powershell
 Invoke-AzsSupportDiagnosticCheck –ProductName <BaseSystem, Registration>
 ```
 
-You can check all diagnostic checks by pressing `CTRL+SPACE` after the parameter `ProductName`.
+Run all diagnostic checks by pressing `CTRL+SPACE` after the parameter `ProductName`.
 
-## Example scenario
+To collect data using one of our pre-defined collection sets, run the following command:
+
+```powershell
+New-AzsSupportDataBundle –Component <Component>
+```
+
+To check all data collection sets, press `CTRL+SPACE` after the parameter `Component`.
+
+To collect your own dataset, run the following command:
+
+```powershell
+$ClusterCommands = @(<clusterCommand1>,<clusterCommand2>)
+$nodeCommands = @(<nodeCommand1>,<nodeCommand2>)
+$nodeEvents = @(<eventLogName1>,<eventLogName2>)
+$nodeRegistry = @(<registryPath1>,<registryPath2>)
+$nodeFolders = @(<folderPath1>,<folderPath2>)
+
+
+New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
+-NodeCommands $nodeCommands `
+-NodeEvents $nodeEvents `
+-NodeRegistry $nodeRegistry `
+-NodeFolders $nodeFolders `
+-ComputerName @(<computerName1>,<computerName2>)
+```
 
-To troubleshoot Azure Stack HCI core products, for example, you can run the following cmdlet:
+## Example scenario
 
+To troubleshoot Azure Local, run the following command:
 
 #### For registration issues
 
 ```powershell
 Invoke-AzsSupportDiagnosticCheck -ProductName Registration
 ```
 
-Here's an example of the output for registration issue:
+Here's an example of output for a registration issue:
 
 ```output
 PS C:\temp> Invoke-AzsSupportDiagnosticCheck -ProductName Registration
@@ -89,7 +109,7 @@ Details: Validation successfull
 [Fail] [Azure Stack HCI - Azure Connection state]
 Validate that the cluster is in a connected state
 Details: This Azure Stack HCI node does not seem to be connected to azure. Ensure that this node is in a connected state.
-Documentation: https://learn.microsoft.com/en-us/azure-stack/hci/deploy/troubleshoot-hci-registration
+Documentation: https://learn.microsoft.com/en-us/azure-stack/hci/deploy/troubleshoot-hci-registration.
 
 [Pass] [Azure Arc Agent - Connection state]
 Validate that the azure arc agent is connected
@@ -125,11 +145,12 @@ Successfully created archive C:\temp\6c5a4685-6e32-4b68-aeec-05475f8d6c6f\log-co
 Data collection done . Please upload the file to the Microsoft Workspace.
 ```
 
-#### For base Azure Stack HCI system issues
+#### For base Azure Local system issues
 
 ```powershell
 Invoke-AzsSupportDiagnosticCheck -ProductName BaseSystem
 ```
+
 Here's an example of the output for base system issues:
 
 ```output
@@ -155,21 +176,53 @@ Collecting node data.
 Finished collecting diagnostic information.
 ====[ Validating data from node: HCI-N-1 ]====
 [Pass] [Windows Features - All windows features installed]
-Verify that all features required for Azure Stack HCI are installed.
+Verify that all features required for Azure Local are installed.
 Details: Validation successfull
 
 [Pass] [Validation summary]
 Ensure that no other check has returned a failed state
 Details: Validation successfull
 ```
 
-Afterwards, a comprehensive overview of the different components that are required for properly connected Azure Stack HCI systems is created. Based on this overview, you can either follow the troubleshooting guidance or reach out to Microsoft Support for further assistance.
+Afterwards, a comprehensive overview of the different components that are required for properly connected Azure Local systems is created. Based on this overview, you can either follow troubleshooting guidance or reach out to Microsoft Support for assistance.
+
+To collect data, refer to the following two example scenarios:
+
+#### For automatic data collection
+
+```powershell
+New-AzsSupportDataBundle -Component OS
+==== CUT ==================== CUT =======
+Data collection done C:\temp\Azs.Support\XXXXXXX\SupportDataBundle-XX-XX_XX-XX-XXXX.zip . Please upload the file to the Microsoft Workspace
+```
+
+#### For manual data collection
 
+```powershell
+$ClusterCommands = @()
+$nodeCommands = @('Get-AzureStackHci','Get-AzureStackHCIArcIntegration','Get-ClusteredScheduledTask | fl *','systeminfo.exe')
+$nodeEvents = @('system','application','Microsoft-AzureStack-HCI/Admin')
+$nodeRegistry = @('HKLM:\Cluster\ArcForServers')
+$nodeFolders = @('C:\Windows\Tasks\ArcforServers\','C:\ProgramData\AzureConnectedMachineAgent\Log\')
+
+New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
+-NodeCommands $nodeCommands `
+-NodeEvents $nodeEvents `
+-NodeRegistry $nodeRegistry `
+-NodeFolders $nodeFolders `
+-ComputerName (Get-ClusterNode)
+
+==== CUT ==================== CUT =======
+Data collection done C:\temp\Azs.Support\XXXXXXX\SupportDataBundle-XX-XX_XX-XX-XXXX.zip . Please upload the file to the Microsoft Workspace.
+```
 
+## Questions or Feedback?
 
+Do you have an issue? Would like to share feedback with us about the Azure Local Support Diagnostic Tool?
+We Listen! To submit feedback, use "contact owners" option inside PSGallery.
 
 ## Next steps
 
 For related information, see also:
 
-- [Get support for Azure Stack HCI](get-support.md).
+- [Get support for Azure Local](get-support.md).