Class: host

A physical host

Fields for class: host

RPCs associated with class: host

RPC name: add_tags

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)
<!--NeedCopy-->

Arguments:

Minimum Role: vm-operator

Return Type: void

RPC name: add_to_guest_VCPUs_params

Overview:

Add the given key-value pair to the guest_VCPUs_params field of the given host.

Signature:

void add_to_guest_VCPUs_params (session ref session_ref, host ref self, string key, string value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: add_to_license_server

Overview:

Add the given key-value pair to the license_server field of the given host.

Signature:

void add_to_license_server (session ref session_ref, host ref self, string key, string value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: add_to_logging

Overview:

Add the given key-value 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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: add_to_other_config

Overview:

Add the given key-value pair to the other_config field of the given host.

Signature:

void add_to_other_config (session ref session_ref, host ref self, string key, string value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: apply_edition

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: apply_recommended_guidances

This message is removed.

Overview:

apply all recommended guidances both on the host and on all HVM VMs on the host after updates are applied on the host

Signature:

void apply_recommended_guidances (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: apply_updates

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)
<!--NeedCopy-->

Arguments:

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: assert_can_evacuate

Overview:

Check this host can be evacuated.

Signature:

void assert_can_evacuate (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: backup_rrds

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: void

RPC name: bugreport_upload

Overview:

Run xen-bugtool --yestoall and upload the output to support

Signature:

void bugreport_upload (session ref session_ref, host ref host, string url, (string -> string) map options)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: call_extension

Overview:

Call an API extension on this host

Signature:

string call_extension (session ref session_ref, host ref host, string call)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: string

Result from the extension

RPC name: call_plugin

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: string

Result from the plugin

RPC name: compute_free_memory

Overview:

Computes the amount of free memory on the host.

Signature:

int compute_free_memory (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: int

the amount of free memory on the host.

RPC name: compute_memory_overhead

Overview:

Computes the virtualization memory overhead of a host.

Signature:

int compute_memory_overhead (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: int

the virtualization memory overhead of the host.

RPC name: create_new_blob

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: blob ref

The reference of the blob, needed for populating its data

RPC name: declare_dead

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)
<!--NeedCopy-->

Arguments:

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)
<!--NeedCopy-->

Arguments:

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)
<!--NeedCopy-->

Arguments:

Minimum Role: client-cert

Return Type: void

RPC name: disable_display

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: host_display

This host’s physical display usage

RPC name: disable_external_auth

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: void

RPC name: disable_local_storage_caching

Overview:

Disable the use of a local SR for caching purposes

Signature:

void disable_local_storage_caching (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: dmesg

Overview:

Get the host xen dmesg.

Signature:

string dmesg (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: string

dmesg string

RPC name: dmesg_clear

Overview:

Get the host xen dmesg, and clear the buffer.

Signature:

string dmesg_clear (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: string

dmesg string

RPC name: emergency_clear_mandatory_guidance

Overview:

Clear the pending mandatory guidance on this host

Signature:

void emergency_clear_mandatory_guidance (session ref session_ref)
<!--NeedCopy-->

Arguments:

Return Type: void

RPC name: emergency_disable_tls_verification

Overview:

Disable TLS verification for this host only

Signature:

void emergency_disable_tls_verification (session ref session_ref)
<!--NeedCopy-->

Arguments:

Return Type: void

RPC name: emergency_ha_disable

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: emergency_reenable_tls_verification

Overview:

Reenable TLS verification for this host only

Signature:

void emergency_reenable_tls_verification (session ref session_ref)
<!--NeedCopy-->

Arguments:

Return Type: void

RPC name: emergency_reset_server_certificate

Overview:

Delete the current TLS server certificate and replace by a new, self-signed one. This should only be used with extreme care.

Signature:

void emergency_reset_server_certificate (session ref session_ref)
<!--NeedCopy-->

Arguments:

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)
<!--NeedCopy-->

Arguments:

Minimum Role: client-cert

Return Type: void

RPC name: enable_display

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: host_display

This host’s physical display usage

RPC name: enable_external_auth

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: void

RPC name: enable_local_storage_caching

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

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)
<!--NeedCopy-->

Arguments:

Minimum Role: client-cert

Return Type: void

RPC name: forget_data_source_archives

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: get_address

Overview:

Get the address field of the given host.

Signature:

string get_address (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_all

Overview:

Return a list of all the hosts known to the system.

Signature:

host ref set get_all (session ref session_ref)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host ref set

references to all objects

RPC name: get_all_records

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)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (host ref -> host record) map

records of all objects

RPC name: get_allowed_operations

Overview:

Get the allowed_operations field of the given host.

Signature:

host_allowed_operations set get_allowed_operations (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host_allowed_operations set

value of the field

RPC name: get_API_version_major

Overview:

Get the API_version/major field of the given host.

Signature:

int get_API_version_major (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: int

value of the field

RPC name: get_API_version_minor

Overview:

Get the API_version/minor field of the given host.

Signature:

int get_API_version_minor (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: int

value of the field

RPC name: get_API_version_vendor

Overview:

Get the API_version/vendor field of the given host.

Signature:

string get_API_version_vendor (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_API_version_vendor_implementation

Overview:

Get the API_version/vendor_implementation field of the given host.

Signature:

(string -> string) map get_API_version_vendor_implementation (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_bios_strings

Overview:

Get the bios_strings field of the given host.

Signature:

(string -> string) map get_bios_strings (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_blobs

Overview:

Get the blobs field of the given host.

Signature:

(string -> blob ref) map get_blobs (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> blob ref) map

value of the field

RPC name: get_by_name_label

Overview:

Get all the host instances with the given label.

Signature:

host ref set get_by_name_label (session ref session_ref, string label)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host ref set

references to objects with matching names

RPC name: get_by_uuid

Overview:

Get a reference to the host instance with the specified UUID.

Signature:

host ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host ref

reference to the object

RPC name: get_capabilities

Overview:

Get the capabilities field of the given host.

Signature:

string set get_capabilities (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string set

value of the field

RPC name: get_certificates

Overview:

Get the certificates field of the given host.

Signature:

Certificate ref set get_certificates (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: Certificate ref set

value of the field

RPC name: get_chipset_info

Overview:

Get the chipset_info field of the given host.

Signature:

(string -> string) map get_chipset_info (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_control_domain

Overview:

Get the control_domain field of the given host.

Signature:

VM ref get_control_domain (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: VM ref

value of the field

RPC name: get_cpu_configuration

Overview:

Get the cpu_configuration field of the given host.

Signature:

(string -> string) map get_cpu_configuration (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_cpu_info

Overview:

Get the cpu_info field of the given host.

Signature:

(string -> string) map get_cpu_info (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_crash_dump_sr

Overview:

Get the crash_dump_sr field of the given host.

Signature:

SR ref get_crash_dump_sr (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: SR ref

value of the field

RPC name: get_crashdumps

Overview:

Get the crashdumps field of the given host.

Signature:

host_crashdump ref set get_crashdumps (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host_crashdump ref set

value of the field

RPC name: get_current_operations

Overview:

Get the current_operations field of the given host.

Signature:

(string -> host_allowed_operations) map get_current_operations (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> host_allowed_operations) map

value of the field

RPC name: get_data_sources

Overview:

Signature:

data_source record set get_data_sources (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: data_source record set

A set of data sources

RPC name: get_display

Overview:

Get the display field of the given host.

Signature:

host_display get_display (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host_display

value of the field

RPC name: get_edition

Overview:

Get the edition field of the given host.

Signature:

string get_edition (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_editions

Overview:

Get the editions field of the given host.

Signature:

string set get_editions (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string set

value of the field

RPC name: get_enabled

Overview:

Get the enabled field of the given host.

Signature:

bool get_enabled (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_external_auth_configuration

Overview:

Get the external_auth_configuration field of the given host.

Signature:

(string -> string) map get_external_auth_configuration (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_external_auth_service_name

Overview:

Get the external_auth_service_name field of the given host.

Signature:

string get_external_auth_service_name (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_external_auth_type

Overview:

Get the external_auth_type field of the given host.

Signature:

string get_external_auth_type (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_features

Overview:

Get the features field of the given host.

Signature:

Feature ref set get_features (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: Feature ref set

value of the field

RPC name: get_guest_VCPUs_params

Overview:

Get the guest_VCPUs_params field of the given host.

Signature:

(string -> string) map get_guest_VCPUs_params (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_ha_network_peers

Overview:

Get the ha_network_peers field of the given host.

Signature:

string set get_ha_network_peers (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string set

value of the field

RPC name: get_ha_statefiles

Overview:

Get the ha_statefiles field of the given host.

Signature:

string set get_ha_statefiles (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string set

value of the field

RPC name: get_host_CPUs

Overview:

Get the host_CPUs field of the given host.

Signature:

host_cpu ref set get_host_CPUs (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host_cpu ref set

value of the field

RPC name: get_hostname

Overview:

Get the hostname field of the given host.

Signature:

string get_hostname (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_https_only

Overview:

Get the https_only field of the given host.

Signature:

bool get_https_only (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_iscsi_iqn

Overview:

Get the iscsi_iqn field of the given host.

Signature:

string get_iscsi_iqn (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_last_software_update

Overview:

Get the last_software_update field of the given host.

Signature:

datetime get_last_software_update (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: datetime

value of the field

RPC name: get_last_update_hash

Overview:

Get the last_update_hash field of the given host.

Signature:

string get_last_update_hash (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_latest_synced_updates_applied

Overview:

Get the latest_synced_updates_applied field of the given host.

Signature:

latest_synced_updates_applied_state get_latest_synced_updates_applied (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: latest_synced_updates_applied_state

value of the field

RPC name: get_license_params

Overview:

Get the license_params field of the given host.

Signature:

(string -> string) map get_license_params (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_license_server

Overview:

Get the license_server field of the given host.

Signature:

(string -> string) map get_license_server (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_local_cache_sr

Overview:

Get the local_cache_sr field of the given host.

Signature:

SR ref get_local_cache_sr (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: SR ref

value of the field

RPC name: get_log

Overview:

Get the host’s log file

Signature:

string get_log (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

The contents of the host’s primary log file

RPC name: get_logging

Overview:

Get the logging field of the given host.

Signature:

(string -> string) map get_logging (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_management_interface

Overview:

Returns the management interface for the specified host

Signature:

PIF ref get_management_interface (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: PIF ref

The management interface for the host

RPC name: get_memory_overhead

Overview:

Get the memory/overhead field of the given host.

Signature:

int get_memory_overhead (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: int

value of the field

RPC name: get_metrics

Overview:

Get the metrics field of the given host.

Signature:

host_metrics ref get_metrics (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host_metrics ref

value of the field

RPC name: get_multipathing

Overview:

Get the multipathing field of the given host.

Signature:

bool get_multipathing (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_name_description

Overview:

Get the name/description field of the given host.

Signature:

string get_name_description (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_name_label

Overview:

Get the name/label field of the given host.

Signature:

string get_name_label (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_other_config

Overview:

Get the other_config field of the given host.

Signature:

(string -> string) map get_other_config (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_patches

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)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host_patch ref set

value of the field

RPC name: get_PBDs

Overview:

Get the PBDs field of the given host.

Signature:

PBD ref set get_PBDs (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: PBD ref set

value of the field

RPC name: get_PCIs

Overview:

Get the PCIs field of the given host.

Signature:

PCI ref set get_PCIs (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: PCI ref set

value of the field

RPC name: get_pending_guidances

Overview:

Get the pending_guidances field of the given host.

Signature:

update_guidances set get_pending_guidances (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: update_guidances set

value of the field

RPC name: get_pending_guidances_full

Overview:

Get the pending_guidances_full field of the given host.

Signature:

update_guidances set get_pending_guidances_full (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: update_guidances set

value of the field

RPC name: get_pending_guidances_recommended

Overview:

Get the pending_guidances_recommended field of the given host.

Signature:

update_guidances set get_pending_guidances_recommended (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: update_guidances set

value of the field

RPC name: get_PGPUs

Overview:

Get the PGPUs field of the given host.

Signature:

PGPU ref set get_PGPUs (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: PGPU ref set

value of the field

RPC name: get_PIFs

Overview:

Get the PIFs field of the given host.

Signature:

PIF ref set get_PIFs (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: PIF ref set

value of the field

RPC name: get_power_on_config

Overview:

Get the power_on_config field of the given host.

Signature:

(string -> string) map get_power_on_config (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_power_on_mode

Overview:

Get the power_on_mode field of the given host.

Signature:

string get_power_on_mode (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_PUSBs

Overview:

Get the PUSBs field of the given host.

Signature:

PUSB ref set get_PUSBs (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: PUSB ref set

value of the field

RPC name: get_record

Overview:

Get a record containing the current state of the given host.

Signature:

host record get_record (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: host record

all fields from the object

RPC name: get_resident_VMs

Overview:

Get the resident_VMs field of the given host.

Signature:

VM ref set get_resident_VMs (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: VM ref set

value of the field

RPC name: get_sched_gran

Overview:

Gets xen’s sched-gran on a host

Signature:

host_sched_gran get_sched_gran (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Return Type: host_sched_gran

The host’s sched-gran

RPC name: get_sched_policy

Overview:

Get the sched_policy field of the given host.

Signature:

string get_sched_policy (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_server_certificate

Overview:

Get the installed server public TLS certificate.

Signature:

string get_server_certificate (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

The installed server public TLS certificate, in PEM form.

RPC name: get_server_localtime

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)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: datetime

The current local time

RPC name: get_servertime

Overview:

This call queries the host’s clock for the current time

Signature:

datetime get_servertime (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: datetime

The current time

RPC name: get_software_version

Overview:

Get the software_version field of the given host.

Signature:

(string -> string) map get_software_version (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_ssl_legacy

This message is deprecated.

Overview:

Get the ssl_legacy field of the given host.

Signature:

bool get_ssl_legacy (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_supported_bootloaders

Overview:

Get the supported_bootloaders field of the given host.

Signature:

string set get_supported_bootloaders (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string set

value of the field

RPC name: get_suspend_image_sr

Overview:

Get the suspend_image_sr field of the given host.

Signature:

SR ref get_suspend_image_sr (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: SR ref

value of the field

RPC name: get_system_status_capabilities

Overview:

Signature:

string get_system_status_capabilities (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

An XML fragment containing the system status capabilities.

RPC name: get_tags

Overview:

Get the tags field of the given host.

Signature:

string set get_tags (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string set

value of the field

RPC name: get_tls_verification_enabled

Overview:

Get the tls_verification_enabled field of the given host.

Signature:

bool get_tls_verification_enabled (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_uefi_certificates

This message is deprecated.

Overview:

Get the uefi_certificates field of the given host.

Signature:

string get_uefi_certificates (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_uncooperative_resident_VMs

This message is deprecated.

Overview:

Return a set of VMs which are not co-operating with the host’s memory control system

Signature:

VM ref set get_uncooperative_resident_VMs (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: VM ref set

VMs which are not co-operating

RPC name: get_updates

Overview:

Get the updates field of the given host.

Signature:

pool_update ref set get_updates (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: pool_update ref set

value of the field

RPC name: get_updates_requiring_reboot

Overview:

Get the updates_requiring_reboot field of the given host.

Signature:

pool_update ref set get_updates_requiring_reboot (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: pool_update ref set

value of the field

RPC name: get_uuid

Overview:

Get the uuid field of the given host.

Signature:

string get_uuid (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_virtual_hardware_platform_versions

Overview:

Get the virtual_hardware_platform_versions field of the given host.

Signature:

int set get_virtual_hardware_platform_versions (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: int set

value of the field

RPC name: get_vms_which_prevent_evacuation

Overview:

Return a set of VMs which prevent the host being evacuated, with per-VM error codes

Signature:

(VM ref -> string set) map get_vms_which_prevent_evacuation (session ref session_ref, host ref self)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: (VM ref -> string set) map

VMs which block evacuation together with reasons

RPC name: has_extension

Overview:

Return true if the extension is available on the host

Signature:

bool has_extension (session ref session_ref, host ref host, string name)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: bool

True if the extension exists, false otherwise

RPC name: install_server_certificate

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: void

RPC name: license_add

Overview:

Apply a new license to a host

Signature:

void license_add (session ref session_ref, host ref host, string contents)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

Possible Error Codes: LICENSE_PROCESSING_ERROR

RPC name: license_apply

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

Possible Error Codes: LICENSE_PROCESSING_ERROR

RPC name: license_remove

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: list_methods

Overview:

List all supported methods

Signature:

string set list_methods (session ref session_ref)
<!--NeedCopy-->

Arguments:

Minimum Role: read-only

Return Type: string set

The name of every supported method.

RPC name: local_management_reconfigure

Overview:

Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken.

Signature:

void local_management_reconfigure (session ref session_ref, string interface)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: management_disable

Overview:

Disable the management network interface

Signature:

void management_disable (session ref session_ref)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: management_reconfigure

Overview:

Reconfigure the management network interface

Signature:

void management_reconfigure (session ref session_ref, PIF ref pif)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: migrate_receive

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)
<!--NeedCopy-->

Arguments:

Minimum Role: vm-power-admin

Return Type: (string -> string) map

A value which should be passed to VM.migrate

RPC name: power_on

Overview:

Attempt to power-on the host (if the capability exists).

Signature:

void power_on (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: query_data_source

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)
<!--NeedCopy-->

Arguments:

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: record_data_source

Overview:

Start recording the specified data source

Signature:

void record_data_source (session ref session_ref, host ref host, string data_source)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: refresh_pack_info

This message is deprecated.

Overview:

Refresh the list of installed Supplemental Packs.

Signature:

void refresh_pack_info (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: refresh_server_certificate

Overview:

Replace the internal self-signed host certficate with a new one.

Signature:

void refresh_server_certificate (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: void

RPC name: remove_from_guest_VCPUs_params

Overview:

Remove the given key and its corresponding value from the guest_VCPUs_params 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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: remove_from_license_server

Overview:

Remove the given key and its corresponding value from the license_server 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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: remove_from_logging

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: remove_from_other_config

Overview:

Remove the given key and its corresponding value from the other_config 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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: remove_tags

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)
<!--NeedCopy-->

Arguments:

Minimum Role: vm-operator

Return Type: void

RPC name: reset_cpu_features

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: reset_server_certificate

Overview:

Delete the current TLS server certificate and replace by a new, self-signed one. This should only be used with extreme care.

Signature:

void reset_server_certificate (session ref session_ref, host ref host)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: void

RPC name: restart_agent

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: retrieve_wlb_evacuate_recommendations

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)
<!--NeedCopy-->

Arguments:

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: send_debug_keys

Overview:

Inject the given string as debugging keys into Xen

Signature:

void send_debug_keys (session ref session_ref, host ref host, string keys)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-admin

Return Type: void

RPC name: set_address

Overview:

Set the address field of the given host.

Signature:

void set_address (session ref session_ref, host ref self, string value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_cpu_features

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_crash_dump_sr

Overview:

Set the crash_dump_sr field of the given host.

Signature:

void set_crash_dump_sr (session ref session_ref, host ref self, SR ref value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_display

Overview:

Set the display field of the given host.

Signature:

void set_display (session ref session_ref, host ref self, host_display value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_guest_VCPUs_params

Overview:

Set the guest_VCPUs_params field of the given host.

Signature:

void set_guest_VCPUs_params (session ref session_ref, host ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_hostname

Overview:

Set the hostname field of the given host.

Signature:

void set_hostname (session ref session_ref, host ref self, string value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_hostname_live

Overview:

Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately.

Signature:

void set_hostname_live (session ref session_ref, host ref host, string hostname)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

Possible Error Codes: HOST_NAME_INVALID

RPC name: set_https_only

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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_iscsi_iqn

Overview:

Sets the initiator IQN for the host

Signature:

void set_iscsi_iqn (session ref session_ref, host ref host, string value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_license_server

Overview:

Set the license_server field of the given host.

Signature:

void set_license_server (session ref session_ref, host ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_logging

Overview:

Set the logging field of the given host.

Signature:

void set_logging (session ref session_ref, host ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_multipathing

Overview:

Specifies whether multipathing is enabled

Signature:

void set_multipathing (session ref session_ref, host ref host, bool value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_name_description

Overview:

Set the name/description field of the given host.

Signature:

void set_name_description (session ref session_ref, host ref self, string value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_name_label

Overview:

Set the name/label field of the given host.

Signature:

void set_name_label (session ref session_ref, host ref self, string value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_other_config

Overview:

Set the other_config field of the given host.

Signature:

void set_other_config (session ref session_ref, host ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_power_on_mode

Overview:

Set the power-on-mode, 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)
<!--NeedCopy-->

Arguments:

Minimum Role: pool-operator

Return Type: void

RPC name: set_sched_gran

Overview:

Sets xen’s sched-gran on a host. See: https://xenbits.xen.org/docs/unstable/misc/xen-command-line.html#sched-gran-x86

Signature:

void set_sched_gran (session ref session_ref, host ref self, host_sched_gran value)
<!--NeedCopy-->

Arguments:

Return Type: void

RPC name: set_ssl_legacy

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)
<!--NeedCopy-->

Arguments: