Get Clusters Software Reports Hardware Compatibility
Released in v7.0.0 DescriptionReturns the hcl validation check summary.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
SettingsClustersSoftwareReportsHardwareCompatibilityCheckSummary
of type application/json
CheckSummary hcl validation summary.
{
"base_image_version": "string",
"commit": "string",
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"scan_time": "string",
"status": "enum"
}| Property Name | Type | Description |
|---|---|---|
| base_image_version | string |
Target base image version E.g., version = BaseImageSpec->Version BaseImageSpec.version structure |
| notifications | SettingsNotifications |
Notifications returned by the HCL Validation operation. |
| scan_time | string |
HCL Validation check time. |
| status | SettingsClustersSoftwareReportsHardwareCompatibilityComplianceStatus Enum |
Overall compliance state of HCL Validation on the host. |
| summary_result | Std_LocalizableMessage |
Over all Compliance result for cluster for the software specification. |
| commit | string |
Spec Identifier of the desired configuration on which the HCL scan is performed to generate this result, populated by the HCL validation. unset if validation is performed with no spec When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility
Errors
| Code | Returns | Description |
|---|---|---|
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is some other unknown internal error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system. |
