Esx Settings Clusters Configuration Reports LastPrecheckResult get

Esx Settings Clusters Configuration Reports LastPrecheckResult get

This API returns results from the last Precheck 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 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.
Responses
200

Most recent available result of Precheck.

{
    "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": "Vapi Std NestedLocalizableMessage 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": "Vapi Std NestedLocalizableMessage 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": "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
        }
    },
    "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": {
                                "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"
            },
            "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"
                        }
                    ]
                }
            ],
            "impact": {
                "impact": "string",
                "info": [
                    {
                        "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"
                    }
                ]
            },
            "precheck_result": {
                "status": "string",
                "check_statuses": [
                    {
                        "check": {
                            "check": "string",
                            "name": {
                                "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"
                            },
                            "description": {
                                "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"
                            }
                        },
                        "status": "string",
                        "originator": "string",
                        "errors": [
                            {
                                "description": {
                                    "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"
                                }
                            }
                        ]
                    }
                ]
            }
        }
    },
    "precheck_result": {
        "status": "string",
        "check_statuses": [
            {
                "check": {
                    "check": "string",
                    "name": {
                        "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"
                    },
                    "description": {
                        "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"
                    }
                },
                "status": "string",
                "originator": "string",
                "errors": [
                    {
                        "description": {
                            "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"
                        }
                    }
                ]
            }
        ]
    },
    "successful_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "skipped_hosts": [
        "string"
    ]
}
string
status
Required

Overall status of precheck on the cluster. Operation is sucessfull when precheck is run on all hosts successfully and no validation or precheck errors are detected.

For more information see: Esx Settings Clusters Configuration ClusterPrecheckResult Status.

This property was added in vSphere API 8.0.1.0.

string
commit
Optional

This identifier refers to the commit action of importing the desired configuration document.

This property was added in vSphere API 8.0.1.0.

This field is s not set for a precheck of a draft configuration.

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.

string
software_commit
Required

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.

string As date-time As date-time
end_time
Required

Precheck completion time.

This property was added in vSphere API 8.0.1.0.

summary
Required

Summarizing precheck operation on the host and cluster.

This property was added in vSphere API 8.0.1.0.

array of object
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.

This property was added in vSphere API 8.0.1.0.

array of object
remediation_notes
Required

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

This property was added in vSphere API 8.0.1.0.

array of object
validation_errors
Optional

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 is set if Esx Settings Clusters Configuration ClusterPrecheckResult Status is ERROR due to validation errors.

object
host_info
Required

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.

object
host_precheck
Required

Map of host IDs to their precheck results. If Esx Settings Clusters Configuration ClusterPrecheckResult.status is ERROR, This field will contain Validation errors or Host Impact and Health Check errors. If Esx Settings Clusters Configuration ClusterPrecheckResult.status is OK, This field will contain Impact and Health Check information.

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.

precheck_result
Optional

This field represents the precheck results on the cluster, if any one host in the cluster needs to be put in maintenance mode or to be rebooted.

This property was added in vSphere API 8.0.1.0.

This field is set if cluster prechecks are invoked.

array of string
successful_hosts
Required

Hosts in this cluster where the precheck was sucessfully run.

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.

array of string
failed_hosts
Required

Hosts in this cluster where the precheck failed to run.

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.

array of string
skipped_hosts
Required

Hosts in this cluster where the precheck was not tried because the host was disconnected.

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.


401

If the caller is not authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

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.


403

if the caller does not have the necessary privileges to perform the request.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0
"Vapi Std Errors Unauthorized Object"

404

If there is no cluster associated with cluster in the system or if there is no result associated with the cluster cluster.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

500

If there is unknown internal error. The accompanying error message will give more details about the failure.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
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 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.

string
error_type
Required

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.


503

If the service is not available.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0
"Vapi Std Errors ServiceUnavailable Object"

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