Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Applies to: Azure Stack HCI, version 22H2
This article provides information to download and use the Azure Stack HCI 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 Azure Support for assistance.
The Azure Stack HCI Support Diagnostic Tool uses simple commands to identify issues without expert product knowledge.
The tool provides:
Easy installation and updates: Install and update natively using PowerShell Gallery, without extra requirements.
Diagnostic checks: Provides diagnostic checks based on common issues, incidents, and telemetry data.
Automatic data collection: Automatically collects important data to provide to Azure Support.
Regular updates: Updates with new checks and useful commands to manage, troubleshoot, and diagnose issues on Azure Stack HCI.
Before you use the PowerShell module, make sure to:
Download the Azure Stack HCI Support Diagnostic tool from the PowerShell Gallery.
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.
Install the module on each node of the Azure Stack HCI system.
Run PowerShell as an administrator and then run the following commands:
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:
Invoke-AzsSupportDiagnosticCheck -ProductName <BaseSystem, Registration>
Run all diagnostic checks by pressing CTRL+SPACE after the parameter ProductName.
To collect data using one of our pre-defined collection sets, run the following command:
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:
$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, run the following commands:
To generate a detailed report about your deployment, including successfully executed steps, skipped steps, and error details, run the following command:
Get-AzsSupportEceDeploymentDetails
Get-AzsSupportEceUpdateDetails
Invoke-AzsSupportDiagnosticCheck -ProductName Registration
Here's an example of output for a registration issue:
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]
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://docs.azure.cn/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.
Invoke-AzsSupportDiagnosticCheck -ProductName BaseSystem
Here's an example of the output for base system issues:
PS C:\temp> Invoke-AzsSupportDiagnosticCheck -ProductName 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 Stack HCI 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 troubleshooting guidance or reach out to Azure Support for assistance.
To collect data, refer to the following two example scenarios:
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
$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.