Get Clusters Software Reports Last Check Result
Returns the most recent available result of checks run on the cluster before the application of the desired software document to all hosts within the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareRemediation.Read.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/last-check-result
Path Parameters
Path Parameters
string
cluster
Required
The cluster identifier. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SettingsClustersSoftwareReportsLastCheckResultCheckResult
of type application/json
Most recent result available of the checks run on the cluster.
{
"commit": "string",
"end_time": "string",
"entity_results": [
{
"check_statuses": [
{
"check": {
"check": "string",
"description": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"name": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
},
"issues": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"status": "OK"
}
],
"cluster": "string",
"host": "string",
"status": "OK",
"type": "CLUSTER"
}
],
"host_info": {
"key": {
"is_vsan_witness": false,
"name": "string"
}
},
"start_time": "string",
"status": "OK"
}
string
commit
Required
The identifier of the commit on which checks have been run. 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.
string
end_time
Required
Time when the operation completed.
entity_results
Required
List of LastCheckResult.EntityCheckResult for all entities for which checks have been run.
map of
SettingsHostInfo
host_info
Required
Information about the hosts in this cluster for which checks have been requested to be run. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: HostSystem.
string
start_time
Required
Time when the operation started.
status
Required
The LastCheckResult.Status enumerated type defines the status result for a particular check.
OK : The check indicates a success.
WARNING : The check indicates a warning.
TIMEOUT : The check did not return in a timely manner.
ERROR : The check indicates an error.
Possible values are: OK , WARNING , TIMEOUT , ERROR
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or if there is no result associated with the cluster cluster
500
com.vmware.vapi.std.errors.error : If there is an unknown internal error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetClusterSoftwareReportsLastCheckResult -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/last-check-result
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0.0
