[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"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
Post Query
DescriptionPost a query
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/hosts/queries
Request Body
Request Body
{
"name": "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"
}
map of
string
arguments
Optional
Arguments required for a particular criterion
string
description
Optional
Description of the criterion
string
name
Optional
Name of the criterion
Response
Response
Response BodyResponse Body
200 OK
Returns
HostQueryResponse
of type(s) application/json
{
"queryInfo": {
"completed": false,
"errorResponse": {
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"key": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": "Error Object",
"referenceToken": "string",
"remediationMessage": "string"
},
"failure": false,
"processing": false,
"queryId": "string",
"status": "string"
},
"result": {
"elements": [
{
"bundleRepoDatastore": "string",
"cluster": {
"id": "string"
},
"compatibleStorageType": "string",
"cpu": {
"cores": 0,
"cpuCores": [
{
"frequencyMHz": 0,
"manufacturer": "string",
"model": "string"
}
],
"frequencyMHz": 0,
"usedFrequencyMHz": 0
},
"domain": {
"id": "string",
"name": "string"
},
"esxiVersion": "string",
"fqdn": "string",
"hardwareModel": "string",
"hardwareVendor": "string",
"hybrid": false,
"id": "string",
"ipAddresses": [
{
"ipAddress": "string",
"type": "One among: MANAGEMENT, VSAN, VMOTION, NFS"
}
],
"isPrimary": false,
"memory": {
"totalCapacityMB": 0,
"usedCapacityMB": 0
},
"networkpool": {
"id": "string",
"name": "string"
},
"networks": [
{
"freeIps": [
"string"
],
"gateway": "string",
"id": "string",
"ipPools": [
{
"end": "string",
"start": "string"
}
],
"mask": "string",
"mtu": 0,
"subnet": "string",
"type": "string",
"usedIps": [
"string"
],
"vlanId": 0
}
],
"physicalNics": [
{
"deviceName": "string",
"macAddress": "string",
"speed": 0,
"unit": "KB"
}
],
"serialNumber": {
"present": false
},
"softwareInfo": {
"addOn": {
"displayName": "string",
"displayVersion": "string",
"name": "DELL-sample-Addon",
"vendor": "Dell",
"version": "2.0-1"
},
"baseImage": {
"details": {
"displayName": "7.0.0-0.0.30340198",
"displayVersion": "string",
"releaseDate": {
"calendarType": "string",
"firstDayOfWeek": 0,
"lenient": false,
"minimalDaysInFirstWeek": 0,
"time": "string",
"timeInMillis": 0,
"timeZone": {
"displayName": "string",
"dstsavings": 0,
"id": "string",
"rawOffset": 0
},
"weekDateSupported": false,
"weekYear": 0,
"weeksInWeekYear": 0
}
},
"version": "7.0.0-0.0.30340198"
},
"components": {
"key": {
"details": {
"displayName": "string",
"displayVersion": "string",
"vendor": "intel"
},
"version": "1.3.2.8-1OEM.650.0.0.4598673"
}
},
"hardwareSupport": {
"packages": {
"key": {
"pkg": "string",
"version": "string"
}
}
}
},
"sshThumbprint": {
"present": false
},
"sslThumbprint": {
"present": false
},
"status": "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"storage": {
"disks": [
{
"capacityMB": 0,
"diskType": "One among: HDD, FLASH",
"manufacturer": "string",
"model": "string"
}
],
"totalCapacityMB": 0,
"usedCapacityMB": 0
},
"tags": [
{
"categoryId": "string",
"categoryName": "string",
"id": "string",
"name": "string"
}
]
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}
}
Errors
Error
400
Bad Request
Error
500
Internal Server Error
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"name":"One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"}' https://sfo-vcf01.rainpole.io/v1/hosts/queries
[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"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
On This Page
Hosts Operations
post
delete
get
get
get
get
post
delete
