vSAN Management API


Data Object - VsanPhysicalDiskHealth(vim.host.VsanPhysicalDiskHealth)

Property of
VsanDiskEncryptionHealth, VsanPhysicalDiskHealthSummary
Extends
DynamicData
See also
HostScsiDisk, VsanDiskRebalanceResult
Since
vSphere API Release 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 6.6
dekId*xsd:string

Data Key Encryption Key ID in disk metadata.

Since 8.0.0.1
dekVerifierHealth*xsd:boolean

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.

Since 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 8.0.0.2
dmekVerifierHealth*xsd:boolean

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.

Since 8.0.0.3
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 6.6
encryptionEnabled*xsd:boolean

Encryption state in disk metadata.

Since 6.6
formatVersion*xsd:int

The disk format version in vSAN.
freeBytes*xsd:long

Ignore this value
hashedBytes*xsd:long

Ignore this value
inCmmdsxsd:boolean

True indicate this disk can be found in the CMMDS.
inVsixsd: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 6.6
kekVerifierHealth*xsd:boolean

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.

Since 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 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 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 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 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 8.0.0.1
metadataHealth*xsd:string

The vSAN metadata health status. All of possible values are "green", "yellow" and "red"
namexsd: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
pendingClusterDekId*xsd:string

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.

Since 8.0.0.3
rebalanceResult*VsanDiskRebalanceResult

The vSAN disk rebalance status

Since 6.6
reservedCapacity*xsd:long

The total reserved capacity in the disk
scsiDisk*HostScsiDisk

The SCSI disk information
summaryHealthxsd: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 8.0.0.1
uuidxsd:string

The disk device UUID.
vsanDiskGroupUuid*xsd:string

The vSAN disk group UUID.

Since 8.0.0.2
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition