Vsan Cluster Health System Vsan Query Cluster Physical Disk Health Summary
Queries the vSAN physical disks health on all of vSAN hosts
Queries the vSAN physical disks health on all of vSAN hosts
Required privileges: System.Read
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanQueryClusterPhysicalDiskHealthSummary
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 VsanClusterHealthSystem/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.
Request Body
VsanQueryClusterPhysicalDiskHealthSummaryRequestType
of type(s)
application/json
Required
Show optional properties
{
"hosts": [
{}
],
"esxRootPassword": "string"
}{
"hosts": [
"string"
],
"esxRootPassword": "string"
}
array of
string
hosts
Required
The vSAN hosts
string
esxRootPassword
Required
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
Responses
200
The vSAN physical disks health result. If empty, it indicates there is no connected host in the cluster.
[
{
"_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": {
"_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"
}
]
},
"licensedDisks": [
{
"_typeName": "string",
"uuid": "string",
"name": "string",
"capacity": 0
}
]
}
]
array of
object
This class encapsulates the vSAN physical disk health check result for all of disks in the host
500
Failure
Returns
NotFound
of type(s)
application/json
This response body class contains all of the following:
VimFault
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hosts":["string"],"esxRootPassword":"string"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanQueryClusterPhysicalDiskHealthSummary
On This Page
V San Service Api Operations
POST
Vsan Cluster Health System Vsan Check Cluster Clomd Liveness
POST
Vsan Cluster Health System Vsan Cluster Get Hcl Info
POST
Vsan Cluster Health System Vsan Query Cluster Adv Cfg Sync
POST
Vsan Cluster Health System Vsan Query Cluster Capture Vsan Pcap
POST
Vsan Cluster Health System Vsan Query Cluster Check Limits
POST
Vsan Cluster Health System Vsan Query Cluster Create Vm Health Test
POST
Vsan Cluster Health System Vsan Query Cluster Health System Versions
POST
Vsan Cluster Health System Vsan Query Cluster Network Perf Test
POST
Vsan Cluster Health System Vsan Query Cluster Physical Disk Health Summary
POST
Vsan Cluster Health System Vsan Query Verify Cluster Network Settings
POST
Vsan Cluster Health System Vsan Repair Cluster Immediate Objects