Skip to content

Commit 083c381

Browse files
committed
update instructions to use support tool
1 parent c0ca692 commit 083c381

File tree

1 file changed

+42
-14
lines changed

1 file changed

+42
-14
lines changed

azure-local/manage/support-tools.md

Lines changed: 42 additions & 14 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/en-us/powershell/module/microsoft.powershell.core/enable-psremoting?view=powershell-5.1&preserve-view=true) 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,41 @@ To install the tool, run the following command:
4947
Install-Module –Name Microsoft.AzureStack.HCI.CSSTools
5048
```
5149

50+
If you already have the module installed, you can update using the following cmdlet:
51+
52+
```powershell
53+
Update-Module -Name Microsoft.AzureStack.HCI.CSSTools
54+
```
55+
56+
Ensure that you have the latest module loaded into the current runspace by removing and importing the module.
57+
```powershell
58+
Remove-Module -Name Microsoft.AzureStack.HCI.CSSTools
59+
Import-Module -Name Microsoft.AzureStack.HCI.CSSTools
60+
```
61+
62+
> [!NOTE]
63+
> 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.
64+
65+
66+
## Using the Azure Local Support Diagnostic Tool
67+
To see a list of available cmdlets within the PowerShell module, use:
68+
```powershell
69+
Get-Command -Module Microsoft.AzureStack.HCI.CSSTools
70+
```
71+
72+
73+
### Perform diagnostic checks
5274
To list all available diagnostic checks, run the following command:
5375

76+
5477
```powershell
5578
Invoke-AzsSupportDiagnosticCheck –ProductName <BaseSystem, Registration>
5679
```
5780

5881
Run all diagnostic checks by pressing `CTRL+SPACE` after the parameter `ProductName`.
5982

83+
84+
### Collect data for support
6085
To collect data using one of our pre-defined collection sets, run the following command:
6186

6287
```powershell
@@ -83,7 +108,7 @@ New-AzsSupportDataBundle -ClusterCommands $clusterCommands `
83108
-ComputerName @(<computerName1>,<computerName2>)
84109
```
85110

86-
## Example scenario
111+
## Example scenarios
87112

88113
To troubleshoot Azure Local, run the following commands:
89114

@@ -101,6 +126,9 @@ Get-AzsSupportEceDeploymentDetails
101126
Get-AzsSupportEceUpdateDetails
102127
```
103128

129+
### For storage issues
130+
Refer to TODO.
131+
104132
### For registration issues
105133

106134
```powershell
@@ -111,14 +139,14 @@ Here's an example of output for a registration issue:
111139

112140
```output
113141
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]
142+
Starting known issue check for Azure Stack HCI: Registration.
143+
Starting Azure Stack HCI base system validation.
144+
Gathering information from all clustered nodes.
145+
We are preparing to collect diagnostic information from your environment
146+
We started the diagnostic data collection! This might take some time.
147+
Finished collecting diagnostic information.
148+
====[ Validating registration state on node: HCI-N-1 ]====
149+
[Pass] [Azure Stack HCI - General registration state]
122150
Validate that the cluster is registered
123151
Details: Validation successfull
124152

0 commit comments

Comments
 (0)