Merge pull request #17898 from ManikaDhiman/md-support-tools-pr

Updates to Support tool doc pulled in from PM's PR

Author: denrea

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,15 +31,13 @@ The tool provides:
 
 ## Prerequisites
 
-Before you use the PowerShell module, make sure to:
+Before you use the PowerShell module:
 
-- Download the Azure Local Support Diagnostic Tool from the [PowerShell Gallery](https://www.powershellgallery.com/packages?q=hci).
+- Make sure to use an account that has administrative access to the Azure Local machines.
 
-- Import the module into an elevated PowerShell window using an account with administrator privileges on the local system. For more information, see [Importing a PowerShell Module](/powershell/scripting/developer/module/importing-a-powershell-module).
+- Ensure that PSRemoting is configured on the Azure Local machines. Run `Enable-PSRemoting` to configure remote PowerShell. For more information, see the [Enable-PSRemoting](/powershell/module/microsoft.powershell.core/enable-psremoting) reference documentation.
 
-- Install the module on each node of the Azure Local system. For information about connecting to a node, see [Enable RDP](.././deploy/deploy-via-portal.md#enable-rdp).
-
-## Install and use 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:
 
@@ -49,41 +47,77 @@ To install the tool, run the following command:
 Install-Module –Name Microsoft.AzureStack.HCI.CSSTools
 ```
 
-To list all available diagnostic checks, run the following command:
+If you already have the module installed, you can update using the following cmdlet:
 
 ```powershell
-Invoke-AzsSupportDiagnosticCheck –ProductName <BaseSystem, Registration>
+Update-Module -Name Microsoft.AzureStack.HCI.CSSTools
 ```
 
-Run all diagnostic checks by pressing `CTRL+SPACE` after the parameter `ProductName`.
+>[!NOTE]
+>When you import the module, it attempts to automatically update from PowerShell gallery. You can also update manually using methods below.
 
-To collect data using one of our pre-defined collection sets, run the following command:
+Ensure that you have the latest module loaded into the current runspace by removing and importing the module.
 
 ```powershell
-New-AzsSupportDataBundle –Component <Component>
+Remove-Module -Name Microsoft.AzureStack.HCI.CSSTools
+Import-Module -Name Microsoft.AzureStack.HCI.CSSTools
 ```
 
-To check all data collection sets, press `CTRL+SPACE` after the parameter `Component`.
+>[!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 collect your own dataset, run the following command:
+To see a list of available cmdlets within the PowerShell module, run the following cmdlet:
 
 ```powershell
-$ClusterCommands = @(<clusterCommand1>,<clusterCommand2>)
-$nodeCommands = @(<nodeCommand1>,<nodeCommand2>)
-$nodeEvents = @(<eventLogName1>,<eventLogName2>)
-$nodeRegistry = @(<registryPath1>,<registryPath2>)
-$nodeFolders = @(<folderPath1>,<folderPath2>)
+Get-Command -Module Microsoft.AzureStack.HCI.CSSTools
+```
 
+### Perform diagnostic checks
 
-New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
--NodeCommands $nodeCommands `
--NodeEvents $nodeEvents `
--NodeRegistry $nodeRegistry `
--NodeFolders $nodeFolders `
--ComputerName @(<computerName1>,<computerName2>)
+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>
 ```
 
-## Example scenario
+### Collect data for support
+
+- To collect data using one of our predefined 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>)
+    ```
+
+## Example scenarios
 
 To troubleshoot Azure Local, run the following commands:
 
@@ -101,31 +135,39 @@ Get-AzsSupportEceDeploymentDetails
 Get-AzsSupportEceUpdateDetails
 ```
 
+### For storage issues
+
+```powershell
+Start-AzsSupportStorageDiagnostic
+```
+
+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 -ProductName Registration
+Invoke-AzsSupportDiagnosticCheck -Component Registration
 ```
 
-Here's an example of output for a registration issue:
+Here's a sample output for a registration issue:
 
 ```output
-PS C:\temp> Invoke-AzsSupportDiagnosticCheck -ProductName 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]                                                                                                                   
+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/en-us/azure-stack/hci/deploy/troubleshoot-hci-registration.
+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
@@ -144,9 +186,7 @@ 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.
@@ -164,13 +204,13 @@ Data collection done . Please upload the file to the Microsoft Workspace.
 ### For base Azure Local system issues
 
 ```powershell
-Invoke-AzsSupportDiagnosticCheck -ProductName BaseSystem
+Invoke-AzsSupportDiagnosticCheck -Component BaseSystem
 ```
 
-Here's an example of the output for base system issues:
+Here's a sample output for base system issues:
 
 ```output
-PS C:\temp> Invoke-AzsSupportDiagnosticCheck -ProductName BaseSystem
+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
@@ -232,7 +272,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]).