Class: VM

A virtual machine (or 'guest').

Enums

vm_power_state
on_normal_exit
on_crash_behaviour
vm_operations

Fields

(string → string) map HVM_boot_params [RW]
string HVM_boot_policy [RW]
float HVM_shadow_multiplier [RO/constructor]
Deprecated
string PCI_bus [RW]
string PV_args [RW]
string PV_bootloader [RW]
string PV_bootloader_args [RW]
string PV_kernel [RW]
string PV_legacy_args [RW]
string PV_ramdisk [RW]
VBD ref set VBDs [RO/runtime]
int VCPUs_at_startup [RO/constructor]
int VCPUs_max [RO/constructor]
(string → string) map VCPUs_params [RW]
VGPU ref set VGPUs [RO/runtime]
VIF ref set VIFs [RO/runtime]
VTPM ref set VTPMs [RO/runtime]
enum on_crash_behaviour actions_after_crash [RW]
enum on_normal_exit actions_after_reboot [RW]
enum on_normal_exit actions_after_shutdown [RW]
host ref affinity [RW]
enum vm_operations set allowed_operations [RO/runtime]
VM_appliance ref appliance [RO/constructor]
PCI ref set attached_PCIs [RO/runtime]
(string → string) map bios_strings [RO/runtime]
(string → blob ref) map blobs [RO/runtime]
(enum vm_operations → string) map blocked_operations [RW]
VM ref set children [RO/runtime]
console ref set consoles [RO/runtime]
crashdump ref set crash_dumps [RO/runtime]
(string → enum vm_operations) map current_operations [RO/runtime]
string domarch [RO/runtime]
int domid [RO/runtime]
string generation_id [RO/constructor]
VM_guest_metrics ref guest_metrics [RO/runtime]
Deprecated
bool ha_always_run [RO/constructor]
string ha_restart_priority [RO/constructor]
int hardware_platform_version [RW]
bool has_vendor_device [RO/constructor]
bool is_a_snapshot [RO/runtime]
bool is_a_template [RW]
bool is_control_domain [RO/runtime]
bool is_default_template [RO/runtime]
Deprecated
bool is_snapshot_from_vmpp [RO/constructor]
bool is_vmss_snapshot [RO/constructor]
(string → string) map last_boot_CPU_flags [RO/runtime]
string last_booted_record [RO/runtime]
int memory_dynamic_max [RO/constructor]
int memory_dynamic_min [RO/constructor]
int memory_overhead [RO/runtime]
int memory_static_max [RO/constructor]
int memory_static_min [RO/constructor]
Deprecated
int memory_target [RO/constructor]
VM_metrics ref metrics [RO/runtime]
string name_description [RW]
string name_label [RW]
int order [RO/constructor]
(string → string) map other_config [RW]
VM ref parent [RO/runtime]
(string → string) map platform [RW]
enum vm_power_state power_state [RO/runtime]
Deprecated
VMPP ref protection_policy [RO/constructor]
string recommendations [RW]
string reference_label [RO/constructor]
bool requires_reboot [RO/runtime]
host ref resident_on [RO/runtime]
int shutdown_delay [RO/constructor]
(string → string) map snapshot_info [RO/runtime]
string snapshot_metadata [RO/runtime]
VM ref snapshot_of [RO/runtime]
VMSS ref snapshot_schedule [RO/constructor]
datetime snapshot_time [RO/runtime]
VM ref set snapshots [RO/runtime]
int start_delay [RO/constructor]
SR ref suspend_SR [RW]
VDI ref suspend_VDI [RO/runtime]
string set tags [RW]
string transportable_snapshot_id [RO/runtime]
int user_version [RW]
string uuid [RO/runtime]
int version [RO/constructor]
(string → string) map xenstore_data [RW]

Messages

void add_tags (session ref, VM ref, string)
void add_to_HVM_boot_params (session ref, VM ref, string, string)
void add_to_VCPUs_params (session ref, VM ref, string, string)
void add_to_VCPUs_params_live (session ref, VM ref, string, string)
void add_to_blocked_operations (session ref, VM ref, enum vm_operations, string)
void add_to_other_config (session ref, VM ref, string, string)
void add_to_platform (session ref, VM ref, string, string)
void add_to_xenstore_data (session ref, VM ref, string, string)
void assert_agile (session ref, VM ref)
void assert_can_be_recovered (session ref, VM ref, session ref)
void assert_can_boot_here (session ref, VM ref, host ref)
void assert_can_migrate (session ref, VM ref, (string → string) map, bool, (VDI ref → SR ref) map, (VIF ref → network ref) map, (string → string) map)
void assert_operation_valid (session ref, VM ref, enum vm_operations)
string call_plugin (session ref, VM ref, string, string, (string → string) map)
VM ref checkpoint (session ref, VM ref, string)
void clean_reboot (session ref, VM ref)
void clean_shutdown (session ref, VM ref)
VM ref clone (session ref, VM ref, string)
int compute_memory_overhead (session ref, VM ref)
VM ref copy (session ref, VM ref, string, SR ref)
void copy_bios_strings (session ref, VM ref, host ref)
VM ref create (session ref, VM record)
blob ref create_new_blob (session ref, VM ref, string, string, bool)
void destroy (session ref, VM ref)
void forget_data_source_archives (session ref, VM ref, string)
(string → string) map get_HVM_boot_params (session ref, VM ref)
string get_HVM_boot_policy (session ref, VM ref)
float get_HVM_shadow_multiplier (session ref, VM ref)
Deprecated
string get_PCI_bus (session ref, VM ref)
string get_PV_args (session ref, VM ref)
string get_PV_bootloader (session ref, VM ref)
string get_PV_bootloader_args (session ref, VM ref)
string get_PV_kernel (session ref, VM ref)
string get_PV_legacy_args (session ref, VM ref)
string get_PV_ramdisk (session ref, VM ref)
SR ref set get_SRs_required_for_recovery (session ref, VM ref, session ref)
VBD ref set get_VBDs (session ref, VM ref)
int get_VCPUs_at_startup (session ref, VM ref)
int get_VCPUs_max (session ref, VM ref)
(string → string) map get_VCPUs_params (session ref, VM ref)
VGPU ref set get_VGPUs (session ref, VM ref)
VIF ref set get_VIFs (session ref, VM ref)
VTPM ref set get_VTPMs (session ref, VM ref)
enum on_crash_behaviour get_actions_after_crash (session ref, VM ref)
enum on_normal_exit get_actions_after_reboot (session ref, VM ref)
enum on_normal_exit get_actions_after_shutdown (session ref, VM ref)
host ref get_affinity (session ref, VM ref)
VM ref set get_all (session ref)
(VM ref → VM record) map get_all_records (session ref)
string set get_allowed_VBD_devices (session ref, VM ref)
string set get_allowed_VIF_devices (session ref, VM ref)
enum vm_operations set get_allowed_operations (session ref, VM ref)
VM_appliance ref get_appliance (session ref, VM ref)
PCI ref set get_attached_PCIs (session ref, VM ref)
(string → string) map get_bios_strings (session ref, VM ref)
(string → blob ref) map get_blobs (session ref, VM ref)
(enum vm_operations → string) map get_blocked_operations (session ref, VM ref)
VM record get_boot_record (session ref, VM ref)
VM ref set get_by_name_label (session ref, string)
VM ref get_by_uuid (session ref, string)
VM ref set get_children (session ref, VM ref)
console ref set get_consoles (session ref, VM ref)
Deprecated
bool get_cooperative (session ref, VM ref)
crashdump ref set get_crash_dumps (session ref, VM ref)
(string → enum vm_operations) map get_current_operations (session ref, VM ref)
data_source record set get_data_sources (session ref, VM ref)
string get_domarch (session ref, VM ref)
int get_domid (session ref, VM ref)
string get_generation_id (session ref, VM ref)
VM_guest_metrics ref get_guest_metrics (session ref, VM ref)
Deprecated
bool get_ha_always_run (session ref, VM ref)
string get_ha_restart_priority (session ref, VM ref)
int get_hardware_platform_version (session ref, VM ref)
bool get_has_vendor_device (session ref, VM ref)
bool get_is_a_snapshot (session ref, VM ref)
bool get_is_a_template (session ref, VM ref)
bool get_is_control_domain (session ref, VM ref)
bool get_is_default_template (session ref, VM ref)
Deprecated
bool get_is_snapshot_from_vmpp (session ref, VM ref)
bool get_is_vmss_snapshot (session ref, VM ref)
(string → string) map get_last_boot_CPU_flags (session ref, VM ref)
string get_last_booted_record (session ref, VM ref)
int get_memory_dynamic_max (session ref, VM ref)
int get_memory_dynamic_min (session ref, VM ref)
int get_memory_overhead (session ref, VM ref)
int get_memory_static_max (session ref, VM ref)
int get_memory_static_min (session ref, VM ref)
Deprecated
int get_memory_target (session ref, VM ref)
VM_metrics ref get_metrics (session ref, VM ref)
string get_name_description (session ref, VM ref)
string get_name_label (session ref, VM ref)
int get_order (session ref, VM ref)
(string → string) map get_other_config (session ref, VM ref)
VM ref get_parent (session ref, VM ref)
(string → string) map get_platform (session ref, VM ref)
host ref set get_possible_hosts (session ref, VM ref)
enum vm_power_state get_power_state (session ref, VM ref)
Deprecated
VMPP ref get_protection_policy (session ref, VM ref)
string get_recommendations (session ref, VM ref)
VM record get_record (session ref, VM ref)
string get_reference_label (session ref, VM ref)
bool get_requires_reboot (session ref, VM ref)
host ref get_resident_on (session ref, VM ref)
int get_shutdown_delay (session ref, VM ref)
(string → string) map get_snapshot_info (session ref, VM ref)
string get_snapshot_metadata (session ref, VM ref)
VM ref get_snapshot_of (session ref, VM ref)
VMSS ref get_snapshot_schedule (session ref, VM ref)
datetime get_snapshot_time (session ref, VM ref)
VM ref set get_snapshots (session ref, VM ref)
int get_start_delay (session ref, VM ref)
SR ref get_suspend_SR (session ref, VM ref)
VDI ref get_suspend_VDI (session ref, VM ref)
string set get_tags (session ref, VM ref)
string get_transportable_snapshot_id (session ref, VM ref)
int get_user_version (session ref, VM ref)
string get_uuid (session ref, VM ref)
int get_version (session ref, VM ref)
(string → string) map get_xenstore_data (session ref, VM ref)
void hard_reboot (session ref, VM ref)
void hard_shutdown (session ref, VM ref)
VM ref set import (session ref, string, SR ref, bool, bool)
void import_convert (session ref, string, string, string, SR ref, (string → string) map)
int maximise_memory (session ref, VM ref, int, bool)
VM ref migrate_send (session ref, VM ref, (string → string) map, bool, (VDI ref → SR ref) map, (VIF ref → network ref) map, (string → string) map)
void pause (session ref, VM ref)
void pool_migrate (session ref, VM ref, host ref, (string → string) map)
void power_state_reset (session ref, VM ref)
void provision (session ref, VM ref)
float query_data_source (session ref, VM ref, string)
(string → string) map query_services (session ref, VM ref)
void record_data_source (session ref, VM ref, string)
void recover (session ref, VM ref, session ref, bool)
void remove_from_HVM_boot_params (session ref, VM ref, string)
void remove_from_VCPUs_params (session ref, VM ref, string)
void remove_from_blocked_operations (session ref, VM ref, enum vm_operations)
void remove_from_other_config (session ref, VM ref, string)
void remove_from_platform (session ref, VM ref, string)
void remove_from_xenstore_data (session ref, VM ref, string)
void remove_tags (session ref, VM ref, string)
void resume (session ref, VM ref, bool, bool)
void resume_on (session ref, VM ref, host ref, bool, bool)
(host ref → string set) map retrieve_wlb_recommendations (session ref, VM ref)
void revert (session ref, VM ref)
void send_sysrq (session ref, VM ref, string)
void send_trigger (session ref, VM ref, string)
void set_HVM_boot_params (session ref, VM ref, (string → string) map)
void set_HVM_boot_policy (session ref, VM ref, string)
void set_HVM_shadow_multiplier (session ref, VM ref, float)
Deprecated
void set_PCI_bus (session ref, VM ref, string)
void set_PV_args (session ref, VM ref, string)
void set_PV_bootloader (session ref, VM ref, string)
void set_PV_bootloader_args (session ref, VM ref, string)
void set_PV_kernel (session ref, VM ref, string)
void set_PV_legacy_args (session ref, VM ref, string)
void set_PV_ramdisk (session ref, VM ref, string)
void set_VCPUs_at_startup (session ref, VM ref, int)
void set_VCPUs_max (session ref, VM ref, int)
void set_VCPUs_number_live (session ref, VM ref, int)
void set_VCPUs_params (session ref, VM ref, (string → string) map)
void set_actions_after_crash (session ref, VM ref, enum on_crash_behaviour)
void set_actions_after_reboot (session ref, VM ref, enum on_normal_exit)
void set_actions_after_shutdown (session ref, VM ref, enum on_normal_exit)
void set_affinity (session ref, VM ref, host ref)
void set_appliance (session ref, VM ref, VM_appliance ref)
void set_blocked_operations (session ref, VM ref, (enum vm_operations → string) map)
Deprecated
void set_ha_always_run (session ref, VM ref, bool)
void set_ha_restart_priority (session ref, VM ref, string)
void set_hardware_platform_version (session ref, VM ref, int)
void set_has_vendor_device (session ref, VM ref, bool)
void set_is_a_template (session ref, VM ref, bool)
void set_memory (session ref, VM ref, int)
void set_memory_dynamic_max (session ref, VM ref, int)
void set_memory_dynamic_min (session ref, VM ref, int)
void set_memory_dynamic_range (session ref, VM ref, int, int)
void set_memory_limits (session ref, VM ref, int, int, int, int)
void set_memory_static_max (session ref, VM ref, int)
void set_memory_static_min (session ref, VM ref, int)
void set_memory_static_range (session ref, VM ref, int, int)
Deprecated
void set_memory_target_live (session ref, VM ref, int)
void set_name_description (session ref, VM ref, string)
void set_name_label (session ref, VM ref, string)
void set_order (session ref, VM ref, int)
void set_other_config (session ref, VM ref, (string → string) map)
void set_platform (session ref, VM ref, (string → string) map)
void set_protection_policy (session ref, VM ref, VMPP ref)
void set_recommendations (session ref, VM ref, string)
void set_shadow_multiplier_live (session ref, VM ref, float)
void set_shutdown_delay (session ref, VM ref, int)
void set_snapshot_schedule (session ref, VM ref, VMSS ref)
void set_start_delay (session ref, VM ref, int)
void set_suspend_SR (session ref, VM ref, SR ref)
void set_suspend_VDI (session ref, VM ref, VDI ref)
void set_tags (session ref, VM ref, string set)
void set_user_version (session ref, VM ref, int)
void set_xenstore_data (session ref, VM ref, (string → string) map)
void shutdown (session ref, VM ref)
VM ref snapshot (session ref, VM ref, string)
VM ref snapshot_with_quiesce (session ref, VM ref, string)
void start (session ref, VM ref, bool, bool)
void start_on (session ref, VM ref, host ref, bool, bool)
void suspend (session ref, VM ref)
void unpause (session ref, VM ref)
void update_allowed_operations (session ref, VM ref)
Deprecated
void wait_memory_target_live (session ref, VM ref)