You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> This article is for Azure Stack HCI version 22H2 and earlier only. For a list of benefits associated with version 23H2 and later, see [Azure verification for VMs](../deploy/azure-verification.md).
21
+
> This article is only for Azure Stack HCI version 22H2 and earlier. For a list of benefits associated with version 23H2 and later, see [Azure verification for VMs](../deploy/azure-verification.md).
22
22
23
23
Microsoft Azure offers a range of differentiated workloads and capabilities that are designed to run only on Azure. Azure Stack HCI extends many of the same benefits you get from Azure, while running on the same familiar and high-performance on-premises or edge environments.
24
24
25
-
*Azure Benefits* makes it possible for supported Azure-exclusive workloads to work outside of the cloud. You can enable Azure Benefits on Azure Stack HCI at no extra cost. If you have Windows Server workloads, we recommend turning it on.
25
+
*Azure Benefits* makes it possible for supported Azure-exclusive workloads to work outside of the cloud. You can enable Azure Benefits on Azure Stack HCI at no extra cost. If you have Windows Server workloads, we recommend turning it on.
26
26
27
27
Take a few minutes to watch the introductory video on Azure Benefits:
28
28
@@ -56,12 +56,12 @@ Turning on Azure Benefits starts the service running on your Azure Stack HCI clu
56
56
> [!NOTE]
57
57
> Certificates are renewed every time the Azure Stack HCI cluster syncs with Azure, and each renewal is valid for 30 days. As long as you maintain the usual 30 day connectivity requirements for Azure Stack HCI, no user action is required.
58
58
59
-
2. HciSvc exposes a private and non-routable REST endpoint, accessible only to VMs on the same server. To enable this endpoint, an internal vSwitch is configured on the Azure Stack HCI host (named *AZSHCI_HOST-IMDS_DO_NOT_MODIFY*). VMs then must have a NIC configured and attached to the same vSwitch (*AZSHCI_GUEST-IMDS_DO_NOT_MODIFY*).
59
+
1. HciSvc exposes a private and non-routable REST endpoint, accessible only to VMs on the same server. To enable this endpoint, an internal vSwitch is configured on the Azure Stack HCI host (named **AZSHCI_HOST-IMDS_DO_NOT_MODIFY**). VMs then must have a NIC configured and attached to the same vSwitch (**AZSHCI_GUEST-IMDS_DO_NOT_MODIFY**).
60
60
61
61
> [!NOTE]
62
62
> Modifying or deleting this switch and NIC prevents Azure Benefits from working properly. If errors occur, disable Azure Benefits using Windows Admin Center or the PowerShell instructions that follow, and then try again.
63
63
64
-
3. Consumer workloads (for example, Windows Server Azure Edition guests) request attestation. HciSvc then signs the response with an Azure certificate.
64
+
1. Consumer workloads (for example, Windows Server Azure Edition guests) request attestation. HciSvc then signs the response with an Azure certificate.
65
65
66
66
> [!NOTE]
67
67
> You must manually enable access for each VM that needs Azure Benefits.
@@ -89,15 +89,15 @@ You can enable Azure Benefits on Azure Stack HCI using Windows Admin Center, Pow
89
89
90
90
1. In Windows Admin Center, select **Cluster Manager** from the top drop-down menu, navigate to the cluster that you want to activate, then under **Settings**, select **Azure Benefits**.
91
91
92
-
2. In the **Azure Benefits** pane, select **Turn on**. By default, the checkbox to turn on for all existing VMs is selected. You can deselect it and manually add VMs later.
92
+
1. In the **Azure Benefits** pane, select **Turn on**. By default, the checkbox to turn on for all existing VMs is selected. You can deselect it and manually add VMs later.
93
93
94
-
3. Select **Turn on** again to confirm setup. It may take a few minutes for servers to reflect the changes.
94
+
1. Select **Turn on** again to confirm setup. It may take a few minutes for servers to reflect the changes.
95
95
96
-
4. When Azure Benefits setup is successful, the page updates to show the Azure Benefits dashboard. To check Azure Benefits for the host:
96
+
1. When Azure Benefits setup is successful, the page updates to show the Azure Benefits dashboard. To check Azure Benefits for the host:
97
97
1. Check that **Azure Benefits cluster status** appears as **On**.
98
98
2. Under the **Cluster** tab in the dashboard, check that Azure Benefits for every server shows as **Active** in the table.
99
99
100
-
5. To check access to Azure Benefits for VMs: Check the status for VMs with Azure Benefits turned on. It's recommended that all of your existing VMs have Azure Benefits turned on; for example, 3 out of 3 VMs.
100
+
1. To check access to Azure Benefits for VMs: Check the status for VMs with Azure Benefits turned on. It's recommended that all of your existing VMs have Azure Benefits turned on; for example, 3 out of 3 VMs.
101
101
102
102
:::image type="content" source="media/azure-benefits/manage-benefits.gif" alt-text="Screenshot of Azure Benefits in Windows Admin Center.":::
103
103
@@ -115,7 +115,7 @@ You can enable Azure Benefits on Azure Stack HCI using Windows Admin Center, Pow
115
115
Enable-AzStackHCIAttestation -AddVM
116
116
```
117
117
118
-
2. When Azure Benefits setup is successful, you can view the Azure Benefits status. Check the cluster property **IMDS Attestation** by running the following command:
118
+
1. When Azure Benefits setup is successful, you can view the Azure Benefits status. Check the cluster property **IMDS Attestation** by running the following command:
119
119
120
120
```powershell
121
121
Get-AzureStackHCI
@@ -127,15 +127,16 @@ You can enable Azure Benefits on Azure Stack HCI using Windows Admin Center, Pow
Copy file name to clipboardExpand all lines: azure-local/manage/collect-diagnostic-data.md
+39-38Lines changed: 39 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Understanding Storage Spaces Direct diagnostic data collection tool
4
4
ms.author: sethm
5
5
ms.topic: article
6
6
author: sethmanheim
7
-
ms.date: 02/26/2024
7
+
ms.date: 02/21/2025
8
8
---
9
9
# Collect diagnostic data for clusters
10
10
@@ -20,33 +20,33 @@ Because the logs and other information are dense, the information presented in t
20
20
21
21
You can use Windows Admin Center (version 1812 onwards) to:
22
22
23
-
- Install SDDC diagnostic tools and keep them up to date
24
-
- Schedule daily diagnostic runs (these have a low impact on your system, usually take less than five minutes to run in the background, and won't take up more than 500MB on your cluster)
25
-
- View previously collected diagnostic information if you need to give it to support or analyze it yourself
23
+
- Install SDDC diagnostic tools and keep them up to date.
24
+
- Schedule daily diagnostic runs (these have a low impact on your system, usually take less than five minutes to run in the background, and won't take up more than 500MB on your cluster).
25
+
- View previously collected diagnostic information if you need to give it to support personnel, or to analyze it yourself.
26
26
27
27
To install SDDC diagnostic tools and begin collecting data, follow these steps:
28
28
29
29
1. Launch Windows Admin Center and select **Tools > Diagnostics**. If diagnostics tools are not already installed, click the **Install** button.
2. To begin collecting diagnostic data, click **Collect**. You should see a message that says "Collecting diagnostic information. This may take a few minutes." After the initial data collection, if you want to automatically collect data every 24 hours, change the slider to **On**.
34
-
32
+
33
+
1. To begin collecting diagnostic data, click **Collect**. You should see a message that says "Collecting diagnostic information. This may take a few minutes." After the initial data collection, if you want to automatically collect data every 24 hours, change the slider to **On**.
34
+
35
35
:::image type="content" source="media/collect-diagnostic-data/collect-diagnostic-data.png" alt-text="Click Collect to being collecting diagnostic data." lightbox="media/collect-diagnostic-data/collect-diagnostic-data.png":::
36
-
37
-
3. Data collection is not complete until you see the screenshot below. To view collected diagnostic information, choose **Download (.zip)** or **Open in Files tool**.
38
-
36
+
37
+
1. Data collection is not complete until you see the screenshot below. To view collected diagnostic information, choose **Download (.zip)** or **Open in Files tool**.
38
+
39
39
:::image type="content" source="media/collect-diagnostic-data/view-diagnostic-information.png" alt-text="To view diagnostic information, you can either download a .zip file or open in Files tool." lightbox="media/collect-diagnostic-data/view-diagnostic-information.png":::
40
-
41
-
## Installing Get-SDDCDiagnosticInfo with PowerShell
40
+
41
+
## Install Get-SDDCDiagnosticInfo with PowerShell
42
42
43
43
You can use the `Get-SDDCDiagnosticInfo` PowerShell cmdlet (also known as `Get-PCStorageDiagnosticInfo`, previously known as `Test-StorageHealth`) to gather logs for and perform health checks for Failover Clustering (cluster, resources, networks, nodes), Storage Spaces (physical disks, enclosures, virtual disks), Cluster Shared Volumes, SMB file shares, and Deduplication.
44
44
45
45
There are two methods of installing the script: PowerShell Gallery and GitHub. Both are outlined below.
46
46
47
47
### PowerShell Gallery
48
48
49
-
The [PowerShell Gallery](https://www.powershellgallery.com/packages/PrivateCloud.DiagnosticInfo) is a snapshot of the GitHub Repo. Note that installing items from the PowerShell Gallery requires the latest version of the PowerShellGet module, which is available in Windows 10, in Windows Management Framework (WMF) 5.0, or in the MSI-based installer (for PowerShell 3 and 4).
49
+
The [PowerShell Gallery](https://www.powershellgallery.com/packages/PrivateCloud.DiagnosticInfo) is a snapshot of the GitHub repo. Note that installing items from the PowerShell Gallery requires the latest version of the **PowerShellGet** module, which is available in Windows 10, in Windows Management Framework (WMF) 5.0, or in the MSI-based installer (for PowerShell 3 and 4).
50
50
51
51
We install the latest version of the [Microsoft Networking Diagnostics tools](https://www.powershellgallery.com/packages/MSFT.Network.Diag) during this process as well since `Get-SDDCDiagnosticInfo` relies on this. This manifest module contains network diagnostic and troubleshooting tool, which are maintained by the Microsoft Core Networking Product Group at Microsoft.
The [GitHub Repo](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/) is the most up-to-date version of the module, since we are continually iterating here. To install the module from GitHub, download the latest module from the [archive](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/archive/master.zip) and extract the PrivateCloud.DiagnosticInfo directory to the correct PowerShell modules path pointed by ```$env:PSModulePath```
70
+
The [GitHub repo](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/) is the most up-to-date version of the module, since we are continually iterating here. To install the module from GitHub, download the latest module from the [archive](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/archive/master.zip) and extract the **PrivateCloud.DiagnosticInfo** directory to the correct PowerShell modules path pointed to by `$env:PSModulePath`:
71
71
72
72
```PowerShell
73
73
# Allowing Tls12 and Tls11 -- e.g. github now requires Tls12
@@ -95,17 +95,17 @@ Import-Module $module -Force
95
95
96
96
```
97
97
98
-
If you need to get this module on an offline cluster, download the zip, move it to your target server node, and install the module.
98
+
If you need to get this module on an offline cluster, download the zip file, move it to your target server node, and install the module.
99
99
100
100
## Gathering logs with PowerShell
101
101
102
-
After you have enabled event channels and completed the installation process, you can use the `Get-SDDCDiagnosticInfo` PowerShell cmdlet in the module to get:
102
+
After you enable event channels and complete the installation process, you can use the `Get-SDDCDiagnosticInfo` PowerShell cmdlet in the module to get:
103
103
104
-
- Reports on storage health, plus details on unhealthy components
105
-
- Reports of storage capacity by pool, volume, and deduplicated volume
106
-
- Event logs from all cluster nodes and a summary error report
104
+
- Reports on storage health, plus details on unhealthy components.
105
+
- Reports of storage capacity by pool, volume, and deduplicated volume.
106
+
- Event logs from all cluster nodes and a summary error report.
107
107
108
-
Assume that your storage cluster has the name *"CLUS01".*
108
+
Assume that your storage cluster has the name **CLUS01**.
All data is written to the **SDDCDiagTemp** folder:
140
140
141
141
:::image type="content" source="media/collect-diagnostic-data/collect-data-folder.png" alt-text="Data in File Explorer screenshot." lightbox="media/collect-diagnostic-data/collect-data-folder.png":::
142
142
143
-
After the script finishes, it will create a ZIP in your user directory:
143
+
After the script finishes, it creates a zip file in your user directory:
144
144
145
145
:::image type="content" source="media/collect-diagnostic-data/collect-data-result.png" alt-text="Data zip in PowerShell screenshot." lightbox="media/collect-diagnostic-data/collect-data-result.png":::
146
146
147
-
Let's generate a report into a text file:
147
+
Generate a report into a text file:
148
148
149
149
```PowerShell
150
150
#find the latest diagnostic zip in UserProfile
@@ -163,32 +163,32 @@ For reference, here is a link to the [sample report](https://github.com/Microsof
163
163
164
164
## Get-SDDCDiagnosticInfo output
165
165
166
-
The following are the files included in the zipped output of `Get-SDDCDiagnosticInfo`.
166
+
The following files are included in the zipped output of `Get-SDDCDiagnosticInfo`.
167
167
168
168
### Health summary Report
169
169
170
-
The health summary report is saved as:
171
-
- 0_CloudHealthSummary.log
170
+
The health summary report is saved as **0_CloudHealthSummary.log**.
172
171
173
172
This file is generated after parsing all the data collected and is meant to provide a quick summary of your system. It contains:
174
173
175
-
- System information
176
-
- Storage health overview (number of nodes up, resources online, cluster shared volumes online, unhealthy components, etc.)
177
-
- Details on unhealthy components (cluster resources that are offline, failed, or online pending)
178
-
- Firmware and driver information
179
-
- Pool, physical disk, and volume details
180
-
- Storage Performance (performance counters are collected)
174
+
- System information.
175
+
- Storage health overview (number of nodes up, resources online, cluster shared volumes online, unhealthy components, etc.).
176
+
- Details on unhealthy components (cluster resources that are offline, failed, or online pending).
177
+
- Firmware and driver information.
178
+
- Pool, physical disk, and volume details.
179
+
- Storage performance (performance counters are collected).
181
180
182
-
This report is being continually updated to include more useful information. For the latest information, see the [GitHub README](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/edit/master/README.md).
181
+
This report is continually updated to include more useful information. For the latest information, see the [GitHub readme](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/edit/master/README.md).
183
182
184
183
### Logs and XML files
185
184
186
-
The script runs various log gathering scripts and saves the output as xml files. We collect cluster and health logs, system information (MSInfo32), unfiltered event logs (failover clustering, dis diagnostics, Hyper-V, storage spaces, and more), and storage diagnostics information (operational logs). For the latest information on what information is collected, see the [GitHub README (what we collect)](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/blob/master/README.md#what-does-the-cmdlet-output-include).
185
+
The script runs various log gathering scripts and saves the output as xml files. We collect cluster and health logs, system information (MSInfo32), unfiltered event logs (failover clustering, dis diagnostics, Hyper-V, storage spaces, and more), and storage diagnostics information (operational logs). For the latest information about what information is collected, see the [GitHub readme (what we collect)](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/blob/master/README.md#what-does-the-cmdlet-output-include).
187
186
188
187
## How to consume XML files from Get-SDDCDiagnosticInfo
188
+
189
189
You can consume the data from the XML files provided in data collected by the `Get-SDDCDiagnosticInfo` cmdlet. These files have information about the virtual disks, physical disks, basic cluster information, and other PowerShell related outputs.
190
190
191
-
To see the results of these outputs, open a PowerShell window and run the following steps.
191
+
To see the results of these outputs, open a PowerShell window and run the following commands:
192
192
193
193
```PowerShell
194
194
ipmo storage
@@ -197,4 +197,5 @@ $d
197
197
```
198
198
199
199
## Next steps
200
-
Provide feedback on what you'd like to see by filing issues [here](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/issues). Also, feel free to contribute helpful changes to the script by submitting a [pull request](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/pulls).
200
+
201
+
Provide feedback on what you'd like to see by [filing issues here](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/issues). Also, feel free to contribute helpful changes to the script by [submitting a pull request](https://github.com/PowerShell/PrivateCloud.DiagnosticInfo/pulls).
0 commit comments