Esx Settings Clusters Configuration Reports LastComplianceResult get
This API provides results from the last completed Check Compliance operation on the cluster.
This operation was added in vSphere API 8.0.1.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.ClusterConfiguration.View. - The resource
ClusterComputeResourcereferenced by the parameter cluster requiresVcIntegrity.ClusterConfiguration.View.
Identifier of the cluster
The parameter must be an identifier for the resource type: ClusterComputeResource.
Success!
{
"cluster_status": "string",
"commit": "string",
"software_commit": "string",
"summary": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"validation_errors": [
{
"path": "string",
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
]
}
],
"host_info": {
"host_info": {
"name": "string",
"is_vsan_witness": false
}
},
"hosts": {
"hosts": {
"host_status": {
"status": "string",
"attempts": 0,
"remaining_retries": 0,
"start_time": "string",
"end_time": "string",
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
]
}
},
"summary": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"errors": [
{
"path": "string",
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
]
}
],
"host_compliance": {
"status": "string",
"compliance_info": {
"sets": [
{
"path": "string",
"display_path": [
"string"
],
"current": "string",
"target": "string",
"type": "string",
"reference_current": "string",
"reference_target": "string"
}
],
"adds": [
{
"path": "string",
"display_path": [
"string"
],
"current": "string",
"target": "string",
"type": "string",
"reference_current": "string",
"reference_target": "string"
}
],
"deletes": [
{
"path": "string",
"display_path": [
"string"
],
"current": "string",
"target": "string",
"type": "string",
"reference_current": "string",
"reference_target": "string"
}
]
}
}
}
},
"compliant_hosts": [
"string"
],
"non_compliant_hosts": [
"string"
],
"failed_hosts": [
"string"
],
"skipped_hosts": [
"string"
],
"end_time": "string"
}Consolidated status of all host compliance checks.
For more information see: Esx Settings Clusters Configuration ClusterCompliance Status.
This property was added in vSphere API 8.0.1.0.
This identifier refers to the commit action of importing the desired configuration document. It will not be set for a draft execution of check compliance.
This property was added in vSphere API 8.0.1.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.
The current commit ID for the software associated with the cluster.
This property was added in vSphere API 8.0.1.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.
Summarizing check compliance operation on the hosts in the cluster.
This property was added in vSphere API 8.0.1.0.
This field represents the validation errors if the desired configuration specified is not valid.
This property was added in vSphere API 8.0.3.0.
This field may be set if Esx Settings Clusters Configuration ClusterCompliance.cluster_status is NOT_COMPLIANT due to validation errors.
Map of host IDs to hostname.
This property was added in vSphere API 8.0.1.0.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.
Map of host IDs to their compliance results.
This property was added in vSphere API 8.0.1.0.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.
Identifiers of compliant hosts.
This property was added in vSphere API 8.0.1.0.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.
Identifiers of non-compliant hosts.
This property was added in vSphere API 8.0.1.0.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.
Identifiers of hosts where the operation failed.
This property was added in vSphere API 8.0.1.0.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.
Identifiers of hosts where the operation was skipped. i.e disconnected hosts
This property was added in vSphere API 8.0.1.0.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.
CheckCompliance completion time.
This property was added in vSphere API 8.0.1.0.
If the caller is not authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
If there is no cluster associated with cluster or no last compliance result was found.
"Vapi Std Errors NotFound Object"If there is unknown internal error. The accompanying error message will give more details about the failure.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object" curl -H 'Authorization: <value>' https://{api_host}/api/esx/settings/clusters/{cluster}/configuration/reports/last-compliance-result