Skip to content

Commit 7abf0f0

Browse files
author
Manika Dhiman
committed
Merge branch 'main' of https://github.com/arudell/azure-stack-docs-pr into md-support-tools-pr
2 parents 123f9e3 + 1a9106c commit 7abf0f0

File tree

1 file changed

+57
-23
lines changed

1 file changed

+57
-23
lines changed

azure-local/manage/support-tools.md

Lines changed: 57 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,11 @@ The tool provides:
3333

3434
Before you use the PowerShell module, make sure to:
3535

36-
- Download the Azure Local Support Diagnostic Tool from the [PowerShell Gallery](https://www.powershellgallery.com/packages?q=hci).
36+
- Ensure that you are using an account that has administrative access to the Azure Local nodes.
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 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.
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,14 +47,44 @@ 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 will attempt to automatically update from PowerShell Gallery. You can also update manually using methods below.
58+
59+
Ensure that you have the latest module loaded into the current runspace by removing and importing the module.
60+
```powershell
61+
Remove-Module -Name Microsoft.AzureStack.HCI.CSSTools
62+
Import-Module -Name Microsoft.AzureStack.HCI.CSSTools
63+
```
5964

65+
> [!NOTE]
66+
> 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.
67+
68+
69+
## Using the Azure Local Support Diagnostic Tool
70+
To see a list of available cmdlets within the PowerShell module, use:
71+
```powershell
72+
Get-Command -Module Microsoft.AzureStack.HCI.CSSTools
73+
```
74+
75+
76+
### Perform diagnostic checks
77+
You can perform a diagnostic health check against the system to help detect common issues. The following components are available:
78+
- BaseSystem
79+
- Registration
80+
81+
82+
```powershell
83+
Invoke-AzsSupportDiagnosticCheck -Component <Component>
84+
```
85+
86+
87+
### Collect data for support
6088
To collect data using one of our pre-defined collection sets, run the following command:
6189

6290
```powershell
@@ -83,8 +111,7 @@ New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
83111
-ComputerName @(<computerName1>,<computerName2>)
84112
```
85113

86-
## Example scenario
87-
114+
## Example scenarios
88115
To troubleshoot Azure Local, run the following commands:
89116

90117
### For deployment issues
@@ -101,31 +128,38 @@ Get-AzsSupportEceDeploymentDetails
101128
Get-AzsSupportEceUpdateDetails
102129
```
103130

131+
### For storage issues
132+
```powershell
133+
Start-AzsSupportStorageDiagnostic
134+
```
135+
136+
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).
137+
104138
### For registration issues
105139

106140
```powershell
107-
Invoke-AzsSupportDiagnosticCheck -ProductName Registration
141+
Invoke-AzsSupportDiagnosticCheck -Component Registration
108142
```
109143

110144
Here's an example of output for a registration issue:
111145

112146
```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]
147+
PS C:\temp> Invoke-AzsSupportDiagnosticCheck -Component Registration
148+
Starting known issue check for Azure Stack HCI: Registration.
149+
Starting Azure Stack HCI base system validation.
150+
Gathering information from all clustered nodes.
151+
We are preparing to collect diagnostic information from your environment
152+
We started the diagnostic data collection! This might take some time.
153+
Finished collecting diagnostic information.
154+
====[ Validating registration state on node: HCI-N-1 ]====
155+
[Pass] [Azure Stack HCI - General registration state]
122156
Validate that the cluster is registered
123157
Details: Validation successfull
124158
125159
[Fail] [Azure Stack HCI - Azure Connection state]
126160
Validate that the cluster is in a connected state
127161
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.
162+
Documentation: https://learn.microsoft.com/azure-stack/hci/deploy/troubleshoot-hci-registration.
129163
130164
[Pass] [Azure Arc Agent - Connection state]
131165
Validate that the azure arc agent is connected
@@ -164,13 +198,13 @@ Data collection done . Please upload the file to the Microsoft Workspace.
164198
### For base Azure Local system issues
165199

166200
```powershell
167-
Invoke-AzsSupportDiagnosticCheck -ProductName BaseSystem
201+
Invoke-AzsSupportDiagnosticCheck -Component BaseSystem
168202
```
169203

170204
Here's an example of the output for base system issues:
171205

172206
```output
173-
PS C:\temp> Invoke-AzsSupportDiagnosticCheck -ProductName BaseSystem
207+
PS C:\temp> Invoke-AzsSupportDiagnosticCheck -Component BaseSystem
174208
Starting known issue check for Azure Stack HCI: BaseSystem.
175209
Gathering information from all clustered nodes.
176210
We are preparing to collect diagnostic information from your environment

0 commit comments

Comments
 (0)