Upload Personality

Description

Upload Personality to SDDC Manager.

Request

URL

post

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

Copy

Request Body

PersonalityUploadSpec of type(s) application/json Required

Personality Upload Specification

Show optional properties

{
	"uploadMode": "RAW, RAW_WITH_FILE_UPLOAD_ID, REFERRED"
}

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

string

uploadMode Required

Personality upload mode

string

name Optional

Personality name

PersonalityUploadSpecRaw

uploadSpecRawMode Optional

Personality upload spec for upload from RAW files

PersonalityUploadSpecRawWithFileUploadId

uploadSpecRawWithFileUploadIdMode Optional

Personality upload spec for upload using file upload id

PersonalityUploadSpecReferred

uploadSpecReferredMode Optional

Personality upload spec for upload from REFERRED vcenter cluster

Response

Response 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

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

500

Internal Server Error

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

Upload Personality

Request

URL

Request Body

Response

Response Body

Errors

Code Samples

cURL Command

On This Page

Personalities Operations

Was this page helpful?