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

Commission Hosts

Description

Commission the Hosts

Request

URL

post

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

Copy

Request Body

array of HostCommissionSpec of type(s) application/json Required

hostCommissionSpecs

Show optional properties

{
    "storageType": "One among: VSAN, VSAN_REMOTE, NFS, VMFS_FC, VVOL"
}

{
    "storageType": "One among: VSAN, VSAN_REMOTE, NFS, VMFS_FC, VVOL",
    "vvolStorageProtocolType": "One among: ISCSI, NFS, FC"
}

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

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",
    "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",
    "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 '[{"storageType":"One among: VSAN, VSAN_REMOTE, NFS, VMFS_FC, VVOL","vvolStorageProtocolType":"One among: ISCSI, NFS, FC"}]' https://sfo-vcf01.rainpole.io/v1/hosts

vcf

Hosts Operations

put

Assign Tags To Existing Host Introduced

get

Assignable Tags To Host Introduced

post

Commission Hosts

delete

Decommission Hosts

get

Get Criteria

get

Get Criterion

get

Get Host

get

Get Host Query Response

get

Get Host Tag Manager URL

get

Get Hosts

get

Get Tags Assigned To Host

get

Get Tags Assigned To Hosts Introduced

get

Get Validation For Commission Hosts

post

Post Query

delete

Remove Tags From Host Introduced

post

Validate Hosts Operations

Commission Hosts

Request

URL

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

On This Page

Hosts Operations

Was this page helpful?