Vsan Vc Cluster Config System Run Lifecycle Check

Vsan Vc Cluster Config System Run Lifecycle Check

Run checks for lifecycle operations on a given vSAN cluster.

The specification indicates the lifecycle operation for which checks will be performed. The result contains an overall status of the checks, a list of the checks run, and vSAN cluster configurations details related to the checks. The overall status of the checks in the result represents the highest severity status of all the results of the individual checks. For example, if all tests pass, the highest severity status is green. If a test results in yellow status and another in red status, the overall status will be red. The list of checks contains a description of the check, its result status and in case of failure, a localized error message. The vSAN cluster configuration details contains information like witness host and fault domains information for stretched clusters, or no witness host information to indicate single-site cluster.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterConfigSystem/{moId}/RunLifecycleCheck
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanVcClusterConfigSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body
RunLifecycleCheckRequestType of type(s) application/json
Required 
"RunLifecycleCheckRequestType Object"
cluster
Required

Cluster on which to perform lifecycle checks and return configuration information.

vsanLifecycleCheckSpec
Required

Specification for the lifecycle checks.

Authentication
This operation uses the following authentication methods.
Responses
200

Lifecycle checks and configuration results.

Returns VsanVcLifecycleCheckResult of type(s) application/json 
"VsanVcLifecycleCheckResult Object"
string
status
Required

The overall status of the lifecycle checks: green) All checks passed yellow) At least one yellow status check, no red status checks red) At least one red status check, yellow status checks also possible

See also VsanHealthStatusTypeEnum.

array of object
preCheckResults
Optional

The list of results for lifecycle checks.

Check LifecyclePreCheckResult for details.

configDetails
Required

vSAN cluster configuration details.


500

VsanFault: If any unexpected runtime fault is met.

Returns VsanFault of type(s) application/json 
"VsanFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterConfigSystem/{moId}/RunLifecycleCheck
On This Page
V San Service Api Operations
POST
Vsan Vc Cluster Config System Vsan Cluster Get Claimed Capacity
POST
Vsan Vc Cluster Config System Vsan Cluster Get Config
POST
Vsan Vc Cluster Config System Vsan Cluster Get Runtime Stats
POST
Vsan Vc Cluster Config System Vsan Query Cluster Drs Stats
POST
Vsan Vc Cluster Config System Vsan Cluster Reconfig
POST
Vsan Vc Cluster Config System Vsan Encrypted Cluster Rekey Task
POST
Vsan Vc Cluster Config System Run Lifecycle Check
POST
Vsan Vc Cluster Config System Vsan Validate Config Spec