Post Host Query
Post a host query
Post a host query
Request
URI
POST
https://{api_host}/v1/clusters/{id}/hosts/queries
COPY
Path Parameters
string
id
Required
Cluster ID
Request Body
HostCriterion
of type(s)
application/json
Required
{
"name": "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR, UNMANAGED_HOSTS_IN_HCIMGR_MANUAL_DISCOVERY",
"subCriteria": [
{
"name": "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR, UNMANAGED_HOSTS_IN_HCIMGR_MANUAL_DISCOVERY",
"subCriteria": [
"HostCriterion Object"
],
"arguments": {
"arguments": "string"
},
"description": "string"
}
],
"arguments": {
"arguments": "string"
},
"description": "string"
}
string
name
Read-Only
Name of the criterion
array of
HostCriterion
subCriteria
Read-Only
Collection of sub-criterion supported on this criterion
object
arguments
Read-Only
Arguments required for a particular criterion
string
description
Read-Only
Description of the criterion
Responses
202
Accepted
Returns
HostQueryResponse
of type(s)
application/json
{
"queryInfo": {
"status": "string",
"queryId": "string",
"errorResponse": {
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"referenceToken": "string"
}
],
"referenceToken": "string"
},
"failure": false,
"completed": false,
"processing": false
},
"result": {
"elements": [
{
"id": "string",
"serialNumber": "string",
"esxiVersion": "string",
"sshThumbprint": "string",
"sslThumbprint": "string",
"fqdn": "string",
"hardwareVendor": "string",
"hardwareModel": "string",
"isPrimary": false,
"isVsanEsaEligible": false,
"ipAddresses": [
{
"ipAddress": "string",
"type": "One among: MANAGEMENT, VSAN, VMOTION, NFS, VSAN_EXTERNAL"
}
],
"cpu": {
"frequencyMHz": "number",
"usedFrequencyMHz": "number",
"cores": 0,
"cpuCores": [
{
"frequencyMHz": "number",
"model": "string",
"manufacturer": "string"
}
]
},
"memory": {
"totalCapacityMB": "number",
"usedCapacityMB": "number"
},
"storage": {
"totalCapacityMB": "number",
"usedCapacityMB": "number",
"disks": [
{
"capacityMB": "number",
"diskType": "One among: HDD, FLASH",
"manufacturer": "string",
"model": "string"
}
]
},
"physicalNics": [
{
"deviceName": "string",
"macAddress": "string",
"speed": 0,
"unit": "string",
"smartNicInfo": {
"vendorName": "string",
"dpuId": "string"
},
"state": "One among: INACTIVE, ACTIVE_IN_USE, ACTIVE_NOT_IN_USE"
}
],
"networks": [
{
"id": "string",
"type": "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL",
"vlanId": 0,
"mtu": 0,
"subnet": "string",
"mask": "string",
"gateway": "string",
"ipPools": [
{
"start": "string",
"end": "string"
}
],
"freeIps": [
"string"
],
"usedIps": [
"string"
]
}
],
"hostNetworks": [
{
"type": "string",
"vlanId": 0,
"mtu": 0
}
],
"domain": {
"id": "string",
"name": "string",
"type": "string"
},
"networkpool": {
"id": "string",
"name": "string"
},
"cluster": {
"id": "string",
"name": "string"
},
"status": "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
"compatibleStorageType": "string",
"bundleRepoDatastore": "string",
"hybrid": false,
"softwareInfo": {
"baseImage": {
"version": "7.0.0-0.0.30340198",
"details": {
"displayName": "7.0.0-0.0.30340198",
"displayVersion": "string",
"releaseDate": "string",
"releaseTimestamp": "string",
"quickPatchCompatibleVersions": [
{
"version": "8.0.3-0.0.23174786",
"displayVersion": "8.0 Update 3 - 23174786"
}
]
}
},
"addOn": {
"version": "2.0-1",
"name": "DELL-sample-Addon",
"vendor": "Dell",
"displayName": "string",
"displayVersion": "string"
},
"components": {
"components": {
"version": "1.3.2.8-1OEM.650.0.0.4598673",
"details": {
"vendor": "intel",
"displayName": "string",
"displayVersion": "string"
}
}
},
"removedComponents": {
"removedComponents": {
"version": "1.3.2.8-1OEM.650.0.0.4598673",
"details": {
"vendor": "intel",
"displayName": "string",
"displayVersion": "string"
}
}
},
"hardwareSupport": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
}
},
"tags": [
{
"id": "string",
"name": "string",
"categoryId": "string",
"categoryName": "string"
}
],
"configurationStatus": "One among: ACTIVE, ACTIVATING, UPGRADING, DISABLED, ERROR, SKIPPED, DEACTIVATING, EXPANDING, SHRINKING, CREATING",
"datastoreType": "One among: VSAN, VSAN_ESA, VSAN_MAX, NFS, FC, VVOL, VSAN_REMOTE"
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}
}
object
queryInfo
Read-Only
Represents the query info.
object
result
Read-Only
Represents a page of elements of a single type
400
Bad Request
Returns
Error
of type(s)
application/json
"Error Object"
string
errorCode
Read-Only
The minor error code
string
errorType
Read-Only
The error type
array of
string
arguments
Read-Only
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Read-Only
The error context (e.g. the component where it occurred).
string
message
Read-Only
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
string
referenceToken
Read-Only
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
500
InternalServerError
Returns
Error
of type(s)
application/json
"Error Object"
string
errorCode
Read-Only
The minor error code
string
errorType
Read-Only
The error type
array of
string
arguments
Read-Only
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Read-Only
The error context (e.g. the component where it occurred).
string
message
Read-Only
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
string
referenceToken
Read-Only
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v1/clusters/{id}/hosts/queries
Clusters Operations
GET
Get Tags Assigned To Cluster
PUT
Assign Tags To Cluster
DELETE
Remove Tags From Cluster
GET
Get Clusters
POST
Create Cluster
POST
Validate Cluster Update Spec
POST
Get Cluster Network Configuration
POST
Post Host Query
GET
Get Cluster Datastores
POST
Add Datastore To Cluster
POST
Post Datastore Query 1
GET
Get Vdses
POST
Import Vds To Inventory
POST
Validate Vsan Remote Datastore Mount Spec
POST
Validate Vsan Remote Datastore Spec
Deprecated
POST
Validate Cluster Creation Spec
GET
Get Cluster
DELETE
Delete Cluster
PATCH
Update Cluster
GET
Get Cluster Update Validation
GET
Get Cluster Tag Manager Url
GET
Get Tag Assignable For Cluster
GET
Get Cluster Network Configuration Query Response
GET
Get Cluster Network Configuration Criteria
GET
Get Cluster Image Compliance
GET
Get Host Criteria
GET
Get Host Criterion
GET
Get Datastores Criteria 1
GET
Get Datastore Criterion 1
GET
Get Host Query Response 1
GET
Get Datastore Query Response 1
GET
Get Cluster Create Validation
GET
Get Tags Assigned To Clusters
DELETE
Remove Datastore From Cluster