[{"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/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Get Hosts
DescriptionGet the Hosts
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/hosts
Query Parameters
Query Parameters
string
clusterId
Optional
ID of the Cluster
string
datastoreName
Optional
Name of the datastore
string
domainId
Optional
ID of the Domain
string
networkpoolId
Optional
ID of the Network pool
string
status
Optional
Status of the Host.One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE
string
storageType
Optional
Type of the Storage.VMFS_FC
Response
Response
Response BodyResponse Body
200 OK
Returns
PageOfHost
of type(s) application/json
{
"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 https://sfo-vcf01.rainpole.io/v1/hosts
[{"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/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
On This Page
Hosts Operations
get
get
get
get
post
delete
