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

Post Host Query

Description

Post a host query

Request

Request

URL

URL


post
https://sfo-vcf01.rainpole.io/v1/clusters/{id}/hosts/queries
Copy

Path Parameters

Path Parameters

string
id Required

Cluster ID


Request Body

Request Body

HostCriterion of type(s) application/json Required

hostCriterion

{
	"arguments": {
		"key": "string"
	},
	"description": "string",
	"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 Body

Response 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,
		"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"
				},
				"physicalNics": [
					{
						"deviceName": "string",
						"macAddress": "string",
						"speed": 0
					}
				],
				"serialNumber": {
					"present": false
				},
				"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
				}
			}
		],
		"pageMetadata": {
			"pageNumber": 0,
			"pageSize": 0,
			"totalElements": 0,
			"totalPages": 0
		}
	}
}
queryInfo Optional

Query info


result Optional

Query result

Errors

Errors

400

Bad Request


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"arguments":{"key":"string"},"description":"string","name":"One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"}' https://sfo-vcf01.rainpole.io/v1/clusters/{id}/hosts/queries


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

Was this page helpful?