VsanPhysicalDiskHealth

VsanPhysicalDiskHealth
VsanPhysicalDiskHealth

The class for the vSAN physical disk health result.

AllOf
This class requires all of the following:
JSON Example
{
    "_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
}
string
name
Required

The physical disk name with the format like "mpx.vmhba1:C0:T2:L0".

string
uuid
Required

The disk device UUID.

boolean
inCmmds
Required

True indicate this disk can be found in the CMMDS.

boolean
inVsi
Required

True indicates this disk can be found through VSI.

integer As int64 As int64
dedupScope
Optional

The dedup scope configuration.

The value 0 indicate there is no dedup enabled, 1 indicates the dedup scope is in disk wide and 2 indicates the dedup scope is in disk group wide.

integer As int32 As int32
formatVersion
Optional

The disk format version in vSAN.

integer As int32 As int32
isAllFlash
Optional

Flag to indicate if it's all flash configuration.

The value is 1 if the disk group are all flash disk.

integer As int32 As int32
congestionValue
Optional

The maximum congestion value among the area of log, SSD, slab, and memory.

The IO congestion may happen in this four areas in vSAN, it will choose the maximum value among them.

string
congestionArea
Optional

The IO congestion area including log, SSD, slab and memory.

If there is no congestion happen for all of these areas, this value will be 'none'.

string
congestionHealth
Optional

The congestion health status.

The status will be red if the congestion value is larger than 220 and it's yellow if the congestion value is between 200 and 220 and it's green if the congestion value is less than 200.

string
metadataHealth
Optional

The vSAN metadata health status.

All of possible values are "green", "yellow" and "red"

string
operationalHealthDescription
Optional

The disk operational health description.

It gives the reason why the disk is not in operational. All the possible values are:

  • "OK": Healthy
  • "UNKNOWN": Disk health is unknown
  • "FAILED": Permanent disk failure
  • "OFFLINE": Permanent disk loss
  • "OFFLINE,PROPAGATED": Propagated permanent disk failure in disk group
  • "DECOMMISSIONED": Disk dicommissioned
  • "EVACUATING,LATENCY": Impending permanent disk failure, data is being evacuated
  • "EVACUATE_FAILED,LATENCY": Impending permanent disk failure, evacuation failed due to insufficient resources
  • "EVACUATE_INACCESSIBLE,LATENCY": Impending permanent disk failure, evacuation failed due to inaccessible objects
  • "EVACUATED,LATENCY": Impending permanent disk failure, data evacuation complete
  • "EVACUATING,LOG_CONGESTION": Observed excessive log congestion, data is being evacuated
  • "EVACUATE_FAILED,LOG_CONGESTION": Observed excessive log congestion, evacuation failed due to insufficient resources
  • "EVACUATE_INACCESSIBLE,LOG_CONGESTION": Observed excessive log congestion, evacuation failed due to inaccessible objects
  • "EVACUATED,LOG_CONGESTION": Observed excessive log congestion, data evacuation is complete
  • "EVACUATING,PROPAGATED": Propagated impending permanent disk failure in the diskgroup, data is being evacuated
  • "EVACUATE_FAILED,PROPAGATED": Propagated impending permanent disk failure in the diskgroup, evacuation failed due to insufficient resources
  • "EVACUATE_INACCESSIBLE,PROPAGATED": Propagated impending permanent disk failure in the diskgroup, evacuation failed due to inaccessible objects
  • "EVACUATED,PROPAGATED": Propagated impending permanent disk failure in the diskgroup, data evacuation is complete
  • "TRANSIENT_ERROR": Disk is being repaired due to I/O failures
  • "TRANSIENT_ERROR_IMPACT": Propagated disk issue in the diskgroup
  • "TRANSIENT_ERROR_REPAIR_FAILED": Disk recovery failed
  • "READONLY": Disk is in readonly mode, which should only be set for testing purpose
  • "UNKNOWN": Unknown disk state
string
operationalHealth
Optional

The disk operational health status.

All of possible value are "green", "yellow" and "red"

string
dedupUsageHealth
Optional

The dedup usage health status.

The status will be red if the dedup is enabled on a hybrid diskgroup, the status will be yellow if dedup is not enabled on an all flash diskgroup and it's green in any other situation

string
capacityHealth
Optional

The disk capacity health status

string
summaryHealth
Required

The overall disk health status.

It's the aggregation for the disk operational health, the disk congestion health, disk metadata health, disk capacity health, disk component limit health and disk dedup usage health. All of possible value are "green", "yellow", and "red".

integer As int64 As int64
capacity
Optional

The total disk capacity for written data

integer As int64 As int64
usedCapacity
Optional

The total used disk capacity in byte, which is the larger value between reserved capacity and the data physically written into the disk.

integer As int64 As int64
reservedCapacity
Optional

The total reserved capacity in the disk

integer As int64 As int64
totalBytes
Optional

Ignore this value

integer As int64 As int64
freeBytes
Optional

Ignore this value

integer As int64 As int64
hashedBytes
Optional

Ignore this value

integer As int64 As int64
dedupedBytes
Optional

Ignore this value

scsiDisk
Optional

The SCSI disk information

integer As int64 As int64
usedComponents
Optional

The number of used components on the disk.

When vSAN ESA is not enabled, it represents total used components on the disk. Otherwise it represents used data components only on the disk.

integer As int64 As int64
maxComponents
Optional

The maximum component limit on the disk.

When vSAN ESA is not enabled, it represents the maximum component limit on the disk. Otherwise it represents maximum data components on the disk.

string
compLimitHealth
Optional

The component usage health status.

The status will be red if the used of component number exceeds 95% of total component number limit, the status will be yellow if it exceeds 75% of total component number and it will be green if it's less than 75% of total component number. When vSAN ESA is not enabled, it will check total component usage for this disks. Otherwise, it will check component usage of data and metadata components and then generate overall health status for this disk.

boolean
encryptionEnabled
Optional

Encryption state in disk metadata.

string
kmsProviderId
Optional

The Id of the KMS cluster to use for vSAN Encryption.

Keys will be created on and used from this KMS.

string
kekId
Optional

Key Encryption Key ID in disk metadata.

integer As int64 As int64
dekGenerationId
Optional

Data Encryption Key generation number in disk metadata.

boolean
encryptedUnlocked
Optional

Whether encryption keys for this disk are loaded.

If encryption is on and the encryption keys are not loaded for the disk, the disk cannot be used for vSAN I/O on this host.

rebalanceResult
Optional

The vSAN disk rebalance status

string
dekId
Optional

Data Key Encryption Key ID in disk metadata.

boolean
kekVerifierHealth
Optional

The disk KEK verifier health state.

'True' means the disk KEK verifier has not changed and the disk KEK is healthy, and 'False' means the disk KEK verifier has changed and the disk KEK is unhealthy.

boolean
dekVerifierHealth
Optional

The disk DEK verifier health state.

'True' means the disk DEK verifier has not changed and the disk DEK is healthy, and 'False' means the disk DEK verifier has changed and the disk DEK is unhealthy.

integer As int64 As int64
logicalCapacity
Optional

The logical disk capacity for written data.

It will be nonzero only when cluster deduplication and compression or compression only is enabled. Otherwise, the value is unset(None).

integer As int64 As int64
logicalCapacityUsed
Optional

The total used disk logical capacity in byte.

It will be nonzero only when cluster deduplication and compression or compression only is enabled. Otherwise, the value is unset(None).

string
logicalCapacityHealth
Optional

The health status of disk logical space usage.

The value will be one of "green", "yellow", "red".

string
vsanDiskGroupUuid
Optional

The vSAN disk group UUID.

boolean
dgLayoutIssue
Optional

True indicates the disk is a large capacity drive and the vSAN disk group layout need to be converted to 64 bit to support such disk.

The value is unset(None) if there is no issue found.

integer As int64 As int64
usedMetadataComponents
Optional

The number of used metadata components on the disk.

This is only set when vSAN ESA is enabled.

integer As int64 As int64
maxMetadataComponents
Optional

The maximum metadata component limit on the disk.

This is only set when vSAN ESA is enabled.

string
pendingClusterDekId
Optional

vSAN ESA adds a pending cluster data encryption key into disk metadata to record the new key to encrypt disk metadata in the comming deep rekey.

This is the pending cluster data encryption key id.

boolean
dmekVerifierHealth
Optional

The disk DMEK verifier health state.

'True' means the disk DMEK verifier has not changed and the disk DMEK is healthy, and 'False' means the disk DMEK verifier has changed and the disk DMEK is unhealthy.