/Classes/host

Classes / host / index.html

Fields

string uuid
unique identifier/object reference
string name_label
a human-readable name
string name_description
a notes field containg human-readable description
Set[enum host_allowed_operations] allowed_operations
list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Map[string,enum host_allowed_operations] current_operations
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
int API_version_major
major version number
int API_version_minor
minor version number
string API_version_vendor
identification of vendor
Map[string,string] API_version_vendor_implementation
details of vendor implementation
bool enabled
True if the host is currently enabled
Map[string,string] software_version
version strings
Map[string,string] other_config
additional configuration
Set[string] capabilities
Xen capabilities
Map[string,string] cpu_configuration
The CPU configuration on this host. May contain keys such as "nr_nodes", "sockets_per_node", "cores_per_socket", or "threads_per_core"
string sched_policy
Scheduler policy currently in force on this host
Set[string] supported_bootloaders
a list of the bootloaders installed on the machine
Set[VM] resident_VMs
list of VMs currently resident on host
Map[string,string] logging
logging configuration
Set[PIF] PIFs
physical network interfaces
SR suspend_image_sr
The SR in which VDIs for suspend images are created
SR crash_dump_sr
The SR in which VDIs for crash dumps are created
Set[host_crashdump] crashdumps
Set of host crash dumps
Set[host_patch] patches
Set of host patches
Set[PBD] PBDs
physical blockdevices
Set[host_cpu] host_CPUs
The physical CPUs on this host
string hostname
The hostname of this host
string address
The address by which this host can be contacted from any other host in the pool
host_metrics metrics
metrics associated with this host
Map[string,string] license_params
The key/value pairs read from the license file

Implicit messages

Record[host] get_record (session session_id, host self)
Get a record containing the current state of the given host.
host get_by_uuid (session session_id, string uuid)
Get a reference to the host instance with the specified UUID.
Set[host] get_by_name_label (session session_id, string label)
Get all the host instances with the given label.
Set[host] get_all (session session_id)
Return a list of all the hosts known to the system.
Map[host,Record[host]] get_all_records (session session_id)
Return a map of host references to host records for all hosts known to the system.

Explicit messages

void disable (session session_id, host host)
Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.
void enable (session session_id, host host)
Puts the host into a state in which new VMs can be started.
void shutdown (session session_id, host host)
Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
void reboot (session session_id, host host)
Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
string dmesg (session session_id, host host)
Get the host xen dmesg.
string dmesg_clear (session session_id, host host)
Get the host xen dmesg, and clear the buffer.
string get_log (session session_id, host host)
Get the host's log file
void send_debug_keys (session session_id, host host, string keys)
Inject the given string as debugging keys into Xen
void bugreport_upload (session session_id, host host, string url, Map[string,string] options)
Run xen-bugtool --yestoall and upload the output to XenSource support
Set[string] list_methods (session session_id)
List all supported methods
void license_apply (session session_id, host host, string contents)
Apply a new license to a host
void destroy (session session_id, host self)
Destroy specified host record in database