How to list vSAN Skyline Health check items using PowerCLI

Products

• VMware vCenter Server

Issue/Introduction

This article provides a PowerCLI script that can be used to retrieve and list all vSAN Skyline Health check groups and test items configured for a specific vSAN cluster.

This can be useful when:

• Identifying available Skyline Health checks
• Investigating possible relationships between Skyline Health checks and vCenter alarms
• Comparing health check items across environments
• Exporting health check names and IDs for further analysis

Environment

VMware vCenter Server 8.x

VMware vCenter Server 9.x

Resolution

To get a list of Skyline Health checks for a specific vSAN cluster <CLUSTER_NAME>

1. Connect to vCenter Server using PowerCLI.

Connect-VIServer <vcenter-fqdn>

2. Run the following script.

$cluster = Get-Cluster "<CLUSTER_NAME>"

$vsanHealthSystem = Get-VsanView -Id "VsanVcClusterHealthSystem-vsan-cluster-health-system"

$summary = $vsanHealthSystem.VsanQueryVcClusterHealthSummary(
    $cluster.ExtensionData.MoRef,
    $null,
    $true,
    $null,
    $null,
    $null,
    "defaultView"
)

$summary.Groups |
ForEach-Object {
    $group = $_
    $group.GroupTests | Select-Object `
        @{N="GroupName";E={$group.GroupName}},
        TestName
} | Sort-Object GroupName, TestName

 

Sample output:

GroupName                                    TestName
---------                                    --------
Capacity utilization                         Cluster and host component utilization
Capacity utilization                         Storage space
Capacity utilization                         What if the most consumed host fails
Cluster                                      Advanced vSAN configuration in sync
Cluster                                      Disk format version
Cluster                                      Resync operations throttling
Cluster                                      Software version compatibility
Cluster                                      Time is synchronized across hosts and VC
Cluster                                      VMware vCenter state is authoritative
Cluster                                      vSAN cluster configuration consistency
Cluster                                      vSAN daemon liveness
Cluster                                      vSAN Direct homogeneous disk claiming
Cluster                                      vSAN Disk Balance
Cluster                                      vSAN extended configuration in sync

Additional Information

The script queries the vSAN Health Service through the vSAN Management API and returns:

• GroupName – Skyline Health category name
• TestName – Health check display name

The returned list represents the health checks available in the selected cluster at the time the query is executed.

Depending on the vSAN version, cluster configuration, and enabled features, the list of health checks may vary between environments.