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

Description

Get a Host

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

id


Response

Response

Response Body

Response Body

200 OK returns Host of type(s) application/json
{
	"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
	}
}
string
bundleRepoDatastore Optional

Bundle repositry datastore for this host


cluster Optional

Information about the cluster this host is part of


string
compatibleStorageType Optional

Information about the host compatible storage type


Cpu
cpu Optional

Information about CPUs on the host


domain Optional

Information about the domain this host is part of


string
esxiVersion Optional

ESXi software version of the host


string
fqdn Optional

FQDN of the host


string
hardwareModel Optional

Hardware model of the host


string
hardwareVendor Optional

Hardware vendor of the host


boolean
hybrid Optional

Information about the storage type of the host, true if the host is hybrid.


string
id Optional

ID of the host


array of IpAddress
ipAddresses Optional

Information about IP addresses assigned to the host


boolean
isPrimary Optional

Is the host a primary host in VxRail HCI Context


memory Optional

Information about memory on the host


networkpool Optional

Information about the network pool this host is part of


array of PhysicalNic
physicalNics Optional

Information about physical NICs on the host


serialNumber Optional

Serial Number of the host


sshThumbprint Optional

SSH Thumbprint of the host


sslThumbprint Optional

SSL Thumbprint of the host


string
status Optional

Status of the host


storage Optional

Information about storage on the host

Errors

Errors

400

Bad Request


404

Host Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

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


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