[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Get Host

Description

Get a Host

Request

URL

get

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

Copy

Path Parameters

string

id Required

Response

Response Body

200 OK

Returns Host of type(s) application/json

{
    "status": "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE"
}

string

bundleRepoDatastore Optional

Bundle repositry datastore for this host

ClusterReference

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

DomainReference

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

memory Optional

Information about memory on the host

NetworkPoolReference

networkpool Optional

Information about the network pool this host is part of

array of PhysicalNic

physicalNics Optional

Information about physical NICs on the host

OptionalOfstring

serialNumber Optional

Serial Number of the host

OptionalOfstring

sshThumbprint Optional

SSH Thumbprint of the host

OptionalOfstring

sslThumbprint Optional

SSL Thumbprint of the host

string

status Optional

Status of the host

Storage

storage Optional

Information about storage on the host

array of Tag

tags Optional

Deprecated, this list will always be returned empty

Errors

Error

400

Bad Request

Error

404

Host Not Found

Error

500

Internal Server Error

Code Samples

cURL Command

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

vcf

Hosts Operations

put

Assign Tags To Existing Host

get

Assignable Tags To Host

post

Commission Hosts

delete

Decommission Hosts

get

Get Criteria

get

Get Criterion

get

Get Host

get

Get Host Query Response

get

Get Host Tag Manager URL

get

Get Hosts

get

Get Tags Assigned To Host

get

Get Tags Assigned To Hosts

get

Get Validation For Commission Hosts

post

Post Query

delete

Remove Tags From Host

post

Validate Hosts Operations

Get Host

Request

URL

Path Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Hosts Operations

Was this page helpful?