Start Precheck

Start Precheck

Perform precheck of resource(ex: Domain, Cluster). If only resource is specified, all resources/software components under it are included. If resource(Domain, Cluster etc) and specific resources/software components are provided, only those are included in precheck. As this API is deprecated, please use the new LCM Prechecks API - /v1/system/check-sets/queries and /v1/system/check-sets

Request
URI
POST
https://{api_host}/v1/system/prechecks
COPY
Request Body
PrecheckSpec of type(s) application/json
Required

Show optional properties

{
    "resources": [
        {
            "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
            "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI"
        }
    ]
}
{
    "resources": [
        {
            "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
            "fqdn": "sfo-vc01.rainpole.io",
            "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
            "name": "string",
            "sans": [
                "sfo-vc01.rainpole.io"
            ]
        }
    ],
    "bundleId": "string",
    "mode": "string"
}
array of object
resources
Required

List of resources for Precheck supported type DOMAIN, CLUSTER

string
bundleId
Optional

If specified, indicate the bundle applicability in the result

string
mode
Optional

If specified, indicates the mode of the execution. Supported modes are UPGRADE and RECOVERY. UPGRADE is default mode. Specify RECOVERY for the Inventory Consistency Checks

Responses
202

Accepted

Returns Task of type(s) application/json 
"Task Object"
string
id
Required

Task ID

string
name
Required

Task name

object
localizableDescriptionPack
Optional

A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.

string
type
Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

string
status
Required

Task status

string
creationTimestamp
Required

Task creation timestamp

string
completionTimestamp
Optional

Task completion timestamp

array of object
subTasks
Optional

List of sub-tasks of the task

array of object
errors
Optional

List of errors in case of a failure

array of object
resources
Optional

List of resources associated with task

string
resolutionStatus
Optional

Resolution state

boolean
isCancellable
Optional

Represents task can be cancellable or not.

boolean
isRetryable
Optional

Indicates whether a task is eligible for retry or not.


400

Bad Request

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"resources":["object"]}' https://{api_host}/v1/system/prechecks
Deprecated
On This Page
System Prechecks Operations
POST
Start Precheck
Deprecated
GET
Get Precheck Task
Deprecated