[{"label":"Latest (4.4.0)","version":"latest"},{"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

Deploy vRSLCM

Description

Triggers the vRealize Suite Lifecycle Manager deployment operation and returns an URL in the headers to track the operation status.

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/vrslcms

Copy

Request Body

VrslcmDeploymentSpec of type(s) application/json Required

vRealize Suite Lifecycle Manager Deployment Specification

{
	"apiPassword": "string",
	"fqdn": "vrslcm.vrack.vsphere.local",
	"nsxtStandaloneTier1Ip": "string",
	"sshPassword": "string"
}

string

apiPassword Required

The password for an admin API/UI user of vRealize Suite Lifecycle Manager

string

fqdn Required

Fully Qualified Domain Name

string

nsxtStandaloneTier1Ip Required

The IP to use for deploying a new standalone Tier-1 router in NSX-T. This router will be used subsequently for vrealize load balancers.

string

sshPassword Required

The password for a root user of vRealize Suite Lifecycle Manager appliance

Response

Response Body

202 Accepted returns Task of type(s) application/json

{
	"completionTimestamp": "string",
	"creationTimestamp": "string",
	"errors": [
		{
			"arguments": [
				"string"
			],
			"causes": [
				{
					"message": "string",
					"type": "string"
				}
			],
			"context": {
				"key": "string"
			},
			"errorCode": "string",
			"errorType": "string",
			"message": "string",
			"nestedErrors": "Error Object",
			"referenceToken": "string",
			"remediationMessage": "string"
		}
	],
	"id": "string",
	"isCancellable": false,
	"name": "string",
	"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
	"resources": [
		{
			"fqdn": "string",
			"name": "string",
			"resourceId": "string",
			"sans": [
				"string"
			],
			"type": "string"
		}
	],
	"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
	"subTasks": [
		{
			"completionTimestamp": "string",
			"creationTimestamp": "string",
			"description": "string",
			"errors": [
				{
					"arguments": [
						"string"
					],
					"causes": [
						{
							"message": "string",
							"type": "string"
						}
					],
					"context": {
						"key": "string"
					},
					"errorCode": "string",
					"errorType": "string",
					"message": "string",
					"nestedErrors": "Error Object",
					"referenceToken": "string",
					"remediationMessage": "string"
				}
			],
			"name": "string",
			"resources": [
				{
					"fqdn": "string",
					"name": "string",
					"resourceId": "string",
					"sans": [
						"string"
					],
					"type": "string"
				}
			],
			"stages": [
				{
					"completionTimestamp": "string",
					"creationTimestamp": "string",
					"description": "string",
					"errors": [
						{
							"arguments": [
								"string"
							],
							"causes": [
								{
									"message": "string",
									"type": "string"
								}
							],
							"context": {
								"key": "string"
							},
							"errorCode": "string",
							"errorType": "string",
							"message": "string",
							"nestedErrors": "Error Object",
							"referenceToken": "string",
							"remediationMessage": "string"
						}
					],
					"name": "string",
					"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
					"type": "string"
				}
			],
			"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
			"subTasks": "SubTask Object",
			"type": "string"
		}
	],
	"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.

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

405

Method Not Allowed

Error

500

Internal Server Error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"apiPassword":"string","fqdn":"vrslcm.vrack.vsphere.local","nsxtStandaloneTier1Ip":"string","sshPassword":"string"}' https://sfo-vcf01.rainpole.io/v1/vrslcms

vcf-for-vxrail

vRSLCM Operations

post

Deploy vRSLCM

get

Get vRSLCM

get

Get vRSLCM Validation

get

Get vRSLCMs

delete

Rollback vRSLCM

post

Validate vRSLCM

Deploy vRSLCM

Request

URL

Request Body

Response

Response Body

Errors

Code Samples

cURL Command

On This Page

vRSLCM Operations

Was this page helpful?