Class: host

Last published : Oct 01, 2026
A physical host
Related information
XenServer 9 Management API

Fields for class: host

Field Type Qualifier Description
address string RW The address by which this host can be contacted from any other host in the pool
allowed_operations host_allowed_operations set RO/runtime 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.
API_version_major int RO/runtime major version number
API_version_minor int RO/runtime minor version number
API_version_vendor string RO/runtime identification of vendor
API_version_vendor_implementation (string -> string) map RO/runtime details of vendor implementation
bios_strings (string -> string) map RO/runtime BIOS strings
blobs (string -> blob ref) map RO/runtime Binary blobs associated with this host
capabilities string set RO/constructor Xen capabilities
certificates Certificate ref set RO/runtime List of certificates installed in the host
chipset_info (string -> string) map RO/runtime Information about chipset features
console_idle_timeout int RO/runtime The timeout in seconds after which idle console will be automatically terminated (0 means never)
control_domain VM ref RO/runtime The control domain (domain 0)
cpu_configuration (string -> string) map RO/runtime The CPU configuration on this host. May contain keys such as "nr_nodes", "sockets_per_node", "cores_per_socket", or "threads_per_core"
cpu_info (string -> string) map RO/runtime Details about the physical CPUs on this host
crash_dump_sr SR ref RW The SR in which VDIs for crash dumps are created
crashdumps host_crashdump ref set RO/runtime Set of host crash dumps
current_operations (string -> host_allowed_operations) map RO/runtime links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
display host_display RW indicates whether the host is configured to output its console to a physical display device
edition string RO/runtime Product edition
editions string set RO/runtime List of all available product editions
enabled bool RO/runtime True if the host is currently enabled
external_auth_configuration (string -> string) map RO/runtime configuration specific to external authentication service
external_auth_service_name string RO/runtime name of external authentication service configured; empty if none configured.
external_auth_type string RO/runtime type of external authentication service configured; empty if none configured.
features Feature ref set RO/runtime List of features available on this host
guest_VCPUs_params (string -> string) map RW VCPUs params to apply to all resident guests
ha_network_peers string set RO/runtime The set of hosts visible via the network from this host
ha_statefiles string set RO/runtime The set of statefiles accessible from this host
host_CPUs host_cpu ref set RO/runtime The physical CPUs on this host
hostname string RW The hostname of this host
https_only bool RO/runtime Reflects whether port 80 is open (false) or not (true)
iscsi_iqn string RO/constructor The initiator IQN for the host
last_software_update datetime RO/runtime Date and time when the last software update was applied
last_update_hash string RO/runtime The SHA256 checksum of updateinfo of the most recently applied update on the host
latest_synced_updates_applied latest_synced_updates_applied_state RO/runtime Default as 'unknown', 'yes' if the host is up to date with updates synced from remote CDN, otherwise 'no'
license_params (string -> string) map RO/runtime State of the current license
license_server (string -> string) map RW Contact information of the license server
local_cache_sr SR ref RO/constructor The SR that is used as a local cache
logging (string -> string) map RW logging configuration
max_cstate string RO/runtime The maximum C-state that the host is allowed to enter, "" means unlimited; "N" means limit to CN; "N,M" means limit to CN with max sub cstate M.
memory_overhead int RO/runtime Virtualization memory overhead (bytes).
metrics host_metrics ref RO/runtime metrics associated with this host
multipathing bool RO/constructor Specifies whether multipathing is enabled
name_description string RW a notes field containing human-readable description
name_label string RW a human-readable name
ntp_custom_servers string set RO/runtime Custom NTP servers configured by users, used in Custom NTP mode
ntp_mode host_ntp_mode RO/runtime Indicates NTP servers are assigned by DHCP, or configured by user, or the factory servers, or NTP is disabled
numa_affinity_policy host_numa_affinity_policy RO/runtime NUMA-aware VM memory and vCPU placement policy
other_config (string -> string) map RW additional configuration
patches host_patch ref set RO/runtime Deprecated. Set of host patches
PBDs PBD ref set RO/runtime physical blockdevices
PCIs PCI ref set RO/runtime List of PCI devices in the host
pending_guidances update_guidances set RO/runtime The set of pending mandatory guidances after applying updates, which must be applied, otherwise there may be, for example, VM failures
pending_guidances_full update_guidances set RO/runtime The set of pending full guidances after applying updates, which a user should follow to make some updates, for example, specific hardware drivers or CPU features, fully effective, but the 'average user' doesn't need to
pending_guidances_recommended update_guidances set RO/runtime The set of pending recommended guidances after applying updates, which most users should follow to make the updates effective, but if not followed, will not cause a failure
PGPUs PGPU ref set RO/runtime List of physical GPUs in the host
PIFs PIF ref set RO/runtime physical network interfaces
power_on_config (string -> string) map RO/runtime The power on config
power_on_mode string RO/runtime The power on mode
PUSBs PUSB ref set RO/runtime List of physical USBs in the host
resident_VMs VM ref set RO/runtime list of VMs currently resident on host
sched_policy string RO/runtime Scheduler policy currently in force on this host
secure_boot bool RO/runtime Whether the host has booted in secure boot mode
software_version (string -> string) map RO/constructor version strings
ssh_auto_mode bool RO/runtime Reflects whether SSH auto mode is enabled for the host
ssh_enabled bool RO/runtime True if SSH access is enabled for the host
ssh_enabled_timeout int RO/runtime The timeout in seconds after which SSH access will be automatically disabled (0 means never), this setting will be applied every time the SSH is enabled by XAPI
ssh_expiry datetime RO/runtime The time in UTC after which the SSH access will be automatically disabled
ssl_legacy bool RO/constructor Deprecated. Allow SSLv3 protocol and ciphersuites as used by older server versions. This controls both incoming and outgoing connections. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. API login sessions will remain valid.
supported_bootloaders string set RO/runtime a list of the bootloaders installed on the machine
suspend_image_sr SR ref RW The SR in which VDIs for suspend images are created
tags string set RW user-specified tags for categorization purposes
timezone string RO/runtime The time zone identifier as defined in the IANA Time Zone Database
tls_verification_enabled bool RO/runtime True if this host has TLS verifcation enabled
uefi_certificates string RO/constructor Deprecated. The UEFI certificates allowing Secure Boot
updates pool_update ref set RO/runtime Set of updates
updates_requiring_reboot pool_update ref set RO/runtime List of updates which require reboot
uuid string RO/runtime Unique identifier/object reference
virtual_hardware_platform_versions int set RO/runtime The set of versions of the virtual hardware platform that the host can offer to its guests

RPCs associated with class: host

RPC name: addtags

Overview:
Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing.
Signature:
void add_tags (session ref session_ref, host ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string value New value to add
Minimum Role: vm-operator
Return Type: void

RPC name: addtoguestVCPUsparams

Overview:
Add the given keyvalue pair to the guestVCPUsparams field of the given host.
Signature:
void add_to_guest_VCPUs_params (session ref session_ref, host ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: pool-operator
Return Type: void

RPC name: addtolicenseserver

Overview:
Add the given keyvalue pair to the licenseserver field of the given host.
Signature:
void add_to_license_server (session ref session_ref, host ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: pool-operator
Return Type: void

RPC name: addtologging

Overview:
Add the given keyvalue pair to the logging field of the given host.
Signature:
void add_to_logging (session ref session_ref, host ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: pool-operator
Return Type: void

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given host.
Signature:
void add_to_other_config (session ref session_ref, host ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: pool-operator
Return Type: void

RPC name: applyedition

Overview:
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.
Signature:
void apply_edition (session ref session_ref, host ref host, string edition, bool force)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string edition The requested edition
bool force Update the license params even if the apply call fails
Minimum Role: pool-operator
Return Type: void

RPC name: applyupdates

Overview:
apply updates from current enabled repository on a host
Signature:
string set set apply_updates (session ref session_ref, host ref self, string hash)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host where updates will be applied
string hash The hash of updateinfo to be applied which is returned by previous pool.sync_udpates
Minimum Role: client-cert
Return Type: string set set
The list of results after applying updates, including livepatch apply failures and recommended guidances

RPC name: assertcanevacuate

Overview:
Check this host can be evacuated.
Signature:
void assert_can_evacuate (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host to evacuate
Minimum Role: pool-operator
Return Type: void

RPC name: backuprrds

Overview:
This causes the RRDs to be backed up to the master
Signature:
void backup_rrds (session ref session_ref, host ref host, float delay)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host Schedule a backup of the RRDs of this host
float delay Delay in seconds from when the call is received to perform the backup
Minimum Role: pool-admin
Return Type: void

RPC name: bugreportupload

Overview:
Run xenbugtool yestoall and upload the output to support
Signature:
void bugreport_upload (session ref session_ref, host ref host, string url, (string -> string) map options)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host on which to run xen-bugtool
string url The URL to upload to
(string -> string) map options Extra configuration operations
Minimum Role: pool-operator
Return Type: void

RPC name: callextension

Overview:
Call an API extension on this host
Signature:
string call_extension (session ref session_ref, host ref host, string call)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string call Rpc call for the extension
Minimum Role: pool-admin
Return Type: string
Result from the extension

RPC name: callplugin

Overview:
Call an API plugin on this host
Signature:
string call_plugin (session ref session_ref, host ref host, string plugin, string fn, (string -> string) map args)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string plugin The name of the plugin
string fn The name of the function within the plugin
(string -> string) map args Arguments for the function
Minimum Role: pool-admin
Return Type: string
Result from the plugin

RPC name: computefreememory

Overview:
Computes the amount of free memory on the host.
Signature:
int compute_free_memory (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host to send the request to
Minimum Role: read-only
Return Type: int
the amount of free memory on the host.

RPC name: computememoryoverhead

Overview:
Computes the virtualization memory overhead of a host.
Signature:
int compute_memory_overhead (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host for which to compute the memory overhead
Minimum Role: read-only
Return Type: int
the virtualization memory overhead of the host.

RPC name: createnewblob

Overview:
Create a placeholder for a named binary blob of data that is associated with this host
Signature:
blob ref create_new_blob (session ref session_ref, host ref host, string name, string mime_type, bool public)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string name The name associated with the blob
string mime_type The mime type for the data. Empty string translates to application/octet-stream
bool public True if the blob should be publicly available
Minimum Role: pool-operator
Return Type: blob ref
The reference of the blob, needed for populating its data

RPC name: declaredead

Overview:
Declare that a host is dead. This is a dangerous operation, and should only be called if the administrator is absolutely sure the host is definitely dead
Signature:
void declare_dead (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to declare is dead
Minimum Role: pool-operator
Return Type: void

RPC name: destroy

Overview:
Destroy specified host record in database
Signature:
void destroy (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host record to remove
Minimum Role: pool-operator
Return Type: void

RPC name: disable

Overview:
Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.
Signature:
void disable (session ref session_ref, host ref host, bool auto_enable)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to disable
bool auto_enable If true (default), the host will be re-enabled after a toolstack restart automatically. If false, the host will be disabled indefinitely, across toolstack restarts and host reboots, until re-enabled explicitly with Host.enable.
Minimum Role: client-cert
Return Type: void

RPC name: disabledisplay

Overview:
Disable console output to the physical display device next time this host boots
Signature:
host_display disable_display (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
Minimum Role: pool-operator
Return Type: host_display
This host's physical display usage

RPC name: disableexternalauth

Overview:
This call disables external authentication on the local host
Signature:
void disable_external_auth (session ref session_ref, host ref host, (string -> string) map config, bool force)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host whose external authentication should be disabled
(string -> string) map config Optional parameters as a list of key-values containing the configuration data
bool force Disable external auth even when not enabled
Minimum Role: pool-admin
Return Type: void

RPC name: disablelocalstoragecaching

Overview:
Disable the use of a local SR for caching purposes
Signature:
void disable_local_storage_caching (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
Minimum Role: pool-operator
Return Type: void

RPC name: disablessh

Overview:
Disable SSH access on the host. It will stop the service sshd only if it is running. It will also disable the service sshd only if it is enabled. A newly joined host in the pool or an ejected host from the pool would keep the original status.
Signature:
void disable_ssh (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
Minimum Role: pool-admin
Return Type: void

RPC name: dmesg

Overview:
Get the host xen dmesg.
Signature:
string dmesg (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to query
Minimum Role: pool-operator
Return Type: string
dmesg string

RPC name: dmesgclear

Overview:
Get the host xen dmesg, and clear the buffer.
Signature:
string dmesg_clear (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to query
Minimum Role: pool-operator
Return Type: string
dmesg string

RPC name: emergencyclearmandatoryguidance

Overview:
Clear the pending mandatory guidance on this host
Signature:
void emergency_clear_mandatory_guidance (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Return Type: void

RPC name: emergencydisabletlsverification

Overview:
Disable TLS verification for this host only
Signature:
void emergency_disable_tls_verification (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Return Type: void

RPC name: emergencyhadisable

Overview:
This call disables HA on the local host. This should only be used with extreme care.
Signature:
void emergency_ha_disable (session ref session_ref, bool soft)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
bool soft Disable HA temporarily, revert upon host reboot or further changes, idempotent
Minimum Role: pool-operator
Return Type: void

RPC name: emergencyreenabletlsverification

Overview:
Reenable TLS verification for this host only, and only after it was emergency disabled
Signature:
void emergency_reenable_tls_verification (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Return Type: void

RPC name: emergencyresetservercertificate

Overview:
Delete the current TLS server certificate and replace by a new, selfsigned one. This should only be used with extreme care.
Signature:
void emergency_reset_server_certificate (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Return Type: void

RPC name: enable

Overview:
Puts the host into a state in which new VMs can be started.
Signature:
void enable (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to enable
Minimum Role: client-cert
Return Type: void

RPC name: enabledisplay

Overview:
Enable console output to the physical display device next time this host boots
Signature:
host_display enable_display (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
Minimum Role: pool-operator
Return Type: host_display
This host's physical display usage

RPC name: enableexternalauth

Overview:
This call enables external authentication on a host
Signature:
void enable_external_auth (session ref session_ref, host ref host, (string -> string) map config, string service_name, string auth_type)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host whose external authentication should be enabled
(string -> string) map config A list of key-values containing the configuration data
string service_name The name of the service
string auth_type The type of authentication (for example, AD for Active Directory)
Minimum Role: pool-admin
Return Type: void

RPC name: enablelocalstoragecaching

Overview:
Enable the use of a local SR for caching purposes
Signature:
void enable_local_storage_caching (session ref session_ref, host ref host, SR ref sr)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
SR ref sr The SR to use as a local cache
Minimum Role: pool-operator
Return Type: void

RPC name: enablessh

Overview:
Enable SSH access on the host. It will start the service sshd only if it is not running. It will also enable the service sshd only if it is not enabled. A newly joined host in the pool or an ejected host from the pool would keep the original status.
Signature:
void enable_ssh (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
Minimum Role: pool-admin
Return Type: void

RPC name: evacuate

Overview:
Migrate all VMs off of this host, where possible.
Signature:
void evacuate (session ref session_ref, host ref host, network ref network, int evacuate_batch_size)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host to evacuate
network ref network Optional preferred network for migration
int evacuate_batch_size The maximum number of VMs to be migrated per batch 0 will use the value evacuation-batch-size defined in xapi.conf
Minimum Role: client-cert
Return Type: void

RPC name: externalauthsetldaps

Overview:
This call enables or disables LDAPS for external authentication on the host
Signature:
void external_auth_set_ldaps (session ref session_ref, host ref host, bool ldaps, bool force)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host whose LDAPS configuration should be set
bool ldaps Whether to enable or disable LDAPS
bool force Force the operation even if already in the desired state
Minimum Role: pool-admin
Return Type: void

RPC name: forgetdatasourcearchives

Overview:
Forget the recorded statistics related to the specified data source
Signature:
void forget_data_source_archives (session ref session_ref, host ref host, string data_source)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string data_source The data source whose archives are to be forgotten
Minimum Role: pool-operator
Return Type: void

RPC name: getaddress

Overview:
Get the address field of the given host.
Signature:
string get_address (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getall

Overview:
Return a list of all the hosts known to the system.
Signature:
host ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: host ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of host references to host records for all hosts known to the system.
Signature:
(host ref -> host record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (host ref -> host record) map
records of all objects

RPC name: getallowedoperations

Overview:
Get the allowedoperations field of the given host.
Signature:
host_allowed_operations set get_allowed_operations (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: host_allowed_operations set
value of the field

RPC name: getAPIversionmajor

Overview:
Get the APIversion/major field of the given host.
Signature:
int get_API_version_major (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getAPIversionminor

Overview:
Get the APIversion/minor field of the given host.
Signature:
int get_API_version_minor (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getAPIversionvendor

Overview:
Get the APIversion/vendor field of the given host.
Signature:
string get_API_version_vendor (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getAPIversionvendorimplementation

Overview:
Get the APIversion/vendorimplementation field of the given host.
Signature:
(string -> string) map get_API_version_vendor_implementation (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getbiosstrings

Overview:
Get the biosstrings field of the given host.
Signature:
(string -> string) map get_bios_strings (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getblobs

Overview:
Get the blobs field of the given host.
Signature:
(string -> blob ref) map get_blobs (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> blob ref) map
value of the field

RPC name: getbynamelabel

Overview:
Get all the host instances with the given label.
Signature:
host ref set get_by_name_label (session ref session_ref, string label)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string label label of object to return
Minimum Role: read-only
Return Type: host ref set
references to objects with matching names

RPC name: getbyuuid

Overview:
Get a reference to the host instance with the specified UUID.
Signature:
host ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return
Minimum Role: read-only
Return Type: host ref
reference to the object

RPC name: getcapabilities

Overview:
Get the capabilities field of the given host.
Signature:
string set get_capabilities (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string set
value of the field

RPC name: getcertificates

Overview:
Get the certificates field of the given host.
Signature:
Certificate ref set get_certificates (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: Certificate ref set
value of the field

RPC name: getchipsetinfo

Overview:
Get the chipsetinfo field of the given host.
Signature:
(string -> string) map get_chipset_info (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getconsoleidletimeout

Overview:
Get the consoleidletimeout field of the given host.
Signature:
int get_console_idle_timeout (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getcontroldomain

Overview:
Get the controldomain field of the given host.
Signature:
VM ref get_control_domain (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: VM ref
value of the field

RPC name: getcpuconfiguration

Overview:
Get the cpuconfiguration field of the given host.
Signature:
(string -> string) map get_cpu_configuration (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getcpuinfo

Overview:
Get the cpuinfo field of the given host.
Signature:
(string -> string) map get_cpu_info (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getcrashdumpsr

Overview:
Get the crashdumpsr field of the given host.
Signature:
SR ref get_crash_dump_sr (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: SR ref
value of the field

RPC name: getcrashdumps

Overview:
Get the crashdumps field of the given host.
Signature:
host_crashdump ref set get_crashdumps (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: host_crashdump ref set
value of the field

RPC name: getcurrentoperations

Overview:
Get the currentoperations field of the given host.
Signature:
(string -> host_allowed_operations) map get_current_operations (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> host_allowed_operations) map
value of the field

RPC name: getdatasources

Overview:
Signature:
data_source record set get_data_sources (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host to interrogate
Minimum Role: read-only
Return Type: data_source record set
A set of data sources

RPC name: getdisplay

Overview:
Get the display field of the given host.
Signature:
host_display get_display (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: host_display
value of the field

RPC name: getedition

Overview:
Get the edition field of the given host.
Signature:
string get_edition (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: geteditions

Overview:
Get the editions field of the given host.
Signature:
string set get_editions (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string set
value of the field

RPC name: getenabled

Overview:
Get the enabled field of the given host.
Signature:
bool get_enabled (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getexternalauthconfiguration

Overview:
Get the externalauthconfiguration field of the given host.
Signature:
(string -> string) map get_external_auth_configuration (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getexternalauthservicename

Overview:
Get the externalauthservicename field of the given host.
Signature:
string get_external_auth_service_name (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getexternalauthtype

Overview:
Get the externalauthtype field of the given host.
Signature:
string get_external_auth_type (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getfeatures

Overview:
Get the features field of the given host.
Signature:
Feature ref set get_features (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: Feature ref set
value of the field

RPC name: getguestVCPUsparams

Overview:
Get the guestVCPUsparams field of the given host.
Signature:
(string -> string) map get_guest_VCPUs_params (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: gethanetworkpeers

Overview:
Get the hanetworkpeers field of the given host.
Signature:
string set get_ha_network_peers (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string set
value of the field

RPC name: gethastatefiles

Overview:
Get the hastatefiles field of the given host.
Signature:
string set get_ha_statefiles (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string set
value of the field

RPC name: gethostCPUs

Overview:
Get the hostCPUs field of the given host.
Signature:
host_cpu ref set get_host_CPUs (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: host_cpu ref set
value of the field

RPC name: gethostname

Overview:
Get the hostname field of the given host.
Signature:
string get_hostname (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: gethttpsonly

Overview:
Get the httpsonly field of the given host.
Signature:
bool get_https_only (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getiscsiiqn

Overview:
Get the iscsiiqn field of the given host.
Signature:
string get_iscsi_iqn (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getlastsoftwareupdate

Overview:
Get the lastsoftwareupdate field of the given host.
Signature:
datetime get_last_software_update (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getlastupdatehash

Overview:
Get the lastupdatehash field of the given host.
Signature:
string get_last_update_hash (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getlatestsyncedupdatesapplied

Overview:
Get the latestsyncedupdatesapplied field of the given host.
Signature:
latest_synced_updates_applied_state get_latest_synced_updates_applied (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: latest_synced_updates_applied_state
value of the field

RPC name: getlicenseparams

Overview:
Get the licenseparams field of the given host.
Signature:
(string -> string) map get_license_params (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getlicenseserver

Overview:
Get the licenseserver field of the given host.
Signature:
(string -> string) map get_license_server (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getlocalcachesr

Overview:
Get the localcachesr field of the given host.
Signature:
SR ref get_local_cache_sr (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: SR ref
value of the field

RPC name: getlog

Overview:
Get the host's log file
Signature:
string get_log (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to query
Minimum Role: read-only
Return Type: string
The contents of the host's primary log file

RPC name: getlogging

Overview:
Get the logging field of the given host.
Signature:
(string -> string) map get_logging (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getmanagementinterface

Overview:
Returns the management interface for the specified host
Signature:
PIF ref get_management_interface (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host Which host's management interface is required
Minimum Role: pool-operator
Return Type: PIF ref
The management interface for the host

RPC name: getmaxcstate

Overview:
Get the maxcstate field of the given host.
Signature:
string get_max_cstate (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getmemoryoverhead

Overview:
Get the memory/overhead field of the given host.
Signature:
int get_memory_overhead (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getmetrics

Overview:
Get the metrics field of the given host.
Signature:
host_metrics ref get_metrics (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: host_metrics ref
value of the field

RPC name: getmultipathing

Overview:
Get the multipathing field of the given host.
Signature:
bool get_multipathing (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getnamedescription

Overview:
Get the name/description field of the given host.
Signature:
string get_name_description (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getnamelabel

Overview:
Get the name/label field of the given host.
Signature:
string get_name_label (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getntpcustomservers

Overview:
Get the ntpcustomservers field of the given host.
Signature:
string set get_ntp_custom_servers (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string set
value of the field

RPC name: getntpmode

Overview:
Get the ntpmode field of the given host.
Signature:
host_ntp_mode get_ntp_mode (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: host_ntp_mode
value of the field

RPC name: getntpserversstatus

Overview:
Get the NTP servers status on the host
Signature:
(string -> string) map get_ntp_servers_status (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
Minimum Role: read-only
Return Type: (string -> string) map
The map of NTP server to its status, status may be synced/combined/uncombined/error/variable/unreachable/unknown

RPC name: getntpsynchronized

Overview:
Returns true if the system clock on the host is synchronized with the NTP servers.
Signature:
bool get_ntp_synchronized (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
Minimum Role: read-only
Return Type: bool
true if the system clock on the host is synchronized with the NTP servers.

RPC name: getnumaaffinitypolicy

Overview:
Get the numaaffinitypolicy field of the given host.
Signature:
host_numa_affinity_policy get_numa_affinity_policy (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: host_numa_affinity_policy
value of the field

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given host.
Signature:
(string -> string) map get_other_config (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getpatches

This message is deprecated.
Overview:
Get the patches field of the given host.
Signature:
host_patch ref set get_patches (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: host_patch ref set
value of the field

RPC name: getPBDs

Overview:
Get the PBDs field of the given host.
Signature:
PBD ref set get_PBDs (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: PBD ref set
value of the field

RPC name: getPCIs

Overview:
Get the PCIs field of the given host.
Signature:
PCI ref set get_PCIs (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: PCI ref set
value of the field

RPC name: getpendingguidances

Overview:
Get the pendingguidances field of the given host.
Signature:
update_guidances set get_pending_guidances (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: update_guidances set
value of the field

RPC name: getpendingguidancesfull

Overview:
Get the pendingguidancesfull field of the given host.
Signature:
update_guidances set get_pending_guidances_full (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: update_guidances set
value of the field

RPC name: getPGPUs

Overview:
Get the PGPUs field of the given host.
Signature:
PGPU ref set get_PGPUs (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: PGPU ref set
value of the field

RPC name: getPIFs

Overview:
Get the PIFs field of the given host.
Signature:
PIF ref set get_PIFs (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: PIF ref set
value of the field

RPC name: getpoweronconfig

Overview:
Get the poweronconfig field of the given host.
Signature:
(string -> string) map get_power_on_config (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getpoweronmode

Overview:
Get the poweronmode field of the given host.
Signature:
string get_power_on_mode (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getPUSBs

Overview:
Get the PUSBs field of the given host.
Signature:
PUSB ref set get_PUSBs (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: PUSB ref set
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given host.
Signature:
host record get_record (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: host record
all fields from the object

RPC name: getresidentVMs

Overview:
Get the residentVMs field of the given host.
Signature:
VM ref set get_resident_VMs (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: VM ref set
value of the field

RPC name: getschedgran

Overview:
Gets xen's schedgran on a host
Signature:
host_sched_gran get_sched_gran (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
Return Type: host_sched_gran
The host's schedgran

RPC name: getschedpolicy

Overview:
Get the schedpolicy field of the given host.
Signature:
string get_sched_policy (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getsecureboot

Overview:
Get the secureboot field of the given host.
Signature:
bool get_secure_boot (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getservercertificate

Overview:
Get the installed server public TLS certificate.
Signature:
string get_server_certificate (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
Minimum Role: read-only
Return Type: string
The installed server public TLS certificate, in PEM form.

RPC name: getserverlocaltime

Overview:
This call queries the host's clock for the current time in the host's local timezone
Signature:
datetime get_server_localtime (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host whose clock should be queried
Minimum Role: read-only
Return Type: datetime
The current local time

RPC name: getservertime

Overview:
This call queries the host's clock for the current time
Signature:
datetime get_servertime (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host whose clock should be queried
Minimum Role: read-only
Return Type: datetime
The current time

RPC name: getsoftwareversion

Overview:
Get the softwareversion field of the given host.
Signature:
(string -> string) map get_software_version (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getsshautomode

Overview:
Get the sshautomode field of the given host.
Signature:
bool get_ssh_auto_mode (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getsshenabled

Overview:
Get the sshenabled field of the given host.
Signature:
bool get_ssh_enabled (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getsshenabledtimeout

Overview:
Get the sshenabledtimeout field of the given host.
Signature:
int get_ssh_enabled_timeout (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getsshexpiry

Overview:
Get the sshexpiry field of the given host.
Signature:
datetime get_ssh_expiry (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getssllegacy

This message is deprecated.
Overview:
Get the ssllegacy field of the given host.
Signature:
bool get_ssl_legacy (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getsupportedbootloaders

Overview:
Get the supportedbootloaders field of the given host.
Signature:
string set get_supported_bootloaders (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string set
value of the field

RPC name: getsuspendimagesr

Overview:
Get the suspendimagesr field of the given host.
Signature:
SR ref get_suspend_image_sr (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: SR ref
value of the field

RPC name: getsystemstatuscapabilities

Overview:
Signature:
string get_system_status_capabilities (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host to interrogate
Minimum Role: read-only
Return Type: string
An XML fragment containing the system status capabilities.

RPC name: gettags

Overview:
Get the tags field of the given host.
Signature:
string set get_tags (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string set
value of the field

RPC name: gettimezone

Overview:
Get the timezone field of the given host.
Signature:
string get_timezone (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: gettlsverificationenabled

Overview:
Get the tlsverificationenabled field of the given host.
Signature:
bool get_tls_verification_enabled (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: gettrackeduseragents

Overview:
Get the name, version list of tracked user agents on this host. If different versions of the same name are seen, keep the lastseen version. The oldest entry will be removed if reach the max num. Note that the list is cleared after host/XAPI restart
Signature:
(string -> string) map get_tracked_user_agents (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
Minimum Role: read-only
Return Type: (string -> string) map
The name, version list of user agents that have been tracked on this host

RPC name: getueficertificates

This message is deprecated.
Overview:
Get the ueficertificates field of the given host.
Signature:
string get_uefi_certificates (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getuncooperativeresidentVMs

This message is deprecated.
Overview:
Return a set of VMs which are not cooperating with the host's memory control system
Signature:
VM ref set get_uncooperative_resident_VMs (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host to query
Minimum Role: read-only
Return Type: VM ref set
VMs which are not cooperating

RPC name: getupdates

Overview:
Get the updates field of the given host.
Signature:
pool_update ref set get_updates (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: pool_update ref set
value of the field

RPC name: getupdatesrequiringreboot

Overview:
Get the updatesrequiringreboot field of the given host.
Signature:
pool_update ref set get_updates_requiring_reboot (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: pool_update ref set
value of the field

RPC name: getuuid

Overview:
Get the uuid field of the given host.
Signature:
string get_uuid (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getvirtualhardwareplatformversions

Overview:
Get the virtualhardwareplatformversions field of the given host.
Signature:
int set get_virtual_hardware_platform_versions (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
Minimum Role: read-only
Return Type: int set
value of the field

RPC name: getvmswhichpreventevacuation

Overview:
Return a set of VMs which prevent the host being evacuated, with perVM error codes
Signature:
(VM ref -> string set) map get_vms_which_prevent_evacuation (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host to query
Minimum Role: read-only
Return Type: (VM ref -> string set) map
VMs which block evacuation together with reasons

RPC name: hasextension

Overview:
Return true if the extension is available on the host
Signature:
bool has_extension (session ref session_ref, host ref host, string name)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string name The name of the API call
Minimum Role: pool-admin
Return Type: bool
True if the extension exists, false otherwise

RPC name: installservercertificate

Overview:
Install the TLS server certificate.
Signature:
void install_server_certificate (session ref session_ref, host ref host, string certificate, string private_key, string certificate_chain)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string certificate The server certificate, in PEM form
string private_key The unencrypted private key used to sign the certificate, in PKCS#8 form
string certificate_chain The certificate chain, in PEM form
Minimum Role: pool-admin
Return Type: void

RPC name: licenseadd

Overview:
Apply a new license to a host
Signature:
void license_add (session ref session_ref, host ref host, string contents)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host to upload the license to
string contents The contents of the license file, base64 encoded
Minimum Role: pool-operator
Return Type: void
Possible Error Codes: LICENSE_PROCESSING_ERROR

RPC name: licenseapply

This message is removed.
Overview:
Apply a new license to a host
Signature:
void license_apply (session ref session_ref, host ref host, string contents)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host to upload the license to
string contents The contents of the license file, base64 encoded
Minimum Role: pool-operator
Return Type: void
Possible Error Codes: LICENSE_PROCESSING_ERROR

RPC name: licenseremove

Overview:
Remove any license file from the specified host, and switch that host to the unlicensed edition
Signature:
void license_remove (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host from which any license will be removed
Minimum Role: pool-operator
Return Type: void

RPC name: listmethods

Overview:
List all supported methods
Signature:
string set list_methods (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: string set
The name of every supported method.

RPC name: listtimezones

Overview:
List all available timezones on the host.
Signature:
string set list_timezones (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
Minimum Role: read-only
Return Type: string set
The set of available timezones on the host

RPC name: localmanagementreconfigure

Overview:
Reconfigure the management network interface. Should only be used if Host.managementreconfigure is impossible because the network configuration is broken.
Signature:
void local_management_reconfigure (session ref session_ref, string interface)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string interface name of the interface to use as a management interface
Minimum Role: pool-operator
Return Type: void

RPC name: managementdisable

Overview:
Disable the management network interface
Signature:
void management_disable (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: pool-operator
Return Type: void

RPC name: managementreconfigure

Overview:
Reconfigure the management network interface
Signature:
void management_reconfigure (session ref session_ref, PIF ref pif)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF ref pif reference to a PIF object corresponding to the management interface
Minimum Role: pool-operator
Return Type: void

RPC name: migratereceive

Overview:
Prepare to receive a VM, returning a token which can be passed to VM.migrate.
Signature:
(string -> string) map migrate_receive (session ref session_ref, host ref host, network ref network, (string -> string) map options)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The target host
network ref network The network through which migration traffic should be received.
(string -> string) map options Extra configuration operations
Minimum Role: vm-power-admin
Return Type: (string -> string) map
A value which should be passed to VM.migrate

RPC name: poweron

Overview:
Attempt to poweron the host if the capability exists.
Signature:
void power_on (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to power on
Minimum Role: pool-operator
Return Type: void

RPC name: querydatasource

Overview:
Query the latest value of the specified data source
Signature:
float query_data_source (session ref session_ref, host ref host, string data_source)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string data_source The data source to query
Minimum Role: read-only
Return Type: float
The latest value, averaged over the last 5 seconds

RPC name: reboot

Overview:
Reboot the host. This function can only be called if there are no currently running VMs on the host and it is disabled.
Signature:
void reboot (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to reboot
Minimum Role: pool-operator
Return Type: void

RPC name: recorddatasource

Overview:
Start recording the specified data source
Signature:
void record_data_source (session ref session_ref, host ref host, string data_source)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string data_source The data source to record
Minimum Role: pool-operator
Return Type: void

RPC name: refreshpackinfo

This message is deprecated.
Overview:
Refresh the list of installed Supplemental Packs.
Signature:
void refresh_pack_info (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to modify
Minimum Role: pool-operator
Return Type: void

RPC name: refreshservercertificate

Overview:
Replace the internal selfsigned host certficate with a new one.
Signature:
void refresh_server_certificate (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
Minimum Role: pool-admin
Return Type: void

RPC name: removefromguestVCPUsparams

Overview:
Remove the given key and its corresponding value from the guestVCPUsparams field of the given host. If the key is not in that Map, then do nothing.
Signature:
void remove_from_guest_VCPUs_params (session ref session_ref, host ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string key Key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: removefromlicenseserver

Overview:
Remove the given key and its corresponding value from the licenseserver field of the given host. If the key is not in that Map, then do nothing.
Signature:
void remove_from_license_server (session ref session_ref, host ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string key Key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: removefromlogging

Overview:
Remove the given key and its corresponding value from the logging field of the given host. If the key is not in that Map, then do nothing.
Signature:
void remove_from_logging (session ref session_ref, host ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string key Key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given host. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, host ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string key Key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: removetags

Overview:
Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing.
Signature:
void remove_tags (session ref session_ref, host ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string value Value to remove
Minimum Role: vm-operator
Return Type: void

RPC name: rescandrivers

Overview:
Scan the host and update its driver information.
Signature:
void rescan_drivers (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host to be rescanned
Minimum Role: pool-admin
Return Type: void

RPC name: resetcpufeatures

This message is removed.
Overview:
Remove the feature mask, such that after a reboot all features of the CPU are enabled.
Signature:
void reset_cpu_features (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
Minimum Role: pool-operator
Return Type: void

RPC name: resetservercertificate

Overview:
Delete the current TLS server certificate and replace by a new, selfsigned one. This should only be used with extreme care.
Signature:
void reset_server_certificate (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
Minimum Role: pool-admin
Return Type: void

RPC name: restartagent

Overview:
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.
Signature:
void restart_agent (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host on which you want to restart the agent
Minimum Role: pool-operator
Return Type: void

RPC name: retrievewlbevacuaterecommendations

Overview:
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.
Signature:
(VM ref -> string set) map retrieve_wlb_evacuate_recommendations (session ref session_ref, host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host to query
Minimum Role: read-only
Return Type: (VM ref -> string set) map
VMs and the reasons why they would block evacuation, or their target host recommended by the wlb server

RPC name: senddebugkeys

Overview:
Inject the given string as debugging keys into Xen
Signature:
void send_debug_keys (session ref session_ref, host ref host, string keys)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string keys The keys to send
Minimum Role: pool-admin
Return Type: void

RPC name: setaddress

Overview:
Set the address field of the given host.
Signature:
void set_address (session ref session_ref, host ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setconsoleidletimeout

Overview:
Set the console idle timeout for the host
Signature:
void set_console_idle_timeout (session ref session_ref, host ref self, int value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
int value The console idle timeout in seconds
Minimum Role: pool-admin
Return Type: void

RPC name: setcpufeatures

This message is removed.
Overview:
Set the CPU features to be used after a reboot, if the given features string is valid.
Signature:
void set_cpu_features (session ref session_ref, host ref host, string features)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string features The features string (32 hexadecimal digits)
Minimum Role: pool-operator
Return Type: void

RPC name: setcrashdumpsr

Overview:
Set the crashdumpsr field of the given host.
Signature:
void set_crash_dump_sr (session ref session_ref, host ref self, SR ref value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
SR ref value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setdisplay

Overview:
Set the display field of the given host.
Signature:
void set_display (session ref session_ref, host ref self, host_display value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
host_display value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setguestVCPUsparams

Overview:
Set the guestVCPUsparams field of the given host.
Signature:
void set_guest_VCPUs_params (session ref session_ref, host ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: sethostname

Overview:
Set the hostname field of the given host.
Signature:
void set_hostname (session ref session_ref, host ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: sethostnamelive

Overview:
Sets the host name to the specified string. Both the API and lowerlevel system hostname are changed immediately.
Signature:
void set_hostname_live (session ref session_ref, host ref host, string hostname)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host whose host name to set
string hostname The new host name
Minimum Role: pool-operator
Return Type: void
Possible Error Codes: HOST_NAME_INVALID

RPC name: sethttpsonly

Overview:
updates the host firewall to open or close port 80 depending on the value
Signature:
void set_https_only (session ref session_ref, host ref self, bool value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The Host
bool value true - http port 80 will be blocked, false - http port 80 will be open
Minimum Role: pool-operator
Return Type: void

RPC name: setiscsiiqn

Overview:
Sets the initiator IQN for the host
Signature:
void set_iscsi_iqn (session ref session_ref, host ref host, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string value The value to which the IQN should be set
Minimum Role: pool-operator
Return Type: void

RPC name: setlicenseserver

Overview:
Set the licenseserver field of the given host.
Signature:
void set_license_server (session ref session_ref, host ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setlogging

Overview:
Set the logging field of the given host.
Signature:
void set_logging (session ref session_ref, host ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setmaxcstate

Overview:
Sets xen's maxcstate on a host. See: https://xenbits.xen.org/docs/unstable/misc/xencommandline.htmlmaxcstatex86. "" means unlimited; "N" means limit to CN; "N,M" means limit to CN with max sub cstate M. Note: Only C0, C1, unlimited are supported currently.
Signature:
void set_max_cstate (session ref session_ref, host ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
string value The max_cstate to apply to a host
Minimum Role: pool-operator
Return Type: void

RPC name: setmultipathing

Overview:
Specifies whether multipathing is enabled
Signature:
void set_multipathing (session ref session_ref, host ref host, bool value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
bool value Whether multipathing should be enabled
Minimum Role: pool-operator
Return Type: void

RPC name: setnamedescription

Overview:
Set the name/description field of the given host.
Signature:
void set_name_description (session ref session_ref, host ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setnamelabel

Overview:
Set the name/label field of the given host.
Signature:
void set_name_label (session ref session_ref, host ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setntpcustomservers

Overview:
Set the custom NTP servers for the host
Signature:
void set_ntp_custom_servers (session ref session_ref, host ref self, string set value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
string set value The set of custom NTP servers to configure
Minimum Role: pool-operator
Return Type: void

RPC name: setntpmode

Overview:
Set the NTP mode for the host
Signature:
void set_ntp_mode (session ref session_ref, host ref self, host_ntp_mode value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
host_ntp_mode value The NTP mode to set
Minimum Role: pool-operator
Return Type: void

RPC name: setnumaaffinitypolicy

Overview:
Set VM placement NUMA affinity policy
Signature:
void set_numa_affinity_policy (session ref session_ref, host ref self, host_numa_affinity_policy value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
host_numa_affinity_policy value The NUMA affinity policy to apply to a host
Minimum Role: pool-admin
Return Type: void

RPC name: setotherconfig

Overview:
Set the otherconfig field of the given host.
Signature:
void set_other_config (session ref session_ref, host ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setpoweronmode

Overview:
Set the poweronmode, host, user and password
Signature:
void set_power_on_mode (session ref session_ref, host ref self, string power_on_mode, (string -> string) map power_on_config)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
string power_on_mode power-on-mode can be empty, wake-on-lan, IPMI or other
(string -> string) map power_on_config Power on config
Minimum Role: pool-operator
Return Type: void

RPC name: setschedgran

Overview:
Sets xen's schedgran on a host. See: https://xenbits.xen.org/docs/unstable/misc/xencommandline.htmlschedgranx86
Signature:
void set_sched_gran (session ref session_ref, host ref self, host_sched_gran value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
host_sched_gran value The sched-gran to apply to a host
Return Type: void

RPC name: setservertime

Overview:
Set the host's system clock when NTP is disabled.
Signature:
void set_servertime (session ref session_ref, host ref self, datetime value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
datetime value A date/time to be set. When a timezone offset is missing, UTC is assumed.
Minimum Role: pool-operator
Return Type: void

RPC name: setsshautomode

Overview:
Set the SSH auto mode for the host
Signature:
void set_ssh_auto_mode (session ref session_ref, host ref self, bool value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
bool value The SSH auto mode for the host. When true, the SSH port is closed by default and it's open only in case the API is unavailable. When false, the SSH port is always open.
Minimum Role: pool-admin
Return Type: void

RPC name: setsshenabledtimeout

Overview:
Set the SSH service enabled timeout for the host
Signature:
void set_ssh_enabled_timeout (session ref session_ref, host ref self, int value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
int value The SSH enabled timeout in seconds (0 means no timeout, max 2 days)
Minimum Role: pool-admin
Return Type: void

RPC name: setssllegacy

Overview:
Enable/disable SSLv3 for interoperability with older server versions. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. API login sessions will remain valid.
Signature:
void set_ssl_legacy (session ref session_ref, host ref self, bool value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
bool value True to allow SSLv3 and ciphersuites as used in old XenServer versions
Minimum Role: pool-operator
Return Type: void

RPC name: setsuspendimagesr

Overview:
Set the suspendimagesr field of the given host.
Signature:
void set_suspend_image_sr (session ref session_ref, host ref self, SR ref value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
SR ref value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: settags

Overview:
Set the tags field of the given host.
Signature:
void set_tags (session ref session_ref, host ref self, string set value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self reference to the object
string set value New value to set
Minimum Role: vm-operator
Return Type: void

RPC name: settimezone

Overview:
Set the host's timezone.
Signature:
void set_timezone (session ref session_ref, host ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref self The host
string value The time zone identifier as defined in the IANA Time Zone Database
Minimum Role: pool-operator
Return Type: void

RPC name: setueficertificates

This message is deprecated.
Overview:
Sets the UEFI certificates on a host
Signature:
void set_uefi_certificates (session ref session_ref, host ref host, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
string value The certificates to apply to a host
Return Type: void

RPC name: shutdown

Overview:
Shutdown the host. This function can only be called if there are no currently running VMs on the host and it is disabled.
Signature:
void shutdown (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The Host to shutdown
Minimum Role: pool-operator
Return Type: void

RPC name: shutdownagent

Overview:
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.
Signature:
void shutdown_agent (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: pool-operator
Return Type: void

RPC name: syncdata

Overview:
This causes the synchronisation of the nondatabase data messages, RRDs and so on stored on the master to be synchronised with the host
Signature:
void sync_data (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host to whom the data should be sent
Minimum Role: pool-admin
Return Type: void

RPC name: syslogreconfigure

Overview:
Reconfigure syslog logging
Signature:
void syslog_reconfigure (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host Tell the host to reread its Host.logging parameters and reconfigure itself accordingly
Minimum Role: pool-operator
Return Type: void