[{"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

Get Hosts

Description

Get the Hosts

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/hosts
Copy

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 Body

Response 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"
			},
			"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
			},
			"tags": [
				{
					"categoryId": "string",
					"categoryName": "string",
					"id": "string",
					"name": "string"
				}
			]
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}
array of Host
elements Optional

The list of elements included in this page


pageMetadata Optional

Pageable elements pagination metadata information

Errors

Errors

400

Bad Request


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/hosts


[{"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?