Chapter 14. Hosts
14.1. Host Elements
The
hosts collection provides information about the hosts in a Red Hat Enterprise Virtualization environment. An API user accesses this information through the rel="hosts" link obtained from the entry point URI.
Additional information can be retrieved for
GET requests using the All-Content: true header.
The following table shows specific elements contained in a host resource representation.
| Element | Type | Description | Properties |
|---|---|---|---|
link rel="storage" | relationship | A link to the storage sub-collection for host storage. | 
|
link rel="nics" | relationship | A link to the nics sub-collection for host network interfaces. | |
link rel="numanodes" | relationship | A link to the numanodes sub-collection for host NUMA nodes. | |
link rel="tags" | relationship | A link to the tags sub-collection for host tags. | |
link rel="permissions" | relationship | A link to the permissions sub-collection for host permissions. | |
link rel="statistics" | relationship | A link to the statistics sub-collection for host statistics. |
|
link rel="hooks" | relationship | A link to the hooks sub-collection for host hooks. | |
link rel="fenceagents" | relationship | A link to the fenceagents sub-collection for host fence agents. | |
link rel="katelloerrata" | relationship | A link to the katelloerrata sub-collection for host errata. | |
link rel="devices" | relationship | A link to the devices sub-collection for host devices. | |
link rel="networkattachments" | relationship | A link to the networkattachments sub-collection for host network configuration. | |
link rel="unmanagednetworks" | relationship | A link to the unmanagednetworks sub-collection for unmanaged networks on the host. | |
link rel="storageconnectionextensions" | relationship | A link to the storageconnectionextensions sub-collection for host storage connection extensions. | |
name | string | The unique identifier for the host. | |
root_password | string | The root password of this host, by convention only included in the client-provided host representation on creation. | 
|
comment | string | Any comments regarding the host. | |
address | string | The IP address or hostname of the host. |
|
certificate | complex | A reference to the host certificate details, including organization and subject. |
|
status | See below | The host status. |
|
external_status | complex/enumerated | The host health status as reported by external systems and plug-ins. The state element contains an enumerated value of ok, info, warning, error, or failure. | |
cluster id= | GUID | A reference to the cluster that includes this host. | |
port | integer | The listen port of the VDSM daemon running on this host. |
|
type | One of rhel or rhev-h | The host type. |
|
storage_manager priority= | Boolean: true or false | Specifies whether the host is a storage manager. |
|
version major= minor= build= revision= full_version= | complex | The compatibility level of the host. |
|
hardware_information | complex | Information regarding the hardware of the host, including manufacturer, version, serial_number, product_name, uuid, and family. | |
power_management type= | complex | Configuration options for host power management, including enabled, options, kdump_detection, automatic_pm_enabled, and agents. See Section 14.4, “Power Management Elements” for more information on the host power management options. | |
ksm | Boolean: true or false | true if Kernel SamePage Merging (KSM) is enabled. | |
transparent_hugepages | Boolean: true or false | true if Transparent Hugepages is enabled. | |
iscsi | complex | The SCSI initiator for the host. |
|
ssh | complex | Details regarding the SSH connection with the host, including port and fingerprint. | |
cpu | complex | Statistics for the host CPU. Includes sub-elements for the CPU's name, topology cores=, topology sockets=, topology threads= and speed. The topology cores= aggregates the total cores while the topology sockets= aggregates the total physical CPUs. The total cores available to virtual machines equals the number of sockets multiplied by the cores per socket. |
|
memory | integer | The total amount of host memory in bytes. |
|
max_scheduling_memory | integer | The maximum amount of memory that can be used in scheduling in bytes. |
|
summary | complex | Summary statistics of the virtual machines on the host. Includes sub-elements for numbers of active, migrating and total VMs. |
|
os type= | complex | Details regarding the operating system installed on the host, including version full_version=. |
|
libvirt_version major= minor= build= revision= full_version= | complex | The libvirt compatibility level of the host. |
|
The
status contains one of the following enumerative values: down, error, initializing, installing, install_failed, maintenance, non_operational, non_responsive, pending_approval, preparing_for_maintenance, connecting, reboot, unassigned and up. These states are listed in host_states under capabilities.
