[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
Upload Personality
DescriptionUpload Personality to SDDC Manager.
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/personalities
Request Body
Request Body
{
"uploadMode": "RAW, RAW_WITH_FILE_UPLOAD_ID, REFERRED"
}
string
uploadMode
Required
Personality upload mode
string
name
Optional
Personality name
uploadSpecRawMode
Optional
Personality upload spec for upload from RAW files
uploadSpecRawWithFileUploadIdMode
Optional
Personality upload spec for upload using file upload id
uploadSpecReferredMode
Optional
Personality upload spec for upload from REFERRED vcenter cluster
Response
Response
Response BodyResponse Body
200 OK 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
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
string
status
Optional
Task status
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
Code Samples
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"name":"string","uploadMode":"RAW, RAW_WITH_FILE_UPLOAD_ID, REFERRED","uploadSpecRawMode":{"personalityISOFilePath":"string","personalityInfoJSONFilePath":"string","personalityJSONFilePath":"string","personalityZIPFilePath":"string"},"uploadSpecRawWithFileUploadIdMode":{"fileUploadId":"string"},"uploadSpecReferredMode":{"clusterId":"string","vCenterId":"string","vcenterId":"string"}}' https://sfo-vcf01.rainpole.io/v1/personalities
[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
On This Page
Personalities Operations
delete
get
post