Commission Hosts
Commission the Hosts
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/hosts
Request Body
Request Body
array of
HostCommissionSpec of type(s) application/json
Required
This specification contains the input to commission a host to VMware Cloud Foundation
(The request body parameter is missing description)
[
{
"fqdn": "string",
"networkPoolId": "string",
"password": "string",
"storageType": "One among: VSAN, NFS, VMFS_FC, VVOL",
"username": "string"
}
]
string
fqdn
Required
FQDN of the host
string
networkPoolId
Required
ID of the network pool to associate the host with
string
password
Required
Password of the host
string
storageType
Required
Storage Type
string
username
Required
Username of the host
string
networkPoolName
Optional
Name of the network pool to associate the host with
string
sshThumbprint
Optional
SSH thumbprint of the host
string
sslThumbprint
Optional
SSL thumbprint of the host
string
vvolStorageProtocolType
Optional
vVol Storage Protocol Type
Response
Response
Response BodyResponse 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
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 '[{"fqdn":"string","networkPoolId":"string","networkPoolName":"string","password":"string","sshThumbprint":"string","sslThumbprint":"string","storageType":"One among: VSAN, NFS, VMFS_FC, VVOL","username":"string","vvolStorageProtocolType":"One among: ISCSI, NFS, FC"}]' https://sfo-vcf01.rainpole.io/v1/hosts
On This Page
Hosts Operations
post
delete
get
get
get
get
post
