Get Hosts

Get Hosts

Get all hosts

Request
URI
GET
https://{api_host}/v1/hosts
COPY
Query Parameters
string
status
Optional

Status of the Host.One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE

string
domainId
Optional

ID of the Domain

string
clusterId
Optional

ID of the Cluster

string
networkpoolId
Optional

ID of the Network pool

string
storageType
Optional

Type of the Storage.VMFS_FC

string
datastoreName
Optional

Name of the datastore


Responses
200

Ok

Returns PageOfHost of type(s) application/json
{
    "elements": [
        {
            "id": "string",
            "serialNumber": "string",
            "esxiVersion": "string",
            "sshThumbprint": "string",
            "sslThumbprint": "string",
            "fqdn": "string",
            "hardwareVendor": "string",
            "hardwareModel": "string",
            "isPrimary": false,
            "isVsanEsaEligible": false,
            "ipAddresses": [
                {
                    "ipAddress": "string",
                    "type": "One among: MANAGEMENT, VSAN, VMOTION, NFS, VSAN_EXTERNAL"
                }
            ],
            "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",
                    "vlanId": 0,
                    "mtu": 0,
                    "subnet": "string",
                    "mask": "string",
                    "gateway": "string",
                    "ipPools": [
                        {
                            "start": "string",
                            "end": "string"
                        }
                    ],
                    "freeIps": [
                        "string"
                    ],
                    "usedIps": [
                        "string"
                    ]
                }
            ],
            "hostNetworks": [
                {
                    "type": "string",
                    "vlanId": 0,
                    "mtu": 0
                }
            ],
            "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"
                        }
                    }
                },
                "hardwareSupport": {
                    "packages": {
                        "packages": {
                            "pkg": "string",
                            "version": "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"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of Host
elements
Optional

The list of elements included in this page

pageMetadata
Optional

Represents pageable elements pagination metadata


400

Bad Request

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

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

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

object
context
Optional

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

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

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.


500

Internal server error

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

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

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

object
context
Optional

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

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

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.