Get Host

Get Host

Get a Host

Request
URI
GET
https://sfo-vcf01.rainpole.io//v1/hosts/{id}
COPY
Path Parameters
string
id
Required

id


Responses
200

Ok

Returns Host of type(s) application/json
{
    "bundleRepoDatastore": "string",
    "cluster": {
        "id": "string"
    },
    "compatibleStorageType": "string",
    "cpu": {
        "cores": 0,
        "cpuCores": [
            {
                "frequencyMHz": "number",
                "manufacturer": "string",
                "model": "string"
            }
        ],
        "frequencyMHz": "number",
        "usedFrequencyMHz": "number"
    },
    "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": "number",
        "usedCapacityMB": "number"
    },
    "networkpool": {
        "id": "string",
        "name": "string"
    },
    "networks": [
        {
            "freeIps": [
                "string"
            ],
            "gateway": "string",
            "id": "string",
            "ipPools": [
                {
                    "end": "string",
                    "start": "string"
                }
            ],
            "mask": "string",
            "mtu": 0,
            "subnet": "string",
            "type": "string",
            "usedIps": [
                "string"
            ],
            "vlanId": 0
        }
    ],
    "physicalNics": [
        {
            "deviceName": "string",
            "macAddress": "string",
            "speed": 0,
            "unit": "string"
        }
    ],
    "serialNumber": {
        "present": false
    },
    "softwareInfo": {
        "addOn": {
            "displayName": "string",
            "displayVersion": "string",
            "name": "DELL-sample-Addon",
            "vendor": "Dell",
            "version": "2.0-1"
        },
        "baseImage": {
            "details": {
                "displayName": "7.0.0-0.0.30340198",
                "displayVersion": "string",
                "releaseDate": {
                    "calendarType": "string",
                    "firstDayOfWeek": 0,
                    "lenient": false,
                    "minimalDaysInFirstWeek": 0,
                    "time": "string",
                    "timeInMillis": 0,
                    "timeZone": {
                        "displayName": "string",
                        "dstsavings": 0,
                        "id": "string",
                        "rawOffset": 0
                    },
                    "weekDateSupported": false,
                    "weekYear": 0,
                    "weeksInWeekYear": 0
                }
            },
            "version": "7.0.0-0.0.30340198"
        },
        "hardwareSupport": {}
    },
    "sshThumbprint": {
        "present": false
    },
    "sslThumbprint": {
        "present": false
    },
    "status": "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
    "storage": {
        "disks": [
            {
                "capacityMB": "number",
                "diskType": "One among: HDD, FLASH",
                "manufacturer": "string",
                "model": "string"
            }
        ],
        "totalCapacityMB": "number",
        "usedCapacityMB": "number"
    },
    "tags": [
        {
            "categoryId": "string",
            "categoryName": "string",
            "id": "string",
            "name": "string"
        }
    ]
}
string
bundleRepoDatastore
Optional

Bundle repositry datastore for this host

cluster
Optional

cluster

string
compatibleStorageType
Optional

Information about the host compatible storage type

cpu
Optional

cpu

domain
Optional

domain

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

memory

networkpool
Optional

networkpool

array of Network
networks
Optional

Information about Networks on the host

physicalNics
Optional

Information about physical NICs on the host

serialNumber
Optional

serialNumber

softwareInfo
Optional

softwareInfo

sshThumbprint
Optional

sshThumbprint

sslThumbprint
Optional

sslThumbprint

string
status
Optional

Status of the host

storage
Optional

storage

array of Tag
tags
Optional

Deprecated, this list will always be returned empty


400

Bad Request

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


404

Host Not Found

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


500

Internal Server Error

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message