Get Host
Get a host by its ID
id
Ok
{
"id": "string",
"serialNumber": "string",
"esxiVersion": "string",
"sshThumbprint": "string",
"sslThumbprint": "string",
"fqdn": "string",
"hardwareVendor": "string",
"hardwareModel": "string",
"ipAddresses": [
{
"ipAddress": "string",
"type": "One among: MANAGEMENT, VSAN, VMOTION, NFS, VSAN_EXTERNAL",
"ipAddressVersion": "One among: IPv4, IPv6"
}
],
"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",
"ipAddressVersion": "IPv6",
"ipAddressAssignmentMode": "SLAAC",
"vlanId": 0,
"mtu": 0,
"subnet": "string",
"mask": "string",
"gateway": "string",
"ipPools": [
{
"start": "string",
"end": "string"
}
],
"freeIps": [
"string"
],
"usedIps": [
"string"
],
"usedIpCount": "string",
"freeIpCount": "string"
}
],
"hostNetworks": [
{
"type": "string",
"vlanId": 0,
"mtu": 0
}
],
"gpus": [
{
"deviceName": "string",
"vendorName": "string",
"vgpuState": "One among: READY, DRIVER_MISSING, NOT_SUPPORTED, NO_NVIDIA_GPU"
}
],
"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"
}
}
},
"alternativeImages": {
"alternativeImages": {
"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"
}
}
},
"selectionCriteria": {
"selectionType": "One among: HOST_UUID, HOST_HARDWARE_SPEC",
"hostBiosIds": [
"string"
],
"hostHardware": {
"vendor": "string",
"models": [
"string"
],
"families": [
"string"
],
"oemStrings": [
"string"
]
}
},
"displayName": "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, VMFS",
"vvolStorageProtocolType": "One among: ISCSI, NFS, FC",
"managedObjectReferenceId": "string",
"isStandalone": false,
"isLifecycleManaged": false,
"isVsanWitnessHost": false
}ID of the host
Serial Number of the host
ESXi software version of the host
SSH Thumbprint of the host
SSL Thumbprint of the host
FQDN of the host
Hardware vendor of the host
Hardware model of the host
Information about IP addresses assigned to the host
Represents information about CPUs on a host
Represents information about memory on a host
Represents information about storage on a host
Information about physical NICs on the host
Information about Networks on the host This is deprecated
Information about Networks on the host
Information about Gpus on the host
Represents a domain reference
Represents a network pool reference
Represents a reference to the cluster
Status of the host
Information about the host compatible storage type
Bundle repositry datastore for this host
Information about the storage type of the host, true if the host is hybrid
SoftwareSpec contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.
Deprecated, this list will always be returned empty
Information about the configuration status of the host
Information about the datastore type of the host
Information about the VVOL storage protocol type of the host
Managed object reference ID
Is the host a Standalone Host
Is the host managed by vLCM
Is the host a vSAN witness host
Bad Request
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
The nested errors when the error is a composite one
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Internal server error
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
curl -H 'Authorization: <value>' https://{api_host}/v1/hosts/{id}