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

Post Host Query

Description

Post a host query

Request

URL

post

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

Copy

Path Parameters

string

id Required

Cluster ID

Request Body

HostCriterion of type(s) application/json Required

hostCriterion

{
    "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 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"
				},
				"physicalNics": [
					{
						"deviceName": "string",
						"macAddress": "string",
						"speed": 0,
						"unit": "KB"
					}
				],
				"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
				},
				"tags": [
					{
						"categoryId": "string",
						"categoryName": "string",
						"id": "string",
						"name": "string"
					}
				]
			}
		],
		"pageMetadata": {
			"pageNumber": 0,
			"pageSize": 0,
			"totalElements": 0,
			"totalPages": 0
		}
	}
}

QueryInfo

queryInfo Optional

Query info

PageOfHost

result Optional

Query result

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/clusters/{id}/hosts/queries

vcf-for-vxrail

Clusters Operations

post

Assign Tags To Cluster Introduced

get

Attachable Tags To Cluster Introduced

post

Create Cluster

delete

Delete Cluster

post

Detach Tags From Cluster Introduced

get

Get Cluster

get

Get Cluster Create Validation

get

Get Cluster Tag Manager URL Introduced

get

Get Cluster Update Validation

get

Get Clusters

get

Get Host Criteria

get

Get Host Criterion

get

Get Host Query Response

get

Get Tags Assigned To Cluster Introduced

get

Get VDses

post

Post Host Query

patch

Update Cluster

post

Validate Cluster Operations

post

Validate Clusters Operations

Post Host Query

Request

URL

Path Parameters

Request Body

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Clusters Operations

Was this page helpful?