Pulled in a PM's PR for updates to the Support tool

Author: Manika Dhiman

azure-local/manage/support-tools.md

@@ -4,7 +4,7 @@ description: This article provides guidance on the Support Diagnostic Tool for A
 author: alkohli
 ms.author: alkohli
 ms.topic: how-to
-ms.date: 04/09/2025
+ms.date: 05/08/2025
 ---
 
 # Use the Support Diagnostic Tool to troubleshoot Azure Local issues
@@ -31,13 +31,13 @@ The tool provides:
 
 ## Prerequisites
 
-Before you use the PowerShell module, make sure to:
+Before you use the PowerShell module:
 
-- Ensure that you are using an account that has administrative access to the Azure Local nodes.
+- Ensure that you are using an account that has administrative access to the Azure Local machines.
 
-- Ensure that PSRemoting has been configured on the Azure Local nodes. Run `Enable-PSRemoting` to configure remote PowerShell. For more information, see the [Enable-PSRemoting](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/enable-psremoting) reference documentation.
+- Ensure that PSRemoting has been configured on the Azure Local machines. Run `Enable-PSRemoting` to configure remote PowerShell. For more information, see the [Enable-PSRemoting](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/enable-psremoting) reference documentation.
 
-## Install or Update the Azure Local Support Diagnostic Tool
+## Install or update the Azure Local Support Diagnostic Tool
 
 Run PowerShell as an administrator and then run the following commands:
 
@@ -53,65 +53,72 @@ If you already have the module installed, you can update using the following cmd
 Update-Module -Name Microsoft.AzureStack.HCI.CSSTools
 ```
 
-    > [!NOTE]
-    > When you import the module, it will attempt to automatically update from PowerShell Gallery. You can also update manually using methods below.
+>[!NOTE]
+>When you import the module, it will attempt to automatically update from PowerShell Gallery. You can also update manually using methods below.
 
 Ensure that you have the latest module loaded into the current runspace by removing and importing the module.
+
 ```powershell
 Remove-Module -Name Microsoft.AzureStack.HCI.CSSTools
 Import-Module -Name Microsoft.AzureStack.HCI.CSSTools
 ```
 
-    > [!NOTE]
-    > Ensure all the nodes within Azure Local have been updated to use the same version. Remove existing PSSessions to ensure the correct module version is loaded into the remote runspace.
+>[!NOTE]
+>Ensure all machines within Azure Local have been updated to use the same version. Remove existing PSSessions to ensure the correct module version is loaded into the remote runspace.
+
+## Use the Azure Local Support Diagnostic Tool
+
+This section provides different cmdlets for using the Azure Local Support Diagnostic Tool.
 
+### View available cmdlets
+
+To see a list of available cmdlets within the PowerShell module, run the following cmdlet:
 
-## Using the Azure Local Support Diagnostic Tool
-To see a list of available cmdlets within the PowerShell module, use:
 ```powershell
 Get-Command -Module Microsoft.AzureStack.HCI.CSSTools
 ```
 
-
 ### Perform diagnostic checks
+
 You can perform a diagnostic health check against the system to help detect common issues. The following components are available:
+
 - BaseSystem
 - Registration
 
-
 ```powershell
 Invoke-AzsSupportDiagnosticCheck -Component <Component>
 ```
 
-
 ### Collect data for support
-To collect data using one of our pre-defined collection sets, run the following command:
 
-```powershell
-New-AzsSupportDataBundle –Component <Component>
-```
+- To collect data using one of our predefined collection sets, run the following command:
 
-To check all data collection sets, press `CTRL+SPACE` after the parameter `Component`.
+    ```powershell
+    New-AzsSupportDataBundle –Component <Component>
+    ```
 
-To collect your own dataset, run the following command:
+- To check all data collection sets, press `CTRL+SPACE` after the parameter `Component`.
 
-```powershell
-$ClusterCommands = @(<clusterCommand1>,<clusterCommand2>)
-$nodeCommands = @(<nodeCommand1>,<nodeCommand2>)
-$nodeEvents = @(<eventLogName1>,<eventLogName2>)
-$nodeRegistry = @(<registryPath1>,<registryPath2>)
-$nodeFolders = @(<folderPath1>,<folderPath2>)
+- 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>)
-```
+
+    New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
+    -NodeCommands $nodeCommands `
+    -NodeEvents $nodeEvents `
+    -NodeRegistry $nodeRegistry `
+    -NodeFolders $nodeFolders `
+    -ComputerName @(<computerName1>,<computerName2>)
+    ```
 
 ## Example scenarios
+
 To troubleshoot Azure Local, run the following commands:
 
 ### For deployment issues
@@ -129,112 +136,113 @@ Get-AzsSupportEceUpdateDetails
 ```
 
 ### For storage issues
+
 ```powershell
 Start-AzsSupportStorageDiagnostic
 ```
 
-For full guidance on troubleshooting storage related issues, refer to [Troubleshooting-Storage-With-Support-Diagnostics-Tool](https://github.com/Azure/AzureLocal-Supportability/blob/main/TSG/Storage/Troubleshooting-Storage-With-Support-Diagnostics-Tool.md).
+    For complete guidance on troubleshooting storage related issues, refer to [Troubleshooting-Storage-With-Support-Diagnostics-Tool](https://github.com/Azure/AzureLocal-Supportability/blob/main/TSG/Storage/Troubleshooting-Storage-With-Support-Diagnostics-Tool.md).
 
 ### For registration issues
 
 ```powershell
 Invoke-AzsSupportDiagnosticCheck -Component Registration
 ```
 
-Here's an example of output for a registration issue:
-
-```output
-PS C:\temp> Invoke-AzsSupportDiagnosticCheck -Component Registration
-Starting known issue check for Azure Stack HCI: Registration.
-Starting Azure Stack HCI base system validation.
-Gathering information from all clustered nodes.
-We are preparing to collect diagnostic information from your environment
-We started the diagnostic data collection! This might take some time.
-Finished collecting diagnostic information.
-====[ Validating registration state on node: HCI-N-1 ]====
-[Pass] [Azure Stack HCI - General registration state]
-Validate that the cluster is registered
-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/azure-stack/hci/deploy/troubleshoot-hci-registration.
-
-[Pass] [Azure Arc Agent - Connection state]
-Validate that the azure arc agent is connected
-Details: Validation successfull
-
-[Pass] [Azure Arc Agent - Service state]
-Validate that all azure arc services are running
-Details: Validation successfull
-
-[Pass] [Azure Arc Agent - Heartbeat state]
-Validate that the azure arc agent has sent out a heartbeat at least a day ago
-Details: Validation successfull
-
-[Pass] [Azure Stack HCI - Arc Agent onboarded]
-Validate that all arc agent checks are passed
-Details: Validation successfull
-
-[Fail] [Validation summary]
-
-Details: At least one node reported an invalid registration state.
-
-We will collect log information from your envirorment.
-Creating local storage container for diagnostic data.
-Gathering cluster data ... this might take a while.
-Cluster data collection complete.
-We are preparing to collect diagnostic information from your environment
-We started the diagnostic data collection! This might take some time.
-Waiting for all diagnostic output to be generated and compressed ... this might take a while.
-Finished collecting diagnostic information.
-Starting copy of items ... this might take a while.
-All items copied.
-Successfully created archive C:\temp\6c5a4685-6e32-4b68-aeec-05475f8d6c6f\log-collection-RegistrationInformation07-22_06-03-2024.zip. Removing raw data C:\temp\6c5a4685-6e32-4b68-aeec-05475f8d6c6f\container.
-Data collection done . Please upload the file to the Microsoft Workspace.
-```
+    Here's a sample output for a registration issue:
+
+    ```output
+    PS C:\temp> Invoke-AzsSupportDiagnosticCheck -Component Registration
+    Starting known issue check for Azure Stack HCI: Registration.
+    Starting Azure Stack HCI base system validation.
+    Gathering information from all clustered nodes.
+    We are preparing to collect diagnostic information from your environment
+    We started the diagnostic data collection! This might take some time.
+    Finished collecting diagnostic information.
+    ====[ Validating registration state on node: HCI-N-1 ]====
+    [Pass] [Azure Stack HCI - General registration state]
+    Validate that the cluster is registered
+    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/azure-stack/hci/deploy/troubleshoot-hci-registration.
+
+    [Pass] [Azure Arc Agent - Connection state]
+    Validate that the azure arc agent is connected
+    Details: Validation successfull
+
+    [Pass] [Azure Arc Agent - Service state]
+    Validate that all azure arc services are running
+    Details: Validation successfull
+
+    [Pass] [Azure Arc Agent - Heartbeat state]
+    Validate that the azure arc agent has sent out a heartbeat at least a day ago
+    Details: Validation successfull
+
+    [Pass] [Azure Stack HCI - Arc Agent onboarded]
+    Validate that all arc agent checks are passed
+    Details: Validation successfull
+
+    [Fail] [Validation summary]
+
+    Details: At least one node reported an invalid registration state.
+
+    We will collect log information from your envirorment.
+    Creating local storage container for diagnostic data.
+    Gathering cluster data ... this might take a while.
+    Cluster data collection complete.
+    We are preparing to collect diagnostic information from your environment
+    We started the diagnostic data collection! This might take some time.
+    Waiting for all diagnostic output to be generated and compressed ... this might take a while.
+    Finished collecting diagnostic information.
+    Starting copy of items ... this might take a while.
+    All items copied.
+    Successfully created archive C:\temp\6c5a4685-6e32-4b68-aeec-05475f8d6c6f\log-collection-RegistrationInformation07-22_06-03-2024.zip. Removing raw data C:\temp\6c5a4685-6e32-4b68-aeec-05475f8d6c6f\container.
+    Data collection done . Please upload the file to the Microsoft Workspace.
+    ```
 
 ### For base Azure Local system issues
 
 ```powershell
 Invoke-AzsSupportDiagnosticCheck -Component BaseSystem
 ```
 
-Here's an example of the output for base system issues:
-
-```output
-PS C:\temp> Invoke-AzsSupportDiagnosticCheck -Component BaseSystem
-Starting known issue check for Azure Stack HCI: BaseSystem.
-Gathering information from all clustered nodes.
-We are preparing to collect diagnostic information from your environment
-We started the diagnostic data collection! This might take some time.
-Starting to validate cluster settings.
-[Pass] [Failover Clustering - Cluster validation report contains no errors]
-Validate that there are no critical errors in the cluster validation report
-Details: Validation successfull
-
-[Pass] [Failover Clustering - Cluster Networks have redundancy]
-Validate that we have redundancy in clustered networks
-Details: Validation successfull
-
-[Pass] [Failover Clustering - Validation Summary]
-Validate that there are no critical issues in our cluster validation report.
-Details: Validation successfull
-
-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 Local are installed.
-Details: Validation successfull
-
-[Pass] [Validation summary]
-Ensure that no other check has returned a failed state
-Details: Validation successfull
+    Here's a sample output for base system issues:
+
+    ```output
+    PS C:\temp> Invoke-AzsSupportDiagnosticCheck -Component BaseSystem
+    Starting known issue check for Azure Stack HCI: BaseSystem.
+    Gathering information from all clustered nodes.
+    We are preparing to collect diagnostic information from your environment
+    We started the diagnostic data collection! This might take some time.
+    Starting to validate cluster settings.
+    [Pass] [Failover Clustering - Cluster validation report contains no errors]
+    Validate that there are no critical errors in the cluster validation report
+    Details: Validation successfull
+
+    [Pass] [Failover Clustering - Cluster Networks have redundancy]
+    Validate that we have redundancy in clustered networks
+    Details: Validation successfull
+
+    [Pass] [Failover Clustering - Validation Summary]
+    Validate that there are no critical issues in our cluster validation report.
+    Details: Validation successfull
+
+    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 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 Local systems is created. Based on this overview, you can either follow troubleshooting guidance or reach out to Microsoft Support for 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:
 
@@ -266,7 +274,7 @@ New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
 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?
+## Questions or feedback?
 
 Do you have an issue? Would you like to share feedback with us about the Azure Local Support Diagnostic Tool?
 We Listen! To submit feedback, contact [[email protected]](mailto:[email protected]).