/Classes/host

Classes / host / index.html

A physical host

Fields

string uuid
Unique identifier/object reference
string name_label
a human-readable name
string name_description
a notes field containg human-readable description
int memory_overhead
Virtualization memory overhead (bytes).
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
Map[string,string] cpu_info
Details about 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
State of the current license
int boot_free_mem
Free memory on host at boot time
Set[string] ha_statefiles
The set of statefiles accessible from this host
Set[string] ha_network_peers
The set of hosts visible via the network from this host
Map[string,blob] blobs
Binary blobs associated with this host
Set[string] tags
user-specified tags for categorization purposes
string external_auth_type
type of external authentication service configured; empty if none configured.
string external_auth_service_name
name of external authentication service configured; empty if none configured.
Map[string,string] external_auth_configuration
configuration specific to external authentication service
string edition
XenServer edition
Map[string,string] license_server
Contact information of the license server
Map[string,string] bios_strings
BIOS strings
string power_on_mode
The power on mode
Map[string,string] power_on_config
The power on config
SR local_cache_sr
The SR that is used as a local cache

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 Citrix 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
void power_on (session session_id, host host)
Attempt to power-on the host (if the capability exists).
void emergency_ha_disable (session session_id)
This call disables HA on the local host. This should only be used with extreme care.
Set[Record[data_source]] get_data_sources (session session_id, host host)
void record_data_source (session session_id, host host, string data_source)
Start recording the specified data source
float query_data_source (session session_id, host host, string data_source)
Query the latest value of the specified data source
void forget_data_source_archives (session session_id, host host, string data_source)
Forget the recorded statistics related to the specified data source
void assert_can_evacuate (session session_id, host host)
Check this host can be evacuated.
Map[VM,Set[string]] get_vms_which_prevent_evacuation (session session_id, host self)
Return a set of VMs which prevent the host being evacuated, with per-VM error codes
Set[VM] get_uncooperative_resident_VMs (session session_id, host self)
Return a set of VMs which are not co-operating with the host's memory control system
void evacuate (session session_id, host host)
Migrate all VMs off of this host, where possible.
void syslog_reconfigure (session session_id, host host)
Re-configure syslog logging
void management_reconfigure (session session_id, PIF pif)
Reconfigure the management network interface
void local_management_reconfigure (session session_id, string interface)
Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken.
void management_disable (session session_id)
Disable the management network interface
string get_system_status_capabilities (session session_id, host host)
void restart_agent (session session_id, host host)
Restarts the agent after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called.
void shutdown_agent (session session_id)
Shuts the agent down after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called.
void set_hostname_live (session session_id, host host, string hostname)
Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately.
int compute_free_memory (session session_id, host host)
Computes the amount of free memory on the host.
int compute_memory_overhead (session session_id, host host)
Computes the virtualization memory overhead of a host.
void sync_data (session session_id, host host)
This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host
void backup_rrds (session session_id, host host, float delay)
This causes the RRDs to be backed up to the master
blob create_new_blob (session session_id, host host, string name, string mime_type)
Create a placeholder for a named binary blob of data that is associated with this host
string call_plugin (session session_id, host host, string plugin, string fn, Map[string,string] args)
Call a XenAPI plugin on this host
datetime get_servertime (session session_id, host host)
This call queries the host's clock for the current time
datetime get_server_localtime (session session_id, host host)
This call queries the host's clock for the current time in the host's local timezone
void enable_external_auth (session session_id, host host, Map[string,string] config, string service_name, string auth_type)
This call enables external authentication on a host
void disable_external_auth (session session_id, host host, Map[string,string] config)
This call disables external authentication on the local host
Map[VM,Set[string]] retrieve_wlb_evacuate_recommendations (session session_id, host self)
Retrieves recommended host migrations to perform when evacuating the host from the wlb server. If a VM cannot be migrated from the host the reason is listed instead of a recommendation.
string get_server_certificate (session session_id, host host)
Get the installed server SSL certificate.
void apply_edition (session session_id, host host, string edition)
Change to another edition, or reactivate the current edition after a license has expired. This may be subject to the successful checkout of an appropriate license.
void refresh_pack_info (session session_id, host host)
Refresh the list of installed Supplemental Packs.
void set_power_on_mode (session session_id, host self, string power_on_mode, Map[string,string] power_on_config)
Set the power-on-mode, host, user and password
void set_cpu_features (session session_id, host host, string features)
Set the CPU features to be used after a reboot, if the given features string is valid.
void reset_cpu_features (session session_id, host host)
Remove the feature mask, such that after a reboot all features of the CPU are enabled.
void enable_local_storage_caching (session session_id, host host, SR sr)
Enable the use of a local SR for caching purposes
void disable_local_storage_caching (session session_id, host host)
Disable the use of a local SR for caching purposes