# ApiHost Data Model

This is the model for a host in the system.

Properties
name | data type | description
--- | --- | ---
hostId | string | A unique host identifier. This is not the same as the hostname (FQDN). It is a distinct value that remains the same even if the hostname changes.
ipAddress | string | The host IP address. This field is not mutable after the initial creation.
hostname | string | The hostname. This field is not mutable after the initial creation.
rackId | string | The rack ID for this host.
lastHeartbeat | string | Readonly. Requires "full" view. When the host agent sent the last heartbeat.
roleRefs | array of ApiRoleRef | Readonly. Requires "full" view. The list of roles assigned to this host.
healthSummary | ApiHealthSummary | Readonly. Requires "full" view. The high-level health status of this host.
healthChecks | array of ApiHealthCheck | Readonly. Requires "full" view. The list of health checks performed on the host, with their results.
isParcelInfoAvailable | boolean | Readonly. Requires "full" view. Indicates whether the Agent has completed parcel repository initialization.
hostUrl | string | Readonly. A URL into the Cloudera Manager web UI for this specific host.
maintenanceMode | boolean | Readonly. Whether the host is in maintenance mode. Available since API v2.
commissionState | ApiCommissionState | Readonly. The commission state of this role. Available since API v2.
maintenanceOwners | array of ApiEntityType | Readonly. The list of objects that trigger this host to be in maintenance mode. Available since API v2.
config | ApiConfigList |
numCores | number | Readonly. The number of logical CPU cores on this host. Only populated after the host has heartbeated to the server. Available since API v4.
numPhysicalCores | number | Readonly. The number of physical CPU cores on this host. Only populated after the host has heartbeated to the server. Available since API v9.
totalPhysMemBytes | number | Readonly. The amount of physical RAM on this host, in bytes. Only populated after the host has heartbeated to the server. Available since API v4.
entityStatus | ApiEntityStatus | Readonly. The entity status for this host. Available since API v11.
clusterRef | ApiClusterRef | Readonly. A reference to the enclosing cluster. This might be null if the host is not yet assigned to a cluster. Available since API v11.
distribution | ApiOsDistribution | Readonly. OS distribution available on the host. Available since API v40.
tags | array of ApiEntityTag | Tags associated with the host. Available since V41.

Example

    {
      "hostId" : "...",
      "ipAddress" : "...",
      "hostname" : "...",
      "rackId" : "...",
      "lastHeartbeat" : "...",
      "roleRefs" : [ {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "GOOD",
        "roleStatus" : "UNKNOWN"
      }, {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "CONCERNING",
        "roleStatus" : "STOPPED"
      } ],
      "healthSummary" : "DISABLED",
      "healthChecks" : [ {
        "name" : "...",
        "summary" : "BAD",
        "explanation" : "...",
        "suppressed" : true
      }, {
        "name" : "...",
        "summary" : "BAD",
        "explanation" : "...",
        "suppressed" : true
      } ],
      "isParcelInfoAvailable" : true,
      "hostUrl" : "...",
      "maintenanceMode" : true,
      "commissionState" : "OFFLINED",
      "maintenanceOwners" : [ "ROLE", "HOST" ],
      "config" : {
        "items" : [ {
          "name" : "...",
          "value" : "...",
          "required" : true,
          "default" : "...",
          "displayName" : "...",
          "description" : "...",
          "relatedName" : "...",
          "sensitive" : true,
          "validationState" : "WARNING",
          "validationMessage" : "...",
          "validationWarningsSuppressed" : true
        }, {
          "name" : "...",
          "value" : "...",
          "required" : true,
          "default" : "...",
          "displayName" : "...",
          "description" : "...",
          "relatedName" : "...",
          "sensitive" : true,
          "validationState" : "OK",
          "validationMessage" : "...",
          "validationWarningsSuppressed" : true
        } ]
      },
      "numCores" : 12345,
      "numPhysicalCores" : 12345,
      "totalPhysMemBytes" : 12345,
      "entityStatus" : "UNKNOWN",
      "clusterRef" : {
        "clusterName" : "...",
        "displayName" : "..."
      },
      "distribution" : {
        "distributionType" : "UBUNTU_BIONIC",
        "name" : "...",
        "version" : "..."
      },
      "tags" : [ {
        "name" : "...",
        "value" : "..."
      }, {
        "name" : "...",
        "value" : "..."
      } ]
    }