Get Clusters Software Reports Last Check Result

Released in v7.0.0

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

URL

GET

https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/last-check-result

Path Parameters

Required	Parameter Name	Type	Description
required	cluster	string	The cluster identifier. The parameter must be an identifier for the resource type: ClusterComputeResource.

Response

Response Body

200 OK returns LastCheckResultCheckResult 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"
                    },
                    "status": "enum"
                }
            ],
            "cluster": "string",
            "host": "string",
            "status": "enum",
            "type": "enum"
        }
    ],
    "host_info": {
        "key": {
            "name": "string"
        }
    },
    "start_time": "string",
    "status": "enum"
}

Property Name	Type	Description
commit	string	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.
end_time	string	Time when the operation completed.
entity_results	array of LastCheckResultEntityCheckResult	List of LastCheckResult.EntityCheckResult for all entities for which checks have been run.
host_info	map of SettingsHostInfo	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.
start_time	string	Time when the operation started.
status	LastCheckResultStatus Enum	Aggregated status from all checks performed.

Errors

Code	Returns	Description
404	Error	com.vmware.vapi.std.errors.error : If there is an 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 or if there is no result associated with the cluster cluster
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.