Host Vsan Health System Vsan Host Query Encryption Health Summary

Host Vsan Health System Vsan Host Query Encryption Health Summary

Query the encryption health summary on the host.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/HostVsanHealthSystem/{moId}/VsanHostQueryEncryptionHealthSummary
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 HostVsanHealthSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Authentication
This operation uses the following authentication methods.
Responses
200

The encryption health summary result

Returns VsanEncryptionHealthSummary of type(s) application/json 
"VsanEncryptionHealthSummary Object"
string
hostname
Optional

Hostname/IP of host which runs the encryption health check.

encryptionInfo
Optional

Encryption information on the host, including encryption enablement state, Key Encryption Key id, Data Encryption generation number, servers certificate thumbprints, client certificate thumbprint, client key hash, Key Management Servers information.

The encryption information on host will be used for checking consistency with the cluster configuration on vCenter side.

string
overallKmsHealth
Required

The overall KMS cluster health status on the ESXi host.

All of possible value are "green", "red" and "yellow". "green": If all KMS health status are "green". "red": If all KMS health status is "red". "yellow": If at least one KMS health status is "green".

array of object
kmsHealth
Optional

Key Management Servers connection health check result on the host.

array of string
encryptionIssues
Optional

Host inconsistent encryption issues against cluster configuration.

This field can only be set from vCenter side.

See also VsanEncryptionIssueEnum.

array of object
diskResults
Optional

Disk encryption health results on the host.

This field can only be set from vCenter side. See VsanDiskEncryptionHealth.

error
Optional

If error is set, it means that collection of encryption information failed on this host.

boolean
aesniEnabled
Optional

The host CPU AES-NI instruction set enabled state.

If AES-NI was disabled, the software encryption would be significantly slower than AES-NI.

integer As int64 As int64
inconsistentlyEncryptedObjectCount
Optional

The number of encrypted objects whose encryption key is inconsistent with the host encryption configuration, 0 means all objects are consistent.

string
hostEncryptionDekId
Optional

Per host object encryption dek id.

boolean
kekVerifierHealth
Optional

The host Kek Verifier health state, 'True' means the host kek verifier has not changed and is healthy, 'False' means the the host kek verifier has changed and is not healthy

boolean
dekVerifierHealth
Optional

The host Dek Verifier health state, 'True' means the host dek verifier has not changed and is healthy, 'False' means the the host dek verifier has changed and is not healthy


500

Failure

Returns NotFound of type(s) application/json 
"NotFound Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/vsan/HostVsanHealthSystem/{moId}/VsanHostQueryEncryptionHealthSummary
On This Page
V San Service Api Operations
POST
Host Vsan Health System Vsan Host Clomd Liveness
POST
Host Vsan Health System Vsan Host Cleanup Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Create Vm Health Test
POST
Host Vsan Health System Vsan Flash Scsi Controller Firmware Task
Deprecated
POST
Host Vsan Health System Vsan Get Hcl Info
POST
Host Vsan Health System Vsan Get Network Diagnostics Health Info
POST
Host Vsan Health System Vsan Get Proactive Rebalance Info
POST
Host Vsan Health System Vsan Host Prepare Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Query Adv Cfg
POST
Host Vsan Health System Vsan Host Query Check Limits
POST
Host Vsan Health System Vsan Host Query Encryption Health Summary
POST
Host Vsan Health System Vsan Host Query File Service Health Summary
POST
Host Vsan Health System Vsan Query Host EMM State
POST
Host Vsan Health System Vsan Host Query Host Info By Uuids
POST
Host Vsan Health System Vsan Host Query Object Health Summary
POST
Host Vsan Health System Vsan Host Query Physical Disk Health Summary
POST
Host Vsan Health System Vsan Host Query Run Iperf Client
POST
Host Vsan Health System Vsan Host Query Run Iperf Server
POST
Host Vsan Health System Vsan Host Query Smart Stats
POST
Host Vsan Health System Vsan Host Query Verify Network Settings
POST
Host Vsan Health System Vsan Host Query Health System Version
POST
Host Vsan Health System Vsan Host Repair Immediate Objects
POST
Host Vsan Health System Vsan Host Run Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Start Proactive Rebalance
POST
Host Vsan Health System Vsan Stop Proactive Rebalance
POST
Host Vsan Health System Vsan Wait For Vsan Health Generation Id Change