Data Protection Health System Vsan Query Health Summary
Query Data Protection (DP) health data and generate health checks.
Query Data Protection (DP) health data and generate health checks.
It's the primary API for fetching latest DP health status. This API doesn't support host level call and will throw exception in that case. The DP health summary is pushed from the DP appliance and stored in memory by the vSAN health service. If the DP appliance is offline or experiences a loss of connectivity, the vSAN health service will be unable to provide the most current DP health data. However, if the vSAN health service is restarted, it will first load the most recent available DP health status from the historical health database. It will then update the health status once new data is received from the DP appliance, which typically occurs after a few minutes.
Required privileges: System.Read
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/vsan/DataProtectionHealthSystem/{moId}/VsanQueryHealthSummary
COPY
Path Parameters
string
moId
Required
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case DataProtectionHealthSystem/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.
Request Body
VsanQueryHealthSummaryRequestType
of type(s)
application/json
Required
Show optional properties
{
"cluster": {}
}{
"cluster": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}
cluster
Required
The target cluster.
Responses
200
Returns a health summary data object, containing the current DP health status.
Returns
VsanClusterHealthSummary
of type(s)
application/json
This response body class contains all of the following:
DataObject
{
"_typeName": "string",
"clusterStatus": {
"_typeName": "string",
"status": "string",
"goalState": "string",
"untrackedHosts": [
"string"
],
"trackedHostsStatus": [
{
"_typeName": "string",
"hostname": "string",
"status": "string",
"issues": [
"string"
]
}
]
},
"timestamp": "string",
"clusterVersions": {
"_typeName": "string",
"hostResults": [
{
"_typeName": "string",
"hostname": "string",
"version": "string",
"error": {
"_typeName": "string",
"faultCause": {
"_typeName": "string",
"faultCause": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"build": "string"
}
],
"vcVersion": "string",
"issueFound": false,
"upgradePossible": false,
"vcBuild": "string"
},
"objectHealth": {
"_typeName": "string",
"objectHealthDetail": [
{
"_typeName": "string",
"numObjects": 0,
"health": "string",
"objUuids": [
"string"
],
"vsanClusterUuid": "string"
}
],
"objectsComplianceDetail": [
{
"_typeName": "string",
"checkTime": "string",
"profile": "string",
"objectUUID": "string",
"complianceStatus": "string",
"mismatch": false,
"violatedPolicies": [
{
"_typeName": "string",
"id": "string",
"expectedValue": "string",
"currentValue": "string"
}
],
"operationalStatus": {
"_typeName": "string",
"healthy": false,
"operationETA": "string",
"operationProgress": 0,
"transitional": false
},
"objPolicyGenerationId": "string"
}
],
"objectVersionCompliance": false,
"objectFormatChangeRequiredUuids": [
"string"
],
"objectsRelayoutBytes": 0,
"globalDedupStoreHealth": "string",
"objectStats": {
"_typeName": "string",
"numAutoManagedObjects": 0,
"numFTT3ManagedObjects": 0
},
"vsanObjectsForObjectStoreVolumes": [
"string"
]
},
"vmHealth": {
"_typeName": "string",
"healthStateList": [
{
"_typeName": "string",
"numVMs": 0,
"state": "string",
"health": "string",
"vmInstanceUuids": [
"string"
]
}
],
"overallHealthState": "string"
},
"networkHealth": {
"_typeName": "string",
"hostResults": [
{
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"hostname": "string",
"vsanVmknicPresent": false,
"ipSubnets": [
"string"
],
"issueFound": false,
"peerHealth": [
{
"_typeName": "string",
"peer": "string",
"peerHostname": "string",
"peerVmknicName": "string",
"smallPingTestSuccessPct": 0,
"largePingTestSuccessPct": 0,
"maxLatencyUs": 0,
"onSameIpSubnet": false,
"sourceVmknicName": "string",
"connectivityHealthState": "string",
"missingHeartBeatCount": 0
}
],
"vMotionHealth": [
{
"_typeName": "string",
"peer": "string",
"peerHostname": "string",
"peerVmknicName": "string",
"smallPingTestSuccessPct": 0,
"largePingTestSuccessPct": 0,
"maxLatencyUs": 0,
"onSameIpSubnet": false,
"sourceVmknicName": "string",
"connectivityHealthState": "string",
"missingHeartBeatCount": 0
}
],
"multicastConfig": "string",
"unicastConfig": "string",
"inUnicast": false,
"rdmaEnabled": false,
"rdtConnProtocol": "string",
"serverClusters": [
{
"_typeName": "string",
"cluster": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"peerHealth": [
{
"_typeName": "string",
"peer": "string",
"peerHostname": "string",
"peerVmknicName": "string",
"smallPingTestSuccessPct": 0,
"largePingTestSuccessPct": 0,
"maxLatencyUs": 0,
"onSameIpSubnet": false,
"sourceVmknicName": "string",
"connectivityHealthState": "string",
"missingHeartBeatCount": 0
}
],
"membership": {
"_typeName": "string",
"clusterUuid": "string",
"health": "string",
"membershipUuid": "string",
"memberUuid": [
"string"
]
}
}
],
"externalPeerHealth": [
{
"_typeName": "string",
"peer": "string",
"peerHostname": "string",
"peerVmknicName": "string",
"smallPingTestSuccessPct": 0,
"largePingTestSuccessPct": 0,
"maxLatencyUs": 0,
"onSameIpSubnet": false,
"sourceVmknicName": "string",
"connectivityHealthState": "string",
"missingHeartBeatCount": 0
}
]
}
],
"issueFound": false,
"vsanVmknicPresent": false,
"matchingMulticastConfig": false,
"matchingIpSubnets": false,
"pingTestSuccess": false,
"largePingTestSuccess": false,
"hostLatencyCheckSuccess": false,
"potentialMulticastIssue": false,
"otherHostsInVsanCluster": [
"string"
],
"partitions": [
{
"_typeName": "string",
"hosts": [
"string"
],
"partitionUnknown": false
}
],
"hostsWithVsanDisabled": [
"string"
],
"hostsDisconnected": [
"string"
],
"hostsCommFailure": [
"string"
],
"hostsInEsxMaintenanceMode": [
"string"
],
"hostsInVsanMaintenanceMode": [
"string"
],
"infoAboutUnexpectedHosts": [
{
"_typeName": "string",
"uuid": "string",
"hostnameInCmmds": "string",
"vsanIpv4Addresses": [
"string"
]
}
],
"clusterInUnicastMode": false,
"clusterInRDMAMode": false
},
"limitHealth": {
"_typeName": "string",
"issueFound": false,
"componentLimitHealth": "string",
"diskFreeSpaceHealth": "string",
"rcFreeReservationHealth": "string",
"hostResults": [
{
"_typeName": "string",
"hostname": "string",
"issueFound": false,
"maxComponents": 0,
"freeComponents": 0,
"componentLimitHealth": "string",
"lowestFreeDiskSpacePct": 0,
"usedDiskSpaceB": 0,
"totalDiskSpaceB": 0,
"diskFreeSpaceHealth": "string",
"reservedRcSizeB": 0,
"totalRcSizeB": 0,
"rcFreeReservationHealth": "string",
"totalLogicalSpaceB": 0,
"logicalSpaceUsedB": 0,
"dedupMetadataSizeB": 0,
"diskTransientCapacityUsedB": 0,
"dgTransientCapacityUsedB": 0,
"slackSpaceCapRequired": 0,
"resyncPauseThreshold": 0,
"spaceEfficiencyMetadataSizeB": {
"_typeName": "string",
"dedupMetadataSize": 0,
"compressionMetadataSize": 0
},
"hostRebuildCapacity": 0,
"minSpaceRequiredForVsanOp": 0,
"enforceCapResrvSpace": 0,
"cdReservedSizeB": 0
}
],
"whatifHostFailures": [
{
"_typeName": "string",
"numFailures": 0,
"totalUsedCapacityB": 0,
"totalCapacityB": 0,
"totalRcReservationB": 0,
"totalRcSizeB": 0,
"usedComponents": 0,
"totalComponents": 0,
"componentLimitHealth": "string",
"diskFreeSpaceHealth": "string",
"rcFreeReservationHealth": "string",
"slackSpaceCapRequired": 0,
"diskSpaceThreshold": {
"_typeName": "string",
"yellowValue": 0,
"redValue": 0,
"target": "string",
"enabled": false
},
"capacityReservationInfo": {
"_typeName": "string",
"hostRebuildThreshold": "string",
"vsanOpSpaceThreshold": "string"
}
}
],
"hostsCommFailure": [
"string"
]
},
"advCfgSync": [
{
"_typeName": "string",
"inSync": false,
"name": "string",
"hostValues": [
{
"_typeName": "string",
"hostname": "string",
"value": "string",
"isDefault": false
}
]
}
],
"createVmHealth": [
{
"_typeName": "string",
"hostname": "string",
"state": "string",
"fault": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
}
],
"physicalDisksHealth": [
{
"_typeName": "string",
"overallHealth": "string",
"heapsWithIssues": [
{
"_typeName": "string",
"resource": "string",
"health": "string",
"description": "string"
}
],
"slabsWithIssues": [
{
"_typeName": "string",
"resource": "string",
"health": "string",
"description": "string"
}
],
"disks": [
{
"_typeName": "string",
"name": "string",
"uuid": "string",
"inCmmds": false,
"inVsi": false,
"dedupScope": 0,
"formatVersion": 0,
"isAllFlash": 0,
"congestionValue": 0,
"congestionArea": "string",
"congestionHealth": "string",
"metadataHealth": "string",
"operationalHealthDescription": "string",
"operationalHealth": "string",
"dedupUsageHealth": "string",
"capacityHealth": "string",
"summaryHealth": "string",
"capacity": 0,
"usedCapacity": 0,
"reservedCapacity": 0,
"totalBytes": 0,
"freeBytes": 0,
"hashedBytes": 0,
"dedupedBytes": 0,
"scsiDisk": {
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
},
"usedComponents": 0,
"maxComponents": 0,
"compLimitHealth": "string",
"encryptionEnabled": false,
"kmsProviderId": "string",
"kekId": "string",
"dekGenerationId": 0,
"encryptedUnlocked": false,
"rebalanceResult": {
"_typeName": "string",
"status": "string",
"bytesMoving": 0,
"remainingBytesToMove": 0,
"diskUsage": "number",
"maxDiskUsage": "number",
"minDiskUsage": "number",
"avgDiskUsage": "number",
"diskCompUsage": "number",
"maxDiskCompUsage": "number",
"minDiskCompUsage": "number",
"avgDiskCompUsage": "number"
},
"dekId": "string",
"kekVerifierHealth": false,
"dekVerifierHealth": false,
"logicalCapacity": 0,
"logicalCapacityUsed": 0,
"logicalCapacityHealth": "string",
"vsanDiskGroupUuid": "string",
"dgLayoutIssue": false,
"usedMetadataComponents": 0,
"maxMetadataComponents": 0,
"pendingClusterDekId": "string",
"dmekVerifierHealth": false
}
],
"componentsWithIssues": [
{
"_typeName": "string",
"resource": "string",
"health": "string",
"description": "string"
}
],
"hostname": "string",
"hostDedupScope": 0,
"error": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"licensedDisks": [
{
"_typeName": "string",
"uuid": "string",
"name": "string",
"capacity": 0
}
]
}
],
"encryptionHealth": {
"_typeName": "string",
"overallHealth": "string",
"configHealth": "string",
"kmsHealth": "string",
"vcKmsResult": {
"_typeName": "string",
"health": "string",
"error": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"kmsProviderId": "string",
"kmsHealth": [
{
"_typeName": "string",
"serverName": "string",
"health": "string",
"error": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"trustHealth": "string",
"certHealth": "string",
"certExpireDate": "string"
}
],
"clientCertHealth": "string",
"clientCertExpireDate": "string",
"isAwsKms": false,
"cmkHealth": "string",
"kekExpireHealth": "string",
"kekExpireDate": "string",
"hostKeyExpireHealth": "string",
"hostKeyExpireDate": "string"
},
"hostResults": [
{
"_typeName": "string",
"hostname": "string",
"encryptionInfo": {
"_typeName": "string",
"enabled": false,
"kekId": "string",
"hostKeyId": "string",
"kmipServers": [
{
"_typeName": "string",
"clusterId": {
"_typeName": "string",
"id": "string"
},
"info": {
"_typeName": "string",
"name": "string",
"address": "string",
"port": 0,
"proxyAddress": "string",
"proxyPort": 0,
"reconnect": 0,
"protocol": "string",
"nbio": 0,
"timeout": 0,
"userName": "string"
},
"password": "string",
"defaultKeyType": "string",
"keySpec": {
"_typeName": "string"
}
}
],
"kmsServerCerts": [
"string"
],
"clientKey": "string",
"clientCert": "string",
"dekGenerationId": 0,
"changing": false,
"eraseDisksBeforeUse": false,
"wrappedDek": "string",
"dekId": "string",
"oldWrappedDek": "string",
"oldDekId": "string",
"kekVerifier": "string",
"dekVerifier": "string",
"oldDekVerifier": "string",
"iv": "string",
"syncing": false
},
"overallKmsHealth": "string",
"kmsHealth": [
{
"_typeName": "string",
"serverName": "string",
"health": "string",
"error": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"trustHealth": "string",
"certHealth": "string",
"certExpireDate": "string"
}
],
"encryptionIssues": [
"string"
],
"diskResults": [
{
"_typeName": "string",
"diskHealth": {
"_typeName": "string",
"name": "string",
"uuid": "string",
"inCmmds": false,
"inVsi": false,
"dedupScope": 0,
"formatVersion": 0,
"isAllFlash": 0,
"congestionValue": 0,
"congestionArea": "string",
"congestionHealth": "string",
"metadataHealth": "string",
"operationalHealthDescription": "string",
"operationalHealth": "string",
"dedupUsageHealth": "string",
"capacityHealth": "string",
"summaryHealth": "string",
"capacity": 0,
"usedCapacity": 0,
"reservedCapacity": 0,
"totalBytes": 0,
"freeBytes": 0,
"hashedBytes": 0,
"dedupedBytes": 0,
"scsiDisk": {
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
},
"usedComponents": 0,
"maxComponents": 0,
"compLimitHealth": "string",
"encryptionEnabled": false,
"kmsProviderId": "string",
"kekId": "string",
"dekGenerationId": 0,
"encryptedUnlocked": false,
"rebalanceResult": {
"_typeName": "string",
"status": "string",
"bytesMoving": 0,
"remainingBytesToMove": 0,
"diskUsage": "number",
"maxDiskUsage": "number",
"minDiskUsage": "number",
"avgDiskUsage": "number",
"diskCompUsage": "number",
"maxDiskCompUsage": "number",
"minDiskCompUsage": "number",
"avgDiskCompUsage": "number"
},
"dekId": "string",
"kekVerifierHealth": false,
"dekVerifierHealth": false,
"logicalCapacity": 0,
"logicalCapacityUsed": 0,
"logicalCapacityHealth": "string",
"vsanDiskGroupUuid": "string",
"dgLayoutIssue": false,
"usedMetadataComponents": 0,
"maxMetadataComponents": 0,
"pendingClusterDekId": "string",
"dmekVerifierHealth": false
},
"encryptionIssues": [
"string"
]
}
],
"error": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"aesniEnabled": false,
"inconsistentlyEncryptedObjectCount": 0,
"hostEncryptionDekId": "string",
"kekVerifierHealth": false,
"dekVerifierHealth": false
}
],
"aesniHealth": "string"
},
"hclInfo": {
"_typeName": "string",
"hclDbLastUpdate": "string",
"hclDbAgeHealth": "string",
"hostResults": [
{
"_typeName": "string",
"hostname": "string",
"hclChecked": false,
"releaseName": "string",
"error": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"controllers": [
{
"_typeName": "string",
"deviceName": "string",
"deviceDisplayName": "string",
"driverName": "string",
"driverVersion": "string",
"vendorId": 0,
"deviceId": 0,
"subVendorId": 0,
"subDeviceId": 0,
"extraInfo": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
],
"deviceOnHcl": false,
"releaseSupported": false,
"releasesOnHcl": [
"string"
],
"driverVersionsOnHcl": [
"string"
],
"driverVersionSupported": false,
"fwVersionSupported": false,
"fwVersionOnHcl": [
"string"
],
"cacheConfigSupported": false,
"cacheConfigOnHcl": [
"string"
],
"raidConfigSupported": false,
"raidConfigOnHcl": [
"string"
],
"fwVersion": "string",
"raidConfig": "string",
"cacheConfig": "string",
"cimProviderInfo": {
"_typeName": "string",
"cimProviderSupported": false,
"installedCIMProvider": "string",
"cimProviderOnHcl": [
"string"
],
"cimProviderLinksOnHcl": [
{
"_typeName": "string",
"url": "string",
"sha1sum": "string",
"formatType": "string",
"itemId": "string"
}
]
},
"usedByVsan": false,
"disks": [
{
"_typeName": "string",
"deviceName": "string",
"model": "string",
"isSsd": false,
"vsanDisk": false,
"issues": [
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
],
"remediableIssues": [
"string"
],
"uuid": "string",
"capacity": 0,
"vsanCompatibility": [
"string"
]
}
],
"issues": [
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
],
"remediableIssues": [
"string"
],
"driversOnHcl": [
{
"_typeName": "string",
"driverVersion": "string",
"driverLink": {
"_typeName": "string",
"url": "string",
"sha1sum": "string",
"formatType": "string",
"itemId": "string"
},
"fwVersion": "string",
"fwLinks": [
{
"_typeName": "string",
"url": "string",
"sha1sum": "string",
"formatType": "string",
"itemId": "string"
}
],
"toolsLinks": [
{
"_typeName": "string",
"url": "string",
"sha1sum": "string",
"formatType": "string",
"itemId": "string"
}
],
"eula": "string",
"driverType": "string",
"driverName": "string",
"diskModes": [
"string"
],
"supportedFeatures": [
"string"
]
}
],
"fwAuxVersion": "string",
"queueDepth": 0,
"queueDepthOnHcl": 0,
"queueDepthSupported": false,
"diskMode": "string",
"diskModeOnHcl": [
"string"
],
"diskModeSupported": false,
"toolName": "string",
"toolVersion": "string",
"productId": "string",
"diskCapacity": 0,
"vcgEntryInfo": [
{
"_typeName": "string",
"vcgId": 0,
"vcgModelName": "string"
}
],
"controllerType": "string",
"userSelectedVcgId": 0,
"vsanCompatibility": [
"string"
]
}
],
"pnics": [
{
"_typeName": "string",
"deviceName": "string",
"displayName": "string",
"driverName": "string",
"driverVersion": "string",
"vendorId": 0,
"deviceId": 0,
"subVendorId": 0,
"subDeviceId": 0,
"extraInfo": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
],
"deviceOnHcl": false,
"releaseSupported": false,
"releasesOnHcl": [
"string"
],
"driverVersionsOnHcl": [
"string"
],
"driverVersionSupported": false,
"fwVersionSupported": false,
"fwVersionOnHcl": [
"string"
],
"fwVersion": "string",
"driversOnHcl": [
{
"_typeName": "string",
"driverVersion": "string",
"driverLink": {
"_typeName": "string",
"url": "string",
"sha1sum": "string",
"formatType": "string",
"itemId": "string"
},
"fwVersion": "string",
"fwLinks": [
{
"_typeName": "string",
"url": "string",
"sha1sum": "string",
"formatType": "string",
"itemId": "string"
}
],
"toolsLinks": [
{
"_typeName": "string",
"url": "string",
"sha1sum": "string",
"formatType": "string",
"itemId": "string"
}
],
"eula": "string",
"driverType": "string",
"driverName": "string",
"diskModes": [
"string"
],
"supportedFeatures": [
"string"
]
}
],
"vmknic": "string",
"useByVsan": false,
"rdmaConfig": {
"_typeName": "string",
"rdmaCapable": false,
"rdmaProtocolCapable": "string",
"dcbEnabled": false,
"dcbMode": "string",
"pfcEnabled": false,
"pfcConfig": "string"
},
"vsanHostCompatibility": [
"string"
],
"nicLinkSpeedInMbps": 0
}
],
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"computeResource": {
"_typeName": "string",
"memory": {
"_typeName": "string",
"memorySize": 0,
"vsanHostCompatibility": [
"string"
]
}
},
"vsanHostCompatibility": [
"string"
]
}
],
"updateItems": [
{
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"type": "string",
"name": "string",
"version": "string",
"existingVersion": "string",
"present": false,
"vibSpec": [
{
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"metaUrl": "string",
"metaSha1Sum": "string",
"vibUrl": "string",
"vibSha1Sum": "string"
}
],
"vibType": "string",
"firmwareSpec": {
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"hbaDevice": "string",
"fwFiles": [
{
"_typeName": "string",
"fileType": "string",
"filenameOrUrl": "string",
"sha1sum": "string"
}
],
"allowDowngrade": false,
"firmwareComponent": [
{
"_typeName": "string",
"name": "string",
"url": "string",
"sha1sum": "string",
"currentVersion": "string",
"suggestedVersion": "string",
"componentID": [
"string"
]
}
]
},
"downloadInfo": [
{
"_typeName": "string",
"url": "string",
"sha1sum": "string",
"formatType": "string",
"itemId": "string"
}
],
"eula": "string",
"adapter": "string",
"key": "string",
"impact": "string",
"firmwareUnknown": false
}
],
"hclDbAbsent": false
},
"groups": [
{
"_typeName": "string",
"groupId": "string",
"groupName": "string",
"groupHealth": "string",
"groupTests": [
{
"_typeName": "string",
"testId": "string",
"testName": "string",
"testDescription": "string",
"testShortDescription": "string",
"testHealthyEntities": 0,
"testAllEntities": 0,
"testHealth": "string",
"testDetails": [
{
"_typeName": "string",
"label": "string"
}
],
"testActions": [
{
"_typeName": "string",
"actionId": "string",
"actionLabel": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
},
"actionDescription": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
},
"enabled": false,
"parameters": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
]
}
],
"historicalResults": [
{
"_typeName": "string",
"timestamp": "string",
"health": "string",
"testDetails": [
{
"_typeName": "string",
"label": "string"
}
],
"testCorrelation": {
"_typeName": "string",
"primaryHealthTests": [
"string"
],
"relatedHealthTests": [
"string"
],
"skippedHealthTests": [
"string"
]
}
}
],
"testCorrelation": {
"_typeName": "string",
"primaryHealthTests": [
"string"
],
"relatedHealthTests": [
"string"
],
"skippedHealthTests": [
"string"
]
},
"reducedScore": 0,
"category": "string",
"riskIfNotFix": "string",
"lastStatusChangeTime": "string"
}
],
"groupDetails": [
{
"_typeName": "string",
"label": "string"
}
],
"inProgress": false
}
],
"overallHealth": "string",
"overallHealthDescription": "string",
"clomdLiveness": {
"_typeName": "string",
"clomdLivenessResult": [
{
"_typeName": "string",
"hostname": "string",
"clomdStat": "string",
"error": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
}
],
"issueFound": false
},
"diskBalance": {
"_typeName": "string",
"varianceThreshold": 0,
"disks": [
{
"_typeName": "string",
"uuid": "string",
"fullness": 0,
"variance": 0,
"fullnessAboveThreshold": 0,
"dataToMoveB": 0,
"compFullness": 0,
"compVariance": 0
}
]
},
"genericCluster": {
"_typeName": "string",
"drsEnabled": false,
"haEnabled": false,
"issues": [
{
"_typeName": "string"
}
]
},
"networkConfig": {
"_typeName": "string",
"vdsPresent": false,
"issues": [
{
"_typeName": "string"
}
]
},
"vsanConfig": {
"_typeName": "string",
"vsanEnabled": false,
"issues": [
{
"_typeName": "string"
}
]
},
"burnInTest": {
"_typeName": "string",
"passedTests": [
{
"_typeName": "string",
"testname": "string",
"workload": "string",
"duration": 0,
"result": "string"
}
],
"notPerformedTests": [
{
"_typeName": "string",
"testname": "string",
"workload": "string",
"duration": 0,
"result": "string"
}
],
"failedTests": [
{
"_typeName": "string",
"testname": "string",
"workload": "string",
"duration": 0,
"result": "string"
}
]
},
"perfsvcHealth": {
"_typeName": "string",
"statsObjectInfo": {
"_typeName": "string",
"directoryName": "string",
"vsanObjectUuid": "string",
"vsanHealth": "string",
"policyAttributes": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
],
"spbmProfileUuid": "string",
"spbmProfileGenerationId": "string",
"spbmComplianceResult": {
"_typeName": "string",
"checkTime": "string",
"profile": "string",
"objectUUID": "string",
"complianceStatus": "string",
"mismatch": false,
"violatedPolicies": [
{
"_typeName": "string",
"id": "string",
"expectedValue": "string",
"currentValue": "string"
}
],
"operationalStatus": {
"_typeName": "string",
"healthy": false,
"operationETA": "string",
"operationProgress": 0,
"transitional": false
},
"objPolicyGenerationId": "string"
}
},
"statsObjectConsistent": false,
"statsObjectPolicyConsistent": false,
"datastoreCompatible": false,
"enoughFreeSpace": false,
"remediateAction": "string",
"hostResults": [
{
"_typeName": "string",
"version": "string",
"hostname": "string",
"error": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"isCmmdsMaster": false,
"isStatsMaster": false,
"vsanMasterUuid": "string",
"vsanNodeUuid": "string",
"masterInfo": {
"_typeName": "string",
"secSinceLastStatsWrite": 0,
"secSinceLastStatsCollect": 0,
"statsIntervalSec": 0,
"collectionFailureHostUuids": [
"string"
],
"renamedStatsDirectories": [
"string"
],
"statsDirectoryPercentFree": 0,
"verboseMode": false,
"verboseModeLastUpdate": "string"
},
"diagnosticMode": false
}
],
"verboseModeStatus": false
},
"cluster": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"fileServiceHealth": {
"_typeName": "string",
"overallHealth": "string",
"hostResults": [
{
"_typeName": "string",
"hostname": "string",
"overallHealth": "string",
"enabled": false,
"vdfsdStatus": {
"_typeName": "string",
"resource": "string",
"health": "string",
"description": "string"
},
"fsvmStatus": {
"_typeName": "string",
"resource": "string",
"health": "string",
"description": "string"
},
"rootFsStatus": {
"_typeName": "string",
"created": false,
"health": "string",
"description": "string"
},
"fileServerHealth": [
{
"_typeName": "string",
"domainName": "string",
"fileServerIp": "string",
"nfsdHealth": "string",
"networkHealth": "string",
"rootfsHealth": "string",
"description": "string",
"smbConnections": 0,
"smbDaemonHealth": "string",
"adTestJoinHealth": "string",
"dnsLookupHealth": "string"
}
],
"fileShareHealth": [
{
"_typeName": "string",
"overallHealth": "string",
"domainName": "string",
"shareUuid": "string",
"shareName": "string",
"objectHealth": {
"_typeName": "string",
"objectHealthDetail": [
{
"_typeName": "string",
"numObjects": 0,
"health": "string",
"objUuids": [
"string"
],
"vsanClusterUuid": "string"
}
],
"objectsComplianceDetail": [
{
"_typeName": "string",
"checkTime": "string",
"profile": "string",
"objectUUID": "string",
"complianceStatus": "string",
"mismatch": false,
"violatedPolicies": [
{
"_typeName": "string",
"id": "string",
"expectedValue": "string",
"currentValue": "string"
}
],
"operationalStatus": {
"_typeName": "string",
"healthy": false,
"operationETA": "string",
"operationProgress": 0,
"transitional": false
},
"objPolicyGenerationId": "string"
}
],
"objectVersionCompliance": false,
"objectFormatChangeRequiredUuids": [
"string"
],
"objectsRelayoutBytes": 0,
"globalDedupStoreHealth": "string",
"objectStats": {
"_typeName": "string",
"numAutoManagedObjects": 0,
"numFTT3ManagedObjects": 0
},
"vsanObjectsForObjectStoreVolumes": [
"string"
]
},
"description": "string",
"extensible": false,
"spbmProfileUuid": "string",
"spbmProfileGenerationId": "string",
"sharePolicyMismatch": false
}
],
"balanceStatus": {
"_typeName": "string",
"health": "string",
"description": "string"
},
"hostLoadStatus": {
"_typeName": "string",
"resource": "string",
"health": "string",
"description": "string"
}
}
]
},
"ditEncryptionHealth": {
"_typeName": "string",
"overallHealth": "string",
"enabled": false,
"hostResults": [
{
"_typeName": "string",
"hostname": "string",
"health": "string",
"reason": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
},
"ditEncryptionInfo": {
"_typeName": "string",
"enabled": false,
"rekeyInterval": 0,
"transitionState": "string",
"serverClusterUuid": "string",
"clientClusterUuid": "string"
}
}
]
},
"healthScore": 0,
"globalDedupHealth": {
"_typeName": "string",
"dedupConfigHealth": [
{
"_typeName": "string",
"hostname": "string",
"health": "string"
}
],
"dedupStoreHealth": "string"
},
"hciMeshDitEncryptionHealth": {
"_typeName": "string",
"overallHealth": "string",
"hostClientClusterSummary": [
{
"_typeName": "string",
"hostname": "string",
"clusterUuid": "string",
"clusterName": "string",
"ownerVc": "string",
"isLocalOwnerVc": false,
"capable": false,
"clusterHealths": [
{
"_typeName": "string",
"clusterUuid": "string",
"clusterName": "string",
"ownerVc": "string",
"isLocalOwnerVc": false,
"health": "string",
"issues": [
"string"
]
}
]
}
],
"hostServerClusterSummary": [
{
"_typeName": "string",
"hostname": "string",
"clusterUuid": "string",
"clusterName": "string",
"ownerVc": "string",
"isLocalOwnerVc": false,
"capable": false,
"clusterHealths": [
{
"_typeName": "string",
"clusterUuid": "string",
"clusterName": "string",
"ownerVc": "string",
"isLocalOwnerVc": false,
"health": "string",
"issues": [
"string"
]
}
]
}
],
"serverClusterSummary": [
{
"_typeName": "string",
"clusterUuid": "string",
"clusterName": "string",
"ownerVc": "string",
"isLocalOwnerVc": false,
"health": "string",
"issues": [
"string"
]
}
]
},
"healthStatusCounts": {
"_typeName": "string",
"error": 0,
"warning": 0,
"info": 0
}
}
object
clusterStatus
Optional
Structure which aggregates vSAN Health service installation status of all ESX hosts in cluster.
string As date-time
As date-time
timestamp
Optional
The timestamp for generating the health summary.
The timestamp will remain unchanged if the health summary is cached and fetched in future indicating when the health check was performed
clusterVersions
Optional
Health system version information across the cluster.
Meant for programmatic consumption.
objectHealth
Optional
Object health information across the cluster.
Meant for programmatic consumption.
vmHealth
Optional
Ignore this value.
networkHealth
Optional
Network health information across the cluster.
Meant for programmatic consumption.
limitHealth
Optional
Limits health information across the cluster.
Meant for programmatic consumption.
array of
object
advCfgSync
Optional
Advanced configuration synchronization information across the cluster.
Meant for programmatic consumption.
array of
object
createVmHealth
Optional
VM creation results information across the cluster.
Meant for programmatic consumption. Will only be populated if the respective test was run.
array of
object
physicalDisksHealth
Optional
Physical vSAN disk information across the cluster.
Meant for programmatic consumption.
encryptionHealth
Optional
Encryption information across the cluster.
Meant for programmatic consumption.
hclInfo
Optional
HCL check information across the cluster.
Meant for programmatic consumption.
array of
object
groups
Optional
Data driven structure to display all health findings for purpose of rendering a UI.
The health findings are grouped into "groups" of "tests". Each group and each test has a description, health, and optionally one or more "details" tables to display additional information about the test. Programmatic consumption of the health findings should avoid parsing this structure because it is meant for UI consumption and the content will change to improve user experience.
string
overallHealth
Required
Health Enum.
Summarizes all groups and provides a high level status across all categories of health. This Enum defines sets labels for sets of health checks.
string
overallHealthDescription
Required
A human readable, short, description of the overallHealth status.
As there may be many issues detected, the most important one is selected to be described. This should be the one getting first customer attention.
clomdLiveness
Optional
CLOMD liveness on every vSAN host.
Meant for programmatic consumption
diskBalance
Optional
Balance of disk utilization across the cluster.
genericCluster
Optional
Generic cluster configuration best practices checks.
networkConfig
Optional
Network configuration best practices checks.
vsanConfig
Optional
vSAN configuration checks.
burnInTest
Optional
Deprecated as of vSphere API 6.7.
vSAN burn in test checks.
perfsvcHealth
Optional
vSAN performance service health check result.
cluster
Optional
The target cluster
fileServiceHealth
Optional
File service health information across the cluster.
Meant for programmatic consumption. If the file service is not enabled, this field would not be set.
ditEncryptionHealth
Optional
Data-in-transit encryption information across the cluster.
Meant for programmatic consumption.
integer As int32
As int32
healthScore
Optional
The overall health score ranging from 0 to 100 based on the vSAN cluster health check result.
globalDedupHealth
Optional
The global deduplication health summary across the cluster.
Meant for programmatic consumption.
hciMeshDitEncryptionHealth
Optional
The HCI Mesh data-in-transit encryption health summary across the cluster.
Meant for programmatic consumption.
healthStatusCounts
Optional
The overall count of health checks by status level, including error (red), warning (yellow), and informational (info).
500
VsanFault: If any runtime error is hit.
NotSupported: If the API is called at the host level.
Returns
MethodFault
of type(s)
application/json
This response body class contains all of the following:
Any
"MethodFault Object"
faultCause
Optional
Fault which is the cause of this fault.
array of
object
faultMessage
Optional
Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"cluster":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/DataProtectionHealthSystem/{moId}/VsanQueryHealthSummary
On This Page
V San Service Api Operations
POST
Data Protection Health System Vsan Get Dp Cluster Silent Checks
POST
Data Protection Health System Vsan Query Health Summary
POST
Data Protection Health System Vsan Query Historical Health
POST
Data Protection Health System Vsan Set Dp Cluster Silent Checks