Host

Host
Host

Represents an Esxi host in the system

JSON Example 
{
    "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"
                }
            }
        },
        "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"
                }
            }
        }
    },
    "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"
}
string
id
Read-Only

ID of the host

string
serialNumber
Read-Only

Serial Number of the host

string
esxiVersion
Read-Only

ESXi software version of the host

string
sshThumbprint
Read-Only

SSH Thumbprint of the host

string
sslThumbprint
Read-Only

SSL Thumbprint of the host

string
fqdn
Read-Only

FQDN of the host

string
hardwareVendor
Read-Only

Hardware vendor of the host

string
hardwareModel
Read-Only

Hardware model of the host

boolean
isPrimary
Read-Only

Is the host a primary host in VxRail HCI Context

boolean
isVsanEsaEligible
Read-Only

Is the host vSAN ESA eligible in VxRail HCI Context

array of IpAddress
ipAddresses
Read-Only

Information about IP addresses assigned to the host

Cpu
cpu
Read-Only

Represents information about CPUs on a host

Memory
memory
Read-Only

Represents information about memory on a host

Storage
storage
Read-Only

Represents information about storage on a host

array of PhysicalNic
physicalNics
Read-Only

Information about physical NICs on the host

array of Network
networks
Read-Only

Information about Networks on the host This is deprecated

array of HostNetwork
hostNetworks
Read-Only

Information about Networks on the host

DomainReference
domain
Read-Only

Represents a domain reference

NetworkPoolReference
networkpool
Read-Only

Represents a network pool reference

ClusterReference
cluster
Read-Only

Represents a reference to the cluster

string
status
Read-Only

Status of the host

string
compatibleStorageType
Read-Only

Information about the host compatible storage type

string
bundleRepoDatastore
Read-Only

Bundle repositry datastore for this host

boolean
hybrid
Read-Only

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

SoftwareInfo
softwareInfo
Optional

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.

array of Tag
tags
Optional

Deprecated, this list will always be returned empty

string
configurationStatus
Read-Only

Information about the configuration status of the host

string
datastoreType
Read-Only

Information about the datastore type of the host

Property Of
Returned By