Get Cluster Configuration Reports Last Precheck Result

This API returns results from the last Precheck operation on the cluster. if you do not have all of the privileges described as follows:

Operation execution requires VcIntegrity.ClusterConfiguration.View.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Request

URI

GET

https://{api_host}/api/esx/settings/clusters/{cluster}/configuration/reports/last-precheck-result

COPY

Path Parameters

string

cluster

Required

Identifier of the cluster The parameter must be an identifier for the resource type: ClusterComputeResource.

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

Most recent available result of Precheck.

Returns Settings_Clusters_Configuration_ClusterPrecheckResult of type(s) application/json

{
    "status": "string",
    "commit": "string",
    "software_commit": "string",
    "end_time": "string",
    "summary": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": {
                    "id": "string",
                    "params": {
                        "params": "Std_LocalizationParam Object"
                    }
                },
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "remediation_summary": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "remediation_notes": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "validation_errors": [
        {
            "path": "string",
            "messages": [
                "Std_LocalizableMessage Object"
            ]
        }
    ],
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "host_precheck": {
        "host_precheck": {
            "status": {
                "status": "string",
                "attempts": 0,
                "remaining_retries": 0,
                "start_time": "string",
                "end_time": "string",
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Std_LocalizableMessage Object",
                            "resolution": "Std_LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Std_LocalizableMessage Object",
                            "resolution": "Std_LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Std_LocalizableMessage Object",
                            "resolution": "Std_LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            },
            "summary": "Std_LocalizableMessage Object",
            "validation_errors": [
                "Settings_Clusters_Configuration_ValidationError Object"
            ],
            "impact": {
                "impact": "string",
                "info": [
                    "Std_LocalizableMessage Object"
                ]
            },
            "precheck_result": {
                "status": "string",
                "check_statuses": [
                    {
                        "check": {
                            "check": "string",
                            "name": "Std_LocalizableMessage Object",
                            "description": "Std_LocalizableMessage Object"
                        },
                        "status": "Settings_Status Object",
                        "originator": "string",
                        "errors": [
                            {
                                "description": "Std_LocalizableMessage Object",
                                "resolution": "Std_LocalizableMessage Object"
                            }
                        ]
                    }
                ]
            }
        }
    },
    "precheck_result": {
        "status": "string",
        "check_statuses": [
            {
                "check": {
                    "check": "string",
                    "name": "Std_LocalizableMessage Object",
                    "description": "Std_LocalizableMessage Object"
                },
                "status": "Settings_Status Object",
                "originator": "string",
                "errors": [
                    {
                        "description": "Std_LocalizableMessage Object",
                        "resolution": "Std_LocalizableMessage Object"
                    }
                ]
            }
        ]
    },
    "successful_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "skipped_hosts": [
        "string"
    ]
}

Settings_Clusters_Configuration_ClusterPrecheckResult_Status

status

Required

The ClusterPrecheckResult.Status enumerated type contains the possible statuses of the Precheck API on the cluster.
RUNNING : The task is in-progress.
OK : The operation completed successfully.
ERROR : The operation failed with errors.

string

commit

Optional

This identifier refers to the commit action of importing the desired configuration document. This field is s not set for a precheck of a draft configuration. 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

software_commit

Required

The current commit ID for the software associated with the cluster. 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 As date-time

end_time

Required

Precheck completion time.

Std_LocalizableMessage

summary

Required

The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

array of Std_LocalizableMessage

remediation_summary

Required

Summarizing remediation stating number of hosts needing reboot and maintenance mode during remediation and number of precheck errors on host and cluster.

array of Std_LocalizableMessage

remediation_notes

Required

Static notes to the user describing steps that will be taken during remediation.

array of Settings_Clusters_Configuration_ValidationError

validation_errors

Optional

This field represents the validation errors if the desired configuration specified is not valid. This field is set if #Status#status is ERROR due to validation errors.

object

host_info

Required

Map of host IDs to hostname 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.

object

host_precheck

Required

Map of host IDs to their precheck results. If ClusterPrecheckResult.status is ERROR, This field will contain Validation errors or Host Impact and Health Check errors. If ClusterPrecheckResult.status is OK, This field will contain Impact and Health Check information. 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.

Settings_StatusInfo

precheck_result

Optional

The StatusInfo structure contains fields that describe aggregated status of all checks performed on an entity.

array of string

successful_hosts

Required

Hosts in this cluster where the precheck was sucessfully run. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

array of string

failed_hosts

Required

Hosts in this cluster where the precheck failed to run. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

array of string

skipped_hosts

Required

Hosts in this cluster where the precheck was not tried because the host was disconnected. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

401

com.vmware.vapi.std.errors.unauthenticated : If the caller is not authenticated.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

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.

object

data

Optional

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 ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.

403

com.vmware.vapi.std.errors.unauthorized : if the caller does not have the necessary privileges to perform the request.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

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.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

500

com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

503

com.vmware.vapi.std.errors.service_unavailable : If the service is not available.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

default

'Default' means this response is used for all HTTP codes that are not covered individually for this operation.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        "Std_LocalizableMessage Object"
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/esx/settings/clusters/{cluster}/configuration/reports/last-precheck-result

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Settings Operations

GET

Get Cluster Configuration Reports Last Precheck Result