Changed1

[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]

vcf-for-vxrail

Precheck System Deprecated

Description

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

URL

post

https://sfo-vcf01.rainpole.io/v1/system/prechecks

Copy

Request Body

PrecheckSpec of type(s) application/json Required

Precheck System Spec

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"
		}
	]
}

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

array of Resource

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

Response

200 OK Response Body>

Response Body

200 OK

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

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 _

202 Accepted Response Body>

Response Body

202 Accepted

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

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 _

Errors

Error

400

Bad Request

Error

500

Internal Server Error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"bundleId":"string","mode":"string","resources":[{"fqdn":"sfo-vc01.rainpole.io","name":"string","resourceId":"BE8A5E04-92A0-43F6-A166-AA041F4327CC","sans":["sfo-vc01.rainpole.io"],"type":"One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"}]}' https://sfo-vcf01.rainpole.io/v1/system/prechecks

vcf-for-vxrail

What's changed in 5.0.0?

CHANGED (1)

System Prechecks Operations

get

Get Precheck Task Changed

post

Precheck System Changed

Precheck System Deprecated

Request

URL

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

What's changed in 5.0.0?

On This Page

System Prechecks Operations

Was this page helpful?