# Data Object - VsanPhysicalDiskHealth(vim.host.VsanPhysicalDiskHealth)

Property of
  VsanDiskEncryptionHealth, VsanPhysicalDiskHealthSummary
Extends
  DynamicData
See also
  HostScsiDisk, VsanDiskRebalanceResult
Since
  vSphere API 5.5

## Data Object Description

The class for the vSAN physical disk health result.

Properties

Name | Type | Description
--- | --- | ---
capacity* | xsd:long | The total disk capacity for written data
capacityHealth* | xsd:string | The disk capacity health status
compLimitHealth* | xsd:string | 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.
congestionArea* | xsd:string | 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'.
congestionHealth* | xsd:string | 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.
congestionValue* | xsd:int | 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.
dedupedBytes* | xsd:long | Ignore this value
dedupScope* | xsd:long | 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.
dedupUsageHealth* | xsd:string | 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
dekGenerationId* | xsd:long | Data Encryption Key generation number in disk metadata. Since vSAN API 6.6
dekId* | xsd:string | Data Key Encryption Key ID in disk metadata. Since vSAN API 8.0.0.1
dekVerifierHealth* | xsd:boolean | The disk Dek Verifier health state, 'True' means the disk dek verifier has not changed and is healthy, 'False' means the the disk dek verifier has changed and is not healthy Since vSAN API 7.4
dgLayoutIssue* | xsd:boolean | 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. Since vSAN API 8.0.0.2
encryptedUnlocked* | xsd:boolean | 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. Since vSAN API 6.6
encryptionEnabled* | xsd:boolean | Encryption state in disk metadata. Since vSAN API 6.6
formatVersion* | xsd:int | The disk format version in vSAN.
freeBytes* | xsd:long | Ignore this value
hashedBytes* | xsd:long | Ignore this value
inCmmds | xsd:boolean | True indicate this disk can be found in the CMMDS.
inVsi | xsd:boolean | True indicates this disk can be found through VSI.
isAllFlash* | xsd:int | Flag to indicate if it's all flash configuration. The value is 1 if the disk group are all flash disk.
kekId* | xsd:string | Key Encryption Key ID in disk metadata. Since vSAN API 6.6
kekVerifierHealth* | xsd:boolean | The disk Kek Verifier health state, 'True' means the disk kek verifier has not changed and is healthy, 'False' means the the disk kek verifier has changed and is not healthy Since vSAN API 7.4
kmsProviderId* | xsd:string | The Id of the KMS cluster to use for vSAN Encryption. Keys will be created on and used from this KMS. Since vSAN API 6.6
logicalCapacity* | xsd:long | 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). Since vSAN API 8.0.0.2
logicalCapacityHealth* | xsd:string | The health status of disk logical space usage. The value will be one of "green", "yellow", "red". Since vSAN API 8.0.0.2
logicalCapacityUsed* | xsd:long | 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). Since vSAN API 8.0.0.2
maxComponents* | xsd:long | 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.
maxMetadataComponents* | xsd:long | The maximum metadata component limit on the disk. This is only set when vSAN ESA is enabled. Since vSAN API 8.0.0.1
metadataHealth* | xsd:string | The vSAN metadata health status. All of possible values are "green", "yellow" and "red"
name | xsd:string | The physical disk name with the format like "mpx.vmhba1:C0:T2:L0".
operationalHealth* | xsd:string | The disk operational health status. All of possible value are "green", "yellow" and "red"
operationalHealthDescription* | xsd:string | 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
rebalanceResult* | VsanDiskRebalanceResult | The vSAN disk rebalance status Since vSAN API 6.6
reservedCapacity* | xsd:long | The total reserved capacity in the disk
scsiDisk* | HostScsiDisk | The SCSI disk information
summaryHealth | xsd:string | 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".
totalBytes* | xsd:long | Ignore this value
usedCapacity* | xsd:long | The total used disk capacity in byte, which is the larger value between reserved capacity and the data physically written into the disk.
usedComponents* | xsd:long | 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.
usedMetadataComponents* | xsd:long | The number of used metadata components on the disk. This is only set when vSAN ESA is enabled. Since vSAN API 8.0.0.1
uuid | xsd:string | The disk device UUID.
vsanDiskGroupUuid* | xsd:string | The vSAN disk group UUID. Since vSAN API 8.0.0.2
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPhysicalDiskHealth"> <complexContent> <extension base="vsan:DynamicData"> <sequence> <element name="name" type="xsd:string"/> <element name="uuid" type="xsd:string"/> <element name="inCmmds" type="xsd:boolean"/> <element name="inVsi" type="xsd:boolean"/> <element name="dedupScope" type="xsd:long" minOccurs="0"/> <element name="formatVersion" type="xsd:int" minOccurs="0"/> <element name="isAllFlash" type="xsd:int" minOccurs="0"/> <element name="congestionValue" type="xsd:int" minOccurs="0"/> <element name="congestionArea" type="xsd:string" minOccurs="0"/> <element name="congestionHealth" type="xsd:string" minOccurs="0"/> <element name="metadataHealth" type="xsd:string" minOccurs="0"/> <element name="operationalHealthDescription" type="xsd:string" minOccurs="0"/> <element name="operationalHealth" type="xsd:string" minOccurs="0"/> <element name="dedupUsageHealth" type="xsd:string" minOccurs="0"/> <element name="capacityHealth" type="xsd:string" minOccurs="0"/> <element name="summaryHealth" type="xsd:string"/> <element name="capacity" type="xsd:long" minOccurs="0"/> <element name="usedCapacity" type="xsd:long" minOccurs="0"/> <element name="reservedCapacity" type="xsd:long" minOccurs="0"/> <element name="totalBytes" type="xsd:long" minOccurs="0"/> <element name="freeBytes" type="xsd:long" minOccurs="0"/> <element name="hashedBytes" type="xsd:long" minOccurs="0"/> <element name="dedupedBytes" type="xsd:long" minOccurs="0"/> <element name="scsiDisk" type="vsan:HostScsiDisk" minOccurs="0"/> <element name="usedComponents" type="xsd:long" minOccurs="0"/> <element name="maxComponents" type="xsd:long" minOccurs="0"/> <element name="compLimitHealth" type="xsd:string" minOccurs="0"/> <element name="encryptionEnabled" type="xsd:boolean" minOccurs="0"/> <element name="kmsProviderId" type="xsd:string" minOccurs="0"/> <element name="kekId" type="xsd:string" minOccurs="0"/> <element name="dekGenerationId" type="xsd:long" minOccurs="0"/> <element name="encryptedUnlocked" type="xsd:boolean" minOccurs="0"/> <element name="rebalanceResult" type="vsan:VsanDiskRebalanceResult" minOccurs="0"/> <element name="dekId" type="xsd:string" minOccurs="0"/> <element name="kekVerifierHealth" type="xsd:boolean" minOccurs="0"/> <element name="dekVerifierHealth" type="xsd:boolean" minOccurs="0"/> <element name="logicalCapacity" type="xsd:long" minOccurs="0"/> <element name="logicalCapacityUsed" type="xsd:long" minOccurs="0"/> <element name="logicalCapacityHealth" type="xsd:string" minOccurs="0"/> <element name="vsanDiskGroupUuid" type="xsd:string" minOccurs="0"/> <element name="dgLayoutIssue" type="xsd:boolean" minOccurs="0"/> <element name="usedMetadataComponents" type="xsd:long" minOccurs="0"/> <element name="maxMetadataComponents" type="xsd:long" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>