Get Hosts
Get all hosts
Request
URI
GET
https://sfo-vcf01.rainpole.io/v1/hosts
COPY
Query Parameters
string
status
Optional
Status of the Host.One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE
string
domainId
Optional
ID of the Domain
string
clusterId
Optional
ID of the Cluster
string
networkpoolId
Optional
ID of the Network pool
string
storageType
Optional
Type of the Storage.VMFS_FC
string
datastoreName
Optional
Name of the datastore
Responses
200
Ok
Returns PageOfHost of type(s) application/json
{
"elements": [
{
"bundleRepoDatastore": "string",
"cluster": {
"id": "string"
},
"compatibleStorageType": "string",
"cpu": {
"cores": 0,
"cpuCores": [
{
"frequencyMHz": "number",
"manufacturer": "string",
"model": "string"
}
],
"frequencyMHz": "number",
"usedFrequencyMHz": "number"
},
"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": "number",
"usedCapacityMB": "number"
},
"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": "string"
}
],
"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": {
"components": {
"details": {
"displayName": "string",
"displayVersion": "string",
"vendor": "intel"
},
"version": "1.3.2.8-1OEM.650.0.0.4598673"
}
},
"hardwareSupport": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
}
},
"sshThumbprint": {
"present": false
},
"sslThumbprint": {
"present": false
},
"status": "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"storage": {
"disks": [
{
"capacityMB": "number",
"diskType": "One among: HDD, FLASH",
"manufacturer": "string",
"model": "string"
}
],
"totalCapacityMB": "number",
"usedCapacityMB": "number"
},
"tags": [
{
"categoryId": "string",
"categoryName": "string",
"id": "string",
"name": "string"
}
]
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}
400
Bad Request
Returns Error of type(s) application/json
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message
500
Internal Server Error
Returns Error of type(s) application/json
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}array of string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message
Hosts Operations
PUT
Assign Tags To Host
POST
Commission Hosts
DELETE
Decommission Hosts
GET
Get Assignable Tag For Host
GET
Get Criteria
GET
Get Criterion
GET
Get Host
GET
Get Host Commission Validation By ID
GET
Get Host Query Response 1
GET
Get Hosts
GET
Get Host Tag Manager Url
GET
Get Tags Assigned To Host
GET
Get Tags Assigned To Hosts
POST
Post Query
DELETE
Remove Tags From Host
POST
Validate Host Commission Spec