Skip to content

Commit 9cf6bc7

Browse files
Merge pull request #3643 from MicrosoftDocs/main638824068995623400sync_temp
For protected branch, push strategy should use PR and merge to target branch method to work around git push error
2 parents 68f8c6d + 5ae0b5b commit 9cf6bc7

File tree

4 files changed

+104
-55
lines changed

4 files changed

+104
-55
lines changed

azure-local/manage/support-tools.md

Lines changed: 84 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: This article provides guidance on the Support Diagnostic Tool for A
44
author: alkohli
55
ms.author: alkohli
66
ms.topic: how-to
7-
ms.date: 04/09/2025
7+
ms.date: 05/08/2025
88
---
99

1010
# Use the Support Diagnostic Tool to troubleshoot Azure Local issues
@@ -31,15 +31,13 @@ The tool provides:
3131

3232
## Prerequisites
3333

34-
Before you use the PowerShell module, make sure to:
34+
Before you use the PowerShell module:
3535

36-
- Download the Azure Local Support Diagnostic Tool from the [PowerShell Gallery](https://www.powershellgallery.com/packages?q=hci).
36+
- Make sure to use an account that has administrative access to the Azure Local machines.
3737

38-
- 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).
38+
- 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.
3939

40-
- 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).
41-
42-
## Install and use the Azure Local Support Diagnostic Tool
40+
## Install or update the Azure Local Support Diagnostic Tool
4341

4442
Run PowerShell as an administrator and then run the following commands:
4543

@@ -49,41 +47,77 @@ To install the tool, run the following command:
4947
Install-Module –Name Microsoft.AzureStack.HCI.CSSTools
5048
```
5149

52-
To list all available diagnostic checks, run the following command:
50+
If you already have the module installed, you can update using the following cmdlet:
5351

5452
```powershell
55-
Invoke-AzsSupportDiagnosticCheck –ProductName <BaseSystem, Registration>
53+
Update-Module -Name Microsoft.AzureStack.HCI.CSSTools
5654
```
5755

58-
Run all diagnostic checks by pressing `CTRL+SPACE` after the parameter `ProductName`.
56+
>[!NOTE]
57+
>When you import the module, it attempts to automatically update from PowerShell gallery. You can also update manually using methods below.
5958
60-
To collect data using one of our pre-defined collection sets, run the following command:
59+
Ensure that you have the latest module loaded into the current runspace by removing and importing the module.
6160

6261
```powershell
63-
New-AzsSupportDataBundle –Component <Component>
62+
Remove-Module -Name Microsoft.AzureStack.HCI.CSSTools
63+
Import-Module -Name Microsoft.AzureStack.HCI.CSSTools
6464
```
6565

66-
To check all data collection sets, press `CTRL+SPACE` after the parameter `Component`.
66+
>[!NOTE]
67+
>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.
68+
69+
## Use the Azure Local Support Diagnostic Tool
70+
71+
This section provides different cmdlets for using the Azure Local Support Diagnostic Tool.
72+
73+
### View available cmdlets
6774

68-
To collect your own dataset, run the following command:
75+
To see a list of available cmdlets within the PowerShell module, run the following cmdlet:
6976

7077
```powershell
71-
$ClusterCommands = @(<clusterCommand1>,<clusterCommand2>)
72-
$nodeCommands = @(<nodeCommand1>,<nodeCommand2>)
73-
$nodeEvents = @(<eventLogName1>,<eventLogName2>)
74-
$nodeRegistry = @(<registryPath1>,<registryPath2>)
75-
$nodeFolders = @(<folderPath1>,<folderPath2>)
78+
Get-Command -Module Microsoft.AzureStack.HCI.CSSTools
79+
```
7680

81+
### Perform diagnostic checks
7782

78-
New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
79-
-NodeCommands $nodeCommands `
80-
-NodeEvents $nodeEvents `
81-
-NodeRegistry $nodeRegistry `
82-
-NodeFolders $nodeFolders `
83-
-ComputerName @(<computerName1>,<computerName2>)
83+
You can perform a diagnostic health check against the system to help detect common issues. The following components are available:
84+
85+
- BaseSystem
86+
- Registration
87+
88+
```powershell
89+
Invoke-AzsSupportDiagnosticCheck -Component <Component>
8490
```
8591

86-
## Example scenario
92+
### Collect data for support
93+
94+
- To collect data using one of our predefined collection sets, run the following command:
95+
96+
```powershell
97+
New-AzsSupportDataBundle –Component <Component>
98+
```
99+
100+
- To check all data collection sets, press `CTRL+SPACE` after the parameter `Component`.
101+
102+
- To collect your own dataset, run the following command:
103+
104+
```powershell
105+
$ClusterCommands = @(<clusterCommand1>,<clusterCommand2>)
106+
$nodeCommands = @(<nodeCommand1>,<nodeCommand2>)
107+
$nodeEvents = @(<eventLogName1>,<eventLogName2>)
108+
$nodeRegistry = @(<registryPath1>,<registryPath2>)
109+
$nodeFolders = @(<folderPath1>,<folderPath2>)
110+
111+
112+
New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
113+
-NodeCommands $nodeCommands `
114+
-NodeEvents $nodeEvents `
115+
-NodeRegistry $nodeRegistry `
116+
-NodeFolders $nodeFolders `
117+
-ComputerName @(<computerName1>,<computerName2>)
118+
```
119+
120+
## Example scenarios
87121
88122
To troubleshoot Azure Local, run the following commands:
89123
@@ -101,31 +135,39 @@ Get-AzsSupportEceDeploymentDetails
101135
Get-AzsSupportEceUpdateDetails
102136
```
103137

138+
### For storage issues
139+
140+
```powershell
141+
Start-AzsSupportStorageDiagnostic
142+
```
143+
144+
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).
145+
104146
### For registration issues
105147

106148
```powershell
107-
Invoke-AzsSupportDiagnosticCheck -ProductName Registration
149+
Invoke-AzsSupportDiagnosticCheck -Component Registration
108150
```
109151

110-
Here's an example of output for a registration issue:
152+
Here's a sample output for a registration issue:
111153

112154
```output
113-
PS C:\temp> Invoke-AzsSupportDiagnosticCheck -ProductName Registration
114-
Starting known issue check for Azure Stack HCI: Registration.
115-
Starting Azure Stack HCI base system validation.
116-
Gathering information from all clustered nodes.
117-
We are preparing to collect diagnostic information from your environment
118-
We started the diagnostic data collection! This might take some time.
119-
Finished collecting diagnostic information.
120-
====[ Validating registration state on node: HCI-N-1 ]====
121-
[Pass] [Azure Stack HCI - General registration state]
155+
PS C:\temp> Invoke-AzsSupportDiagnosticCheck -Component Registration
156+
Starting known issue check for Azure Stack HCI: Registration.
157+
Starting Azure Stack HCI base system validation.
158+
Gathering information from all clustered nodes.
159+
We are preparing to collect diagnostic information from your environment
160+
We started the diagnostic data collection! This might take some time.
161+
Finished collecting diagnostic information.
162+
====[ Validating registration state on node: HCI-N-1 ]====
163+
[Pass] [Azure Stack HCI - General registration state]
122164
Validate that the cluster is registered
123165
Details: Validation successfull
124166
125167
[Fail] [Azure Stack HCI - Azure Connection state]
126168
Validate that the cluster is in a connected state
127169
Details: This Azure Stack HCI node does not seem to be connected to azure. Ensure that this node is in a connected state.
128-
Documentation: https://learn.microsoft.com/en-us/azure-stack/hci/deploy/troubleshoot-hci-registration.
170+
Documentation: https://learn.microsoft.com/azure-stack/hci/deploy/troubleshoot-hci-registration.
129171
130172
[Pass] [Azure Arc Agent - Connection state]
131173
Validate that the azure arc agent is connected
@@ -144,9 +186,7 @@ Validate that all arc agent checks are passed
144186
Details: Validation successfull
145187
146188
[Fail] [Validation summary]
147-
148189
Details: At least one node reported an invalid registration state.
149-
150190
We will collect log information from your envirorment.
151191
Creating local storage container for diagnostic data.
152192
Gathering cluster data ... this might take a while.
@@ -164,13 +204,13 @@ Data collection done . Please upload the file to the Microsoft Workspace.
164204
### For base Azure Local system issues
165205

166206
```powershell
167-
Invoke-AzsSupportDiagnosticCheck -ProductName BaseSystem
207+
Invoke-AzsSupportDiagnosticCheck -Component BaseSystem
168208
```
169209

170-
Here's an example of the output for base system issues:
210+
Here's a sample output for base system issues:
171211

172212
```output
173-
PS C:\temp> Invoke-AzsSupportDiagnosticCheck -ProductName BaseSystem
213+
PS C:\temp> Invoke-AzsSupportDiagnosticCheck -Component BaseSystem
174214
Starting known issue check for Azure Stack HCI: BaseSystem.
175215
Gathering information from all clustered nodes.
176216
We are preparing to collect diagnostic information from your environment
@@ -232,7 +272,7 @@ New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
232272
Data collection done C:\temp\Azs.Support\XXXXXXX\SupportDataBundle-XX-XX_XX-XX-XXXX.zip . Please upload the file to the Microsoft Workspace.
233273
```
234274

235-
## Questions or Feedback?
275+
## Questions or feedback?
236276

237277
Do you have an issue? Would you like to share feedback with us about the Azure Local Support Diagnostic Tool?
238278
We Listen! To submit feedback, contact [[email protected]](mailto:[email protected]).
-1.35 KB
Loading

azure-local/release-information-23h2.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,16 @@ The following diagram illustrates the release trains, their associated feature b
3232

3333
:::image type="content" source="./media/release-information-23h2/release-trains-supported-update-paths.png" alt-text="Diagram illustrating Azure Local release trains with supported update paths."lightbox="./media/release-information-23h2/release-trains-supported-update-paths.png":::
3434

35-
#### Move to the next release train
35+
## Feature release availability timing
36+
37+
Feature release availability dates depend on the model and SKU of the servers in your cluster.
38+
39+
If your cluster supports [Solution Builder Extension software updates](./update/solution-builder-extension.md), you'll receive feature release updates (e.g., 2504 or 2510) after your hardware vendor completes their validation and confirms the release is ready. This process typically takes a few weeks following the Microsoft release and varies by hardware vendor.
40+
41+
> [!NOTE]
42+
> The validation process ensures a reliable update experience for your cluster. It minimizes potential issues and reduces the overall number of updates you need to manage for Azure Local.
43+
44+
### Move to the next release train
3645

3746
Follow these guidelines to skip releases with the same release train as you move to the next release train:
3847

@@ -45,7 +54,7 @@ Follow these guidelines to skip releases with the same release train as you move
4554

4655
<!-- Update the 2503 train to 2504 or create a new deployment.-->
4756

48-
#### Move within the same release train
57+
### Move within the same release train
4958

5059
Follow these guidelines to update to each release within your current release train:
5160

azure-local/update/about-updates-23h2.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,22 +48,22 @@ This new approach:
4848

4949
## Lifecycle cadence
5050

51-
The Azure Local follows the [Modern Lifecycle policy](/lifecycle/policies/modern). The Modern Lifecycle policy defines the products and services that are continuously serviced and supported. To stay current with this policy, you must stay within six months of the most recent release. To learn more about the support windows, see [Azure Local release information](/azure-stack/hci/release-information-23h2).
51+
Azure Local follows the [Modern Lifecycle policy](/lifecycle/policies/modern), which defines products and services that are continuously serviced and supported. To remain compliant with this policy, you must stay within six months of the most recent release. For more information on support windows, see [Azure Local release information](../release-information-23h2.md).
5252

53-
Microsoft might release the following types of updates for the Azure Local:
53+
Microsoft might release the following types of updates for Azure Local:
5454

5555
|Update Type |Typical Cadence |Description |
5656
|------------|-----------------|------------|
57-
|Monthly Updates | Monthly |Monthly updates primarily contain quality and reliability improvements. They might include OS Latest Cumulative Updates ¹. Some updates require host system reboots, while others don't. |
58-
|Baseline Updates |Quarterly |Baseline updates include new features and improvements. They typically require host system reboots and might take longer. |
59-
|Hotfixes | As needed | Hotfixes address blocking issues that could prevent regular monthly or baseline updates. To fix critical or security issues, hotfixes might be released sooner than monthly. |
60-
|Solution Builder Extension | As needed | Solution Builder Extension² provides driver, firmware, and other partner content specific to the system solution used. They might require host system reboots. |
57+
|Cumulative Updates | Monthly | Cumulative updates primarily include quality and reliability improvements. They might also include OS Latest Cumulative Updates ¹. Some updates require host system reboots, while others do not. |
58+
|Feature Updates |Semi-annually|Feature updates introduce new features and improvements. They typically require host system reboots and might take longer to apply. |
59+
|Hotfixes | As needed | Hotfixes address critical issues that could block regular monthly or semi-annual updates. These updates might be released sooner than the monthly cadence to resolve urgent security or functionality issues. |
60+
|Solution Builder Extension | As needed | Solution Builder Extension² provides drivers, firmware, and other partner-specific content. These updates might require host system reboots. |
6161

62-
¹ Quality updates released based on packages that contain monthly updates. These updates supersede the previous month's updates and contain both security and non-security changes.
62+
¹ Quality updates released based on packages that contain monthly updates. These updates supersede the previous month's updates and include both security and non-security changes.
6363

64-
² The Original Equipment Manufacturer determines the frequency of Solution Builder Extension updates.
64+
² The Original Equipment Manufacturer determines the frequency of Solution Builder Extension updates. These updates often align with Azure Local feature releases, allowing customers to install a combined update.
6565

66-
Sometimes you might see updates to the latest patch level of your current baseline. If a new baseline is available, you might see the baseline update itself or the latest patch level of the baseline. Your system must stay within six months of the most recent baseline to consider it supported. For more information and a visualization of supported releases, see [About Azure Local releases](../release-information-23h2.md#about-azure-local-releases).
66+
Sometimes you might see updates to the latest patch level of your current feature. If a new feature is available, you might see the feature update itself or the latest patch level of the feature. Your system must stay within six months of the most recent feature to consider it supported. For more information and a visualization of supported releases, see [About Azure Local releases](../release-information-23h2.md#about-azure-local-releases).
6767

6868
The next sections provide an overview of components, along with methods and interfaces for updating your solution.
6969

0 commit comments

Comments
 (0)