View Source XenAPI.VM (XenAPI v0.1.1)
Link to this section Summary
Functions
Add the given value to the tags field of the given VM. If the value is already in that Set, then do nothing.
Add the given value to the tags field of the given VM. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)
Add the given key-value pair to the blocked_operations field of the given VM.
Add the given key-value pair to the blocked_operations field of the given VM. (Raise error on XMLRPC failure)
Add the given key-value pair to the HVM/boot_params field of the given VM.
Add the given key-value pair to the HVM/boot_params field of the given VM. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Add the given key-value pair to the other_config field of the given VM.
Add the given key-value pair to the other_config field of the given VM. (Raise error on XMLRPC failure)
Add the given key-value pair to the platform field of the given VM.
Add the given key-value pair to the platform field of the given VM. (Raise error on XMLRPC failure)
Add the given key-value pair to the VCPUs/params field of the given VM.
Add the given key-value pair to the VCPUs/params field of the given VM. (Raise error on XMLRPC failure)
Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM
Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM (Raise error on XMLRPC failure)
Add the given key-value pair to the xenstore_data field of the given VM.
Add the given key-value pair to the xenstore_data field of the given VM. (Raise error on XMLRPC failure)
Returns an error if the VM is not considered agile e.g. because it is tied to a resource local to a host
Returns an error if the VM is not considered agile e.g. because it is tied to a resource local to a host (Raise error on XMLRPC failure)
Assert whether all SRs required to recover this VM are available.
Assert whether all SRs required to recover this VM are available. (Raise error on XMLRPC failure)
Returns an error if the VM could not boot on this host for some reason
Returns an error if the VM could not boot on this host for some reason (Raise error on XMLRPC failure)
Assert whether a VM can be migrated to the specified destination.
Assert whether a VM can be migrated to the specified destination. (Raise error on XMLRPC failure)
Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason
Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason (Raise error on XMLRPC failure)
Call an API plugin on this vm
Call an API plugin on this vm (Raise error on XMLRPC failure)
Checkpoints the specified VM, making a new VM. Checkpoint automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write) and saves the memory image as well.
Checkpoints the specified VM, making a new VM. Checkpoint automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write) and saves the memory image as well. (Raise error on XMLRPC failure)
Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state.
Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Attempt to cleanly shutdown the specified VM. (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state.
Attempt to cleanly shutdown the specified VM. (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). This function can only be called when the VM is in the Halted State.
Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). This function can only be called when the VM is in the Halted State. (Raise error on XMLRPC failure)
Computes the virtualization memory overhead of a VM.
Computes the virtualization memory overhead of a VM. (Raise error on XMLRPC failure)
Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the underlying storage repository in which the VM's disk images are stored. Instead, copy guarantees that the disk images of the newly created VM will be 'full disks' - i.e. not part of a CoW chain. This function can only be called when the VM is in the Halted State.
Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the underlying storage repository in which the VM's disk images are stored. Instead, copy guarantees that the disk images of the newly created VM will be 'full disks' - i.e. not part of a CoW chain. This function can only be called when the VM is in the Halted State. (Raise error on XMLRPC failure)
Copy the BIOS strings from the given host to this VM
Copy the BIOS strings from the given host to this VM (Raise error on XMLRPC failure)
NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations. The standard way to obtain a new VM is to call VM.clone on a template VM, then call VM.provision on the new clone. Caution: if VM.create is used and then the new VM is attached to a virtual disc that has an operating system already installed, then there is no guarantee that the operating system will boot and run. Any software that calls VM.create on a future version of this API may fail or give unexpected results. For example this could happen if an additional parameter were added to VM.create. VM.create is intended only for use in the automatic creation of the system VM templates. It creates a new VM instance, and returns its handle. The constructor args are: name_label, name_description, user_version, is_a_template, affinity, memory_target, memory_static_max, memory_dynamic_max, memory_dynamic_min, memory_static_min, VCPUs_params, VCPUs_max, VCPUs_at_startup, actions_after_shutdown, actions_after_reboot, actions_after_crash, PV_bootloader, PV_kernel, PV_ramdisk, PV_args, PV_bootloader_args, PV_legacy_args, HVM_boot_policy, HVM_boot_params, HVM_shadow_multiplier, platform, PCI_bus, other_config, recommendations, xenstore_data, ha_always_run, ha_restart_priority, tags, blocked_operations, protection_policy, is_snapshot_from_vmpp, snapshot_schedule, is_vmss_snapshot, appliance, start_delay, shutdown_delay, order, suspend_SR, version, generation_id, hardware_platform_version, has_vendor_device, reference_label, domain_type, NVRAM ( = non-optional).
NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations. The standard way to obtain a new VM is to call VM.clone on a template VM, then call VM.provision on the new clone. Caution: if VM.create is used and then the new VM is attached to a virtual disc that has an operating system already installed, then there is no guarantee that the operating system will boot and run. Any software that calls VM.create on a future version of this API may fail or give unexpected results. For example this could happen if an additional parameter were added to VM.create. VM.create is intended only for use in the automatic creation of the system VM templates. It creates a new VM instance, and returns its handle. The constructor args are: name_label, name_description, user_version, is_a_template, affinity, memory_target, memory_static_max, memory_dynamic_max, memory_dynamic_min, memory_static_min, VCPUs_params, VCPUs_max, VCPUs_at_startup, actions_after_shutdown, actions_after_reboot, actions_after_crash, PV_bootloader, PV_kernel, PV_ramdisk, PV_args, PV_bootloader_args, PV_legacy_args, HVM_boot_policy, HVM_boot_params, HVM_shadow_multiplier, platform, PCI_bus, other_config, recommendations, xenstore_data, ha_always_run, ha_restart_priority, tags, blocked_operations, protection_policy, is_snapshot_from_vmpp, snapshot_schedule, is_vmss_snapshot, appliance, start_delay, shutdown_delay, order, suspend_SR, version, generation_id, hardware_platform_version, has_vendor_device, reference_label, domain_type, NVRAM ( = non-optional). (Raise error on XMLRPC failure)
Create a placeholder for a named binary blob of data that is associated with this VM
Create a placeholder for a named binary blob of data that is associated with this VM (Raise error on XMLRPC failure)
Destroy the specified VM. The VM is completely removed from the system. This function can only be called when the VM is in the Halted State.
Destroy the specified VM. The VM is completely removed from the system. This function can only be called when the VM is in the Halted State. (Raise error on XMLRPC failure)
Forget the recorded statistics related to the specified data source
Forget the recorded statistics related to the specified data source (Raise error on XMLRPC failure)
Get the actions/after_crash field of the given VM.
Get the actions/after_crash field of the given VM. (Raise error on XMLRPC failure)
Get the actions/after_reboot field of the given VM.
Get the actions/after_reboot field of the given VM. (Raise error on XMLRPC failure)
Get the actions/after_shutdown field of the given VM.
Get the actions/after_shutdown field of the given VM. (Raise error on XMLRPC failure)
Get the affinity field of the given VM.
Get the affinity field of the given VM. (Raise error on XMLRPC failure)
Return a list of all the VMs known to the system.
Return a list of all the VMs known to the system. (Raise error on XMLRPC failure)
Return a map of VM references to VM records for all VMs known to the system.
Return a map of VM references to VM records for all VMs known to the system. (Raise error on XMLRPC failure)
Get the allowed_operations field of the given VM.
Get the allowed_operations field of the given VM. (Raise error on XMLRPC failure)
Returns a list of the allowed values that a VBD device field can take
Returns a list of the allowed values that a VBD device field can take (Raise error on XMLRPC failure)
Returns a list of the allowed values that a VIF device field can take
Returns a list of the allowed values that a VIF device field can take (Raise error on XMLRPC failure)
Get the appliance field of the given VM.
Get the appliance field of the given VM. (Raise error on XMLRPC failure)
Get the attached_PCIs field of the given VM.
Get the attached_PCIs field of the given VM. (Raise error on XMLRPC failure)
Get the bios_strings field of the given VM.
Get the bios_strings field of the given VM. (Raise error on XMLRPC failure)
Get the blobs field of the given VM.
Get the blobs field of the given VM. (Raise error on XMLRPC failure)
Get the blocked_operations field of the given VM.
Get the blocked_operations field of the given VM. (Raise error on XMLRPC failure)
Returns a record describing the VM's dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes e.g. CPU hotplug
Returns a record describing the VM's dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes e.g. CPU hotplug (Raise error on XMLRPC failure)
Get all the VM instances with the given label.
Get all the VM instances with the given label. (Raise error on XMLRPC failure)
Get a reference to the VM instance with the specified UUID.
Get a reference to the VM instance with the specified UUID. (Raise error on XMLRPC failure)
Get the children field of the given VM.
Get the children field of the given VM. (Raise error on XMLRPC failure)
Get the consoles field of the given VM.
Get the consoles field of the given VM. (Raise error on XMLRPC failure)
Return true if the VM is currently 'co-operative' i.e. is expected to reach a balloon target and actually has done
Return true if the VM is currently 'co-operative' i.e. is expected to reach a balloon target and actually has done (Raise error on XMLRPC failure)
Get the crash_dumps field of the given VM.
Get the crash_dumps field of the given VM. (Raise error on XMLRPC failure)
Get the current_operations field of the given VM.
Get the current_operations field of the given VM. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Get the domain_type field of the given VM.
Get the domain_type field of the given VM. (Raise error on XMLRPC failure)
Get the domarch field of the given VM.
Get the domarch field of the given VM. (Raise error on XMLRPC failure)
Get the domid field of the given VM.
Get the domid field of the given VM. (Raise error on XMLRPC failure)
Get the generation_id field of the given VM.
Get the generation_id field of the given VM. (Raise error on XMLRPC failure)
Get the guest_metrics field of the given VM.
Get the guest_metrics field of the given VM. (Raise error on XMLRPC failure)
Get the HVM/boot_params field of the given VM.
Get the HVM/boot_params field of the given VM. (Raise error on XMLRPC failure)
Get the HVM/boot_policy field of the given VM.
Get the HVM/boot_policy field of the given VM. (Raise error on XMLRPC failure)
Get the HVM/shadow_multiplier field of the given VM.
Get the HVM/shadow_multiplier field of the given VM. (Raise error on XMLRPC failure)
Get the ha_always_run field of the given VM.
Get the ha_always_run field of the given VM. (Raise error on XMLRPC failure)
Get the ha_restart_priority field of the given VM.
Get the ha_restart_priority field of the given VM. (Raise error on XMLRPC failure)
Get the hardware_platform_version field of the given VM.
Get the hardware_platform_version field of the given VM. (Raise error on XMLRPC failure)
Get the has_vendor_device field of the given VM.
Get the has_vendor_device field of the given VM. (Raise error on XMLRPC failure)
Get the is_a_snapshot field of the given VM.
Get the is_a_snapshot field of the given VM. (Raise error on XMLRPC failure)
Get the is_a_template field of the given VM.
Get the is_a_template field of the given VM. (Raise error on XMLRPC failure)
Get the is_control_domain field of the given VM.
Get the is_control_domain field of the given VM. (Raise error on XMLRPC failure)
Get the is_default_template field of the given VM.
Get the is_default_template field of the given VM. (Raise error on XMLRPC failure)
Get the is_snapshot_from_vmpp field of the given VM.
Get the is_snapshot_from_vmpp field of the given VM. (Raise error on XMLRPC failure)
Get the is_vmss_snapshot field of the given VM.
Get the is_vmss_snapshot field of the given VM. (Raise error on XMLRPC failure)
Get the last_boot_CPU_flags field of the given VM.
Get the last_boot_CPU_flags field of the given VM. (Raise error on XMLRPC failure)
Get the last_booted_record field of the given VM.
Get the last_booted_record field of the given VM. (Raise error on XMLRPC failure)
Get the memory/dynamic_max field of the given VM.
Get the memory/dynamic_max field of the given VM. (Raise error on XMLRPC failure)
Get the memory/dynamic_min field of the given VM.
Get the memory/dynamic_min field of the given VM. (Raise error on XMLRPC failure)
Get the memory/overhead field of the given VM.
Get the memory/overhead field of the given VM. (Raise error on XMLRPC failure)
Get the memory/static_max field of the given VM.
Get the memory/static_max field of the given VM. (Raise error on XMLRPC failure)
Get the memory/static_min field of the given VM.
Get the memory/static_min field of the given VM. (Raise error on XMLRPC failure)
Get the memory/target field of the given VM.
Get the memory/target field of the given VM. (Raise error on XMLRPC failure)
Get the metrics field of the given VM.
Get the metrics field of the given VM. (Raise error on XMLRPC failure)
Get the NVRAM field of the given VM.
Get the NVRAM field of the given VM. (Raise error on XMLRPC failure)
Get the name/description field of the given VM.
Get the name/description field of the given VM. (Raise error on XMLRPC failure)
Get the name/label field of the given VM.
Get the name/label field of the given VM. (Raise error on XMLRPC failure)
Get the order field of the given VM.
Get the order field of the given VM. (Raise error on XMLRPC failure)
Get the other_config field of the given VM.
Get the other_config field of the given VM. (Raise error on XMLRPC failure)
Get the PCI_bus field of the given VM.
Get the PCI_bus field of the given VM. (Raise error on XMLRPC failure)
Get the PV/args field of the given VM.
Get the PV/args field of the given VM. (Raise error on XMLRPC failure)
Get the PV/bootloader field of the given VM.
Get the PV/bootloader field of the given VM. (Raise error on XMLRPC failure)
Get the PV/bootloader_args field of the given VM.
Get the PV/bootloader_args field of the given VM. (Raise error on XMLRPC failure)
Get the PV/kernel field of the given VM.
Get the PV/kernel field of the given VM. (Raise error on XMLRPC failure)
Get the PV/legacy_args field of the given VM.
Get the PV/legacy_args field of the given VM. (Raise error on XMLRPC failure)
Get the PV/ramdisk field of the given VM.
Get the PV/ramdisk field of the given VM. (Raise error on XMLRPC failure)
Get the parent field of the given VM.
Get the parent field of the given VM. (Raise error on XMLRPC failure)
Get the platform field of the given VM.
Get the platform field of the given VM. (Raise error on XMLRPC failure)
Return the list of hosts on which this VM may run.
Return the list of hosts on which this VM may run. (Raise error on XMLRPC failure)
Get the power_state field of the given VM.
Get the power_state field of the given VM. (Raise error on XMLRPC failure)
Get the protection_policy field of the given VM.
Get the protection_policy field of the given VM. (Raise error on XMLRPC failure)
Get the recommendations field of the given VM.
Get the recommendations field of the given VM. (Raise error on XMLRPC failure)
Get a record containing the current state of the given VM.
Get a record containing the current state of the given VM. (Raise error on XMLRPC failure)
Get the reference_label field of the given VM.
Get the reference_label field of the given VM. (Raise error on XMLRPC failure)
Get the requires_reboot field of the given VM.
Get the requires_reboot field of the given VM. (Raise error on XMLRPC failure)
Get the resident_on field of the given VM.
Get the resident_on field of the given VM. (Raise error on XMLRPC failure)
List all the SR's that are required for the VM to be recovered
List all the SR's that are required for the VM to be recovered (Raise error on XMLRPC failure)
Get the shutdown_delay field of the given VM.
Get the shutdown_delay field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_info field of the given VM.
Get the snapshot_info field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_metadata field of the given VM.
Get the snapshot_metadata field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_of field of the given VM.
Get the snapshot_of field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_schedule field of the given VM.
Get the snapshot_schedule field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_time field of the given VM.
Get the snapshot_time field of the given VM. (Raise error on XMLRPC failure)
Get the snapshots field of the given VM.
Get the snapshots field of the given VM. (Raise error on XMLRPC failure)
Get the start_delay field of the given VM.
Get the start_delay field of the given VM. (Raise error on XMLRPC failure)
Get the suspend_SR field of the given VM.
Get the suspend_SR field of the given VM. (Raise error on XMLRPC failure)
Get the suspend_VDI field of the given VM.
Get the suspend_VDI field of the given VM. (Raise error on XMLRPC failure)
Get the tags field of the given VM.
Get the tags field of the given VM. (Raise error on XMLRPC failure)
Get the transportable_snapshot_id field of the given VM.
Get the transportable_snapshot_id field of the given VM. (Raise error on XMLRPC failure)
Get the user_version field of the given VM.
Get the user_version field of the given VM. (Raise error on XMLRPC failure)
Get the uuid field of the given VM.
Get the uuid field of the given VM. (Raise error on XMLRPC failure)
Get the VBDs field of the given VM.
Get the VBDs field of the given VM. (Raise error on XMLRPC failure)
Get the VCPUs/at_startup field of the given VM.
Get the VCPUs/at_startup field of the given VM. (Raise error on XMLRPC failure)
Get the VCPUs/max field of the given VM.
Get the VCPUs/max field of the given VM. (Raise error on XMLRPC failure)
Get the VCPUs/params field of the given VM.
Get the VCPUs/params field of the given VM. (Raise error on XMLRPC failure)
Get the VGPUs field of the given VM.
Get the VGPUs field of the given VM. (Raise error on XMLRPC failure)
Get the VIFs field of the given VM.
Get the VIFs field of the given VM. (Raise error on XMLRPC failure)
Get the VTPMs field of the given VM.
Get the VTPMs field of the given VM. (Raise error on XMLRPC failure)
Get the VUSBs field of the given VM.
Get the VUSBs field of the given VM. (Raise error on XMLRPC failure)
Get the version field of the given VM.
Get the version field of the given VM. (Raise error on XMLRPC failure)
Get the xenstore_data field of the given VM.
Get the xenstore_data field of the given VM. (Raise error on XMLRPC failure)
Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM.
Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM. (Raise error on XMLRPC failure)
Stop executing the specified VM without attempting a clean shutdown.
Stop executing the specified VM without attempting a clean shutdown. (Raise error on XMLRPC failure)
Import an XVA from a URI
Import an XVA from a URI (Raise error on XMLRPC failure)
Import using a conversion service.
Import using a conversion service. (Raise error on XMLRPC failure)
Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory. If 'exact' is true then an exact calculation is performed using the VM's current settings. If 'exact' is false then a more conservative approximation is used
Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory. If 'exact' is true then an exact calculation is performed using the VM's current settings. If 'exact' is false then a more conservative approximation is used (Raise error on XMLRPC failure)
Migrate the VM to another host. This can only be called when the specified VM is in the Running state.
Migrate the VM to another host. This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Pause the specified VM. This can only be called when the specified VM is in the Running state.
Pause the specified VM. This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Migrate a VM to another Host.
Migrate a VM to another Host. (Raise error on XMLRPC failure)
Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This is a potentially dangerous operation; use with care.
Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This is a potentially dangerous operation; use with care. (Raise error on XMLRPC failure)
Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script.
Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script. (Raise error on XMLRPC failure)
Query the latest value of the specified data source
Query the latest value of the specified data source (Raise error on XMLRPC failure)
Query the system services advertised by this VM and register them. This can only be applied to a system domain.
Query the system services advertised by this VM and register them. This can only be applied to a system domain. (Raise error on XMLRPC failure)
Start recording the specified data source
Start recording the specified data source (Raise error on XMLRPC failure)
Recover the VM
Recover the VM (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the blocked_operations field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the blocked_operations field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the HVM/boot_params field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the HVM/boot_params field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the other_config field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the other_config field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the platform field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the platform field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the VCPUs/params field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the VCPUs/params field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the xenstore_data field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the xenstore_data field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given value from the tags field of the given VM. If the value is not in that Set, then do nothing.
Remove the given value from the tags field of the given VM. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)
Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state.
Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state. (Raise error on XMLRPC failure)
Awaken the specified VM and resume it on a particular Host. This can only be called when the specified VM is in the Suspended state.
Awaken the specified VM and resume it on a particular Host. This can only be called when the specified VM is in the Suspended state. (Raise error on XMLRPC failure)
Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb. Rating is replaced with an error if the VM cannot boot there.
Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb. Rating is replaced with an error if the VM cannot boot there. (Raise error on XMLRPC failure)
Reverts the specified VM to a previous state.
Reverts the specified VM to a previous state. (Raise error on XMLRPC failure)
Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state.
Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Send the named trigger to this VM. This can only be called when the specified VM is in the Running state.
Send the named trigger to this VM. This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Sets the actions_after_crash parameter
Sets the actions_after_crash parameter (Raise error on XMLRPC failure)
Set the actions/after_reboot field of the given VM.
Set the actions/after_reboot field of the given VM. (Raise error on XMLRPC failure)
Set the actions/after_shutdown field of the given VM.
Set the actions/after_shutdown field of the given VM. (Raise error on XMLRPC failure)
Set the affinity field of the given VM.
Set the affinity field of the given VM. (Raise error on XMLRPC failure)
Assign this VM to an appliance.
Assign this VM to an appliance. (Raise error on XMLRPC failure)
Set custom BIOS strings to this VM. VM will be given a default set of BIOS strings, only some of which can be overridden by the supplied values. Allowed keys are: 'bios-vendor', 'bios-version', 'system-manufacturer', 'system-product-name', 'system-version', 'system-serial-number', 'enclosure-asset-tag', 'baseboard-manufacturer', 'baseboard-product-name', 'baseboard-version', 'baseboard-serial-number', 'baseboard-asset-tag', 'baseboard-location-in-chassis', 'enclosure-asset-tag'
Set custom BIOS strings to this VM. VM will be given a default set of BIOS strings, only some of which can be overridden by the supplied values. Allowed keys are: 'bios-vendor', 'bios-version', 'system-manufacturer', 'system-product-name', 'system-version', 'system-serial-number', 'enclosure-asset-tag', 'baseboard-manufacturer', 'baseboard-product-name', 'baseboard-version', 'baseboard-serial-number', 'baseboard-asset-tag', 'baseboard-location-in-chassis', 'enclosure-asset-tag' (Raise error on XMLRPC failure)
Set the blocked_operations field of the given VM.
Set the blocked_operations field of the given VM. (Raise error on XMLRPC failure)
Set the VM.domain_type field of the given VM, which will take effect when it is next started
Set the VM.domain_type field of the given VM, which will take effect when it is next started (Raise error on XMLRPC failure)
Set the HVM/boot_params field of the given VM.
Set the HVM/boot_params field of the given VM. (Raise error on XMLRPC failure)
Set the VM.HVM_boot_policy field of the given VM, which will take effect when it is next started
Set the VM.HVM_boot_policy field of the given VM, which will take effect when it is next started (Raise error on XMLRPC failure)
Set the shadow memory multiplier on a halted VM
Set the shadow memory multiplier on a halted VM (Raise error on XMLRPC failure)
Set the value of the ha_always_run
Set the value of the ha_always_run (Raise error on XMLRPC failure)
Set the value of the ha_restart_priority field
Set the value of the ha_restart_priority field (Raise error on XMLRPC failure)
Set the hardware_platform_version field of the given VM.
Set the hardware_platform_version field of the given VM. (Raise error on XMLRPC failure)
Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update. Usually this should never be changed on a VM on which Windows has been installed: changing it on such a VM is likely to lead to a crash on next start.
Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update. Usually this should never be changed on a VM on which Windows has been installed: changing it on such a VM is likely to lead to a crash on next start. (Raise error on XMLRPC failure)
Set the is_a_template field of the given VM.
Set the is_a_template field of the given VM. (Raise error on XMLRPC failure)
Set the memory allocation of this VM. Sets all of memory_static_max, memory_dynamic_min, and memory_dynamic_max to the given value, and leaves memory_static_min untouched.
Set the memory allocation of this VM. Sets all of memory_static_max, memory_dynamic_min, and memory_dynamic_max to the given value, and leaves memory_static_min untouched. (Raise error on XMLRPC failure)
Set the value of the memory_dynamic_max field
Set the value of the memory_dynamic_max field (Raise error on XMLRPC failure)
Set the value of the memory_dynamic_min field
Set the value of the memory_dynamic_min field (Raise error on XMLRPC failure)
Set the minimum and maximum amounts of physical memory the VM is allowed to use.
Set the minimum and maximum amounts of physical memory the VM is allowed to use. (Raise error on XMLRPC failure)
Set the memory limits of this VM.
Set the memory limits of this VM. (Raise error on XMLRPC failure)
Set the value of the memory_static_max field
Set the value of the memory_static_max field (Raise error on XMLRPC failure)
Set the value of the memory_static_min field
Set the value of the memory_static_min field (Raise error on XMLRPC failure)
Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.
Set the static (ie boot-time) range of virtual memory that the VM is allowed to use. (Raise error on XMLRPC failure)
Set the memory target for a running VM
Set the memory target for a running VM (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Set the name/description field of the given VM.
Set the name/description field of the given VM. (Raise error on XMLRPC failure)
Set the name/label field of the given VM.
Set the name/label field of the given VM. (Raise error on XMLRPC failure)
Set this VM's boot order
Set this VM's boot order (Raise error on XMLRPC failure)
Set the other_config field of the given VM.
Set the other_config field of the given VM. (Raise error on XMLRPC failure)
Set the PCI_bus field of the given VM.
Set the PCI_bus field of the given VM. (Raise error on XMLRPC failure)
Set the PV/args field of the given VM.
Set the PV/args field of the given VM. (Raise error on XMLRPC failure)
Set the PV/bootloader field of the given VM.
Set the PV/bootloader field of the given VM. (Raise error on XMLRPC failure)
Set the PV/bootloader_args field of the given VM.
Set the PV/bootloader_args field of the given VM. (Raise error on XMLRPC failure)
Set the PV/kernel field of the given VM.
Set the PV/kernel field of the given VM. (Raise error on XMLRPC failure)
Set the PV/legacy_args field of the given VM.
Set the PV/legacy_args field of the given VM. (Raise error on XMLRPC failure)
Set the PV/ramdisk field of the given VM.
Set the PV/ramdisk field of the given VM. (Raise error on XMLRPC failure)
Set the platform field of the given VM.
Set the platform field of the given VM. (Raise error on XMLRPC failure)
Set the value of the protection_policy field
Set the value of the protection_policy field (Raise error on XMLRPC failure)
Set the recommendations field of the given VM.
Set the recommendations field of the given VM. (Raise error on XMLRPC failure)
Set the shadow memory multiplier on a running VM
Set the shadow memory multiplier on a running VM (Raise error on XMLRPC failure)
Set this VM's shutdown delay in seconds
Set this VM's shutdown delay in seconds (Raise error on XMLRPC failure)
Set the value of the snapshot schedule field
Set the value of the snapshot schedule field (Raise error on XMLRPC failure)
Set this VM's start delay in seconds
Set this VM's start delay in seconds (Raise error on XMLRPC failure)
Set the suspend_SR field of the given VM.
Set the suspend_SR field of the given VM. (Raise error on XMLRPC failure)
Set this VM's suspend VDI, which must be indentical to its current one
Set this VM's suspend VDI, which must be indentical to its current one (Raise error on XMLRPC failure)
Set the tags field of the given VM.
Set the tags field of the given VM. (Raise error on XMLRPC failure)
Set the user_version field of the given VM.
Set the user_version field of the given VM. (Raise error on XMLRPC failure)
Set the number of startup VCPUs for a halted VM
Set the number of startup VCPUs for a halted VM (Raise error on XMLRPC failure)
Set the maximum number of VCPUs for a halted VM
Set the maximum number of VCPUs for a halted VM (Raise error on XMLRPC failure)
Set the number of VCPUs for a running VM
Set the number of VCPUs for a running VM (Raise error on XMLRPC failure)
Set the VCPUs/params field of the given VM.
Set the VCPUs/params field of the given VM. (Raise error on XMLRPC failure)
Set the xenstore_data field of the given VM.
Set the xenstore_data field of the given VM. (Raise error on XMLRPC failure)
Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it.
Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it. (Raise error on XMLRPC failure)
Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write).
Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). (Raise error on XMLRPC failure)
Snapshots the specified VM with quiesce, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write).
Snapshots the specified VM with quiesce, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). (Raise error on XMLRPC failure)
Start the specified VM. This function can only be called with the VM is in the Halted State.
Start the specified VM. This function can only be called with the VM is in the Halted State. (Raise error on XMLRPC failure)
Start the specified VM on a particular host. This function can only be called with the VM is in the Halted State.
Start the specified VM on a particular host. This function can only be called with the VM is in the Halted State. (Raise error on XMLRPC failure)
Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state.
Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Resume the specified VM. This can only be called when the specified VM is in the Paused state.
Resume the specified VM. This can only be called when the specified VM is in the Paused state. (Raise error on XMLRPC failure)
Recomputes the list of acceptable operations
Recomputes the list of acceptable operations (Raise error on XMLRPC failure)
Wait for a running VM to reach its current memory target
Wait for a running VM to reach its current memory target (Raise error on XMLRPC failure)
Link to this section Functions
Add the given value to the tags field of the given VM. If the value is already in that Set, then do nothing.
Add the given value to the tags field of the given VM. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)
Add the given key-value pair to the blocked_operations field of the given VM.
Add the given key-value pair to the blocked_operations field of the given VM. (Raise error on XMLRPC failure)
Add the given key-value pair to the HVM/boot_params field of the given VM.
Add the given key-value pair to the HVM/boot_params field of the given VM. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Add the given key-value pair to the other_config field of the given VM.
Add the given key-value pair to the other_config field of the given VM. (Raise error on XMLRPC failure)
Add the given key-value pair to the platform field of the given VM.
Add the given key-value pair to the platform field of the given VM. (Raise error on XMLRPC failure)
Add the given key-value pair to the VCPUs/params field of the given VM.
Add the given key-value pair to the VCPUs/params field of the given VM. (Raise error on XMLRPC failure)
Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM
Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM (Raise error on XMLRPC failure)
Add the given key-value pair to the xenstore_data field of the given VM.
Add the given key-value pair to the xenstore_data field of the given VM. (Raise error on XMLRPC failure)
Returns an error if the VM is not considered agile e.g. because it is tied to a resource local to a host
Returns an error if the VM is not considered agile e.g. because it is tied to a resource local to a host (Raise error on XMLRPC failure)
Assert whether all SRs required to recover this VM are available.
Assert whether all SRs required to recover this VM are available. (Raise error on XMLRPC failure)
Returns an error if the VM could not boot on this host for some reason
Returns an error if the VM could not boot on this host for some reason (Raise error on XMLRPC failure)
assert_can_migrate(xen_session, vm, dest, live, vdi_map, vif_map, options, vgpu_map)
View SourceAssert whether a VM can be migrated to the specified destination.
assert_can_migrate!(xen_session, vm, dest, live, vdi_map, vif_map, options, vgpu_map)
View SourceAssert whether a VM can be migrated to the specified destination. (Raise error on XMLRPC failure)
Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason
Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason (Raise error on XMLRPC failure)
Call an API plugin on this vm
Call an API plugin on this vm (Raise error on XMLRPC failure)
Checkpoints the specified VM, making a new VM. Checkpoint automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write) and saves the memory image as well.
Checkpoints the specified VM, making a new VM. Checkpoint automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write) and saves the memory image as well. (Raise error on XMLRPC failure)
Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state.
Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Attempt to cleanly shutdown the specified VM. (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state.
Attempt to cleanly shutdown the specified VM. (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). This function can only be called when the VM is in the Halted State.
Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). This function can only be called when the VM is in the Halted State. (Raise error on XMLRPC failure)
Computes the virtualization memory overhead of a VM.
Computes the virtualization memory overhead of a VM. (Raise error on XMLRPC failure)
Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the underlying storage repository in which the VM's disk images are stored. Instead, copy guarantees that the disk images of the newly created VM will be 'full disks' - i.e. not part of a CoW chain. This function can only be called when the VM is in the Halted State.
Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the underlying storage repository in which the VM's disk images are stored. Instead, copy guarantees that the disk images of the newly created VM will be 'full disks' - i.e. not part of a CoW chain. This function can only be called when the VM is in the Halted State. (Raise error on XMLRPC failure)
Copy the BIOS strings from the given host to this VM
Copy the BIOS strings from the given host to this VM (Raise error on XMLRPC failure)
NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations. The standard way to obtain a new VM is to call VM.clone on a template VM, then call VM.provision on the new clone. Caution: if VM.create is used and then the new VM is attached to a virtual disc that has an operating system already installed, then there is no guarantee that the operating system will boot and run. Any software that calls VM.create on a future version of this API may fail or give unexpected results. For example this could happen if an additional parameter were added to VM.create. VM.create is intended only for use in the automatic creation of the system VM templates. It creates a new VM instance, and returns its handle. The constructor args are: name_label, name_description, user_version, is_a_template, affinity, memory_target, memory_static_max, memory_dynamic_max, memory_dynamic_min, memory_static_min, VCPUs_params, VCPUs_max, VCPUs_at_startup, actions_after_shutdown, actions_after_reboot, actions_after_crash, PV_bootloader, PV_kernel, PV_ramdisk, PV_args, PV_bootloader_args, PV_legacy_args, HVM_boot_policy, HVM_boot_params, HVM_shadow_multiplier, platform, PCI_bus, other_config, recommendations, xenstore_data, ha_always_run, ha_restart_priority, tags, blocked_operations, protection_policy, is_snapshot_from_vmpp, snapshot_schedule, is_vmss_snapshot, appliance, start_delay, shutdown_delay, order, suspend_SR, version, generation_id, hardware_platform_version, has_vendor_device, reference_label, domain_type, NVRAM ( = non-optional).
NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations. The standard way to obtain a new VM is to call VM.clone on a template VM, then call VM.provision on the new clone. Caution: if VM.create is used and then the new VM is attached to a virtual disc that has an operating system already installed, then there is no guarantee that the operating system will boot and run. Any software that calls VM.create on a future version of this API may fail or give unexpected results. For example this could happen if an additional parameter were added to VM.create. VM.create is intended only for use in the automatic creation of the system VM templates. It creates a new VM instance, and returns its handle. The constructor args are: name_label, name_description, user_version, is_a_template, affinity, memory_target, memory_static_max, memory_dynamic_max, memory_dynamic_min, memory_static_min, VCPUs_params, VCPUs_max, VCPUs_at_startup, actions_after_shutdown, actions_after_reboot, actions_after_crash, PV_bootloader, PV_kernel, PV_ramdisk, PV_args, PV_bootloader_args, PV_legacy_args, HVM_boot_policy, HVM_boot_params, HVM_shadow_multiplier, platform, PCI_bus, other_config, recommendations, xenstore_data, ha_always_run, ha_restart_priority, tags, blocked_operations, protection_policy, is_snapshot_from_vmpp, snapshot_schedule, is_vmss_snapshot, appliance, start_delay, shutdown_delay, order, suspend_SR, version, generation_id, hardware_platform_version, has_vendor_device, reference_label, domain_type, NVRAM ( = non-optional). (Raise error on XMLRPC failure)
Create a placeholder for a named binary blob of data that is associated with this VM
Create a placeholder for a named binary blob of data that is associated with this VM (Raise error on XMLRPC failure)
Destroy the specified VM. The VM is completely removed from the system. This function can only be called when the VM is in the Halted State.
Destroy the specified VM. The VM is completely removed from the system. This function can only be called when the VM is in the Halted State. (Raise error on XMLRPC failure)
Forget the recorded statistics related to the specified data source
Forget the recorded statistics related to the specified data source (Raise error on XMLRPC failure)
Get the actions/after_crash field of the given VM.
Get the actions/after_crash field of the given VM. (Raise error on XMLRPC failure)
Get the actions/after_reboot field of the given VM.
Get the actions/after_reboot field of the given VM. (Raise error on XMLRPC failure)
Get the actions/after_shutdown field of the given VM.
Get the actions/after_shutdown field of the given VM. (Raise error on XMLRPC failure)
Get the affinity field of the given VM.
Get the affinity field of the given VM. (Raise error on XMLRPC failure)
Return a list of all the VMs known to the system.
Return a list of all the VMs known to the system. (Raise error on XMLRPC failure)
Return a map of VM references to VM records for all VMs known to the system.
Return a map of VM references to VM records for all VMs known to the system. (Raise error on XMLRPC failure)
Get the allowed_operations field of the given VM.
Get the allowed_operations field of the given VM. (Raise error on XMLRPC failure)
Returns a list of the allowed values that a VBD device field can take
Returns a list of the allowed values that a VBD device field can take (Raise error on XMLRPC failure)
Returns a list of the allowed values that a VIF device field can take
Returns a list of the allowed values that a VIF device field can take (Raise error on XMLRPC failure)
Get the appliance field of the given VM.
Get the appliance field of the given VM. (Raise error on XMLRPC failure)
Get the attached_PCIs field of the given VM.
Get the attached_PCIs field of the given VM. (Raise error on XMLRPC failure)
Get the bios_strings field of the given VM.
Get the bios_strings field of the given VM. (Raise error on XMLRPC failure)
Get the blobs field of the given VM.
Get the blobs field of the given VM. (Raise error on XMLRPC failure)
Get the blocked_operations field of the given VM.
Get the blocked_operations field of the given VM. (Raise error on XMLRPC failure)
Returns a record describing the VM's dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes e.g. CPU hotplug
Returns a record describing the VM's dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes e.g. CPU hotplug (Raise error on XMLRPC failure)
Get all the VM instances with the given label.
Get all the VM instances with the given label. (Raise error on XMLRPC failure)
Get a reference to the VM instance with the specified UUID.
Get a reference to the VM instance with the specified UUID. (Raise error on XMLRPC failure)
Get the children field of the given VM.
Get the children field of the given VM. (Raise error on XMLRPC failure)
Get the consoles field of the given VM.
Get the consoles field of the given VM. (Raise error on XMLRPC failure)
Return true if the VM is currently 'co-operative' i.e. is expected to reach a balloon target and actually has done
Return true if the VM is currently 'co-operative' i.e. is expected to reach a balloon target and actually has done (Raise error on XMLRPC failure)
Get the crash_dumps field of the given VM.
Get the crash_dumps field of the given VM. (Raise error on XMLRPC failure)
Get the current_operations field of the given VM.
Get the current_operations field of the given VM. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Get the domain_type field of the given VM.
Get the domain_type field of the given VM. (Raise error on XMLRPC failure)
Get the domarch field of the given VM.
Get the domarch field of the given VM. (Raise error on XMLRPC failure)
Get the domid field of the given VM.
Get the domid field of the given VM. (Raise error on XMLRPC failure)
Get the generation_id field of the given VM.
Get the generation_id field of the given VM. (Raise error on XMLRPC failure)
Get the guest_metrics field of the given VM.
Get the guest_metrics field of the given VM. (Raise error on XMLRPC failure)
Get the HVM/boot_params field of the given VM.
Get the HVM/boot_params field of the given VM. (Raise error on XMLRPC failure)
Get the HVM/boot_policy field of the given VM.
Get the HVM/boot_policy field of the given VM. (Raise error on XMLRPC failure)
Get the HVM/shadow_multiplier field of the given VM.
Get the HVM/shadow_multiplier field of the given VM. (Raise error on XMLRPC failure)
Get the ha_always_run field of the given VM.
Get the ha_always_run field of the given VM. (Raise error on XMLRPC failure)
Get the ha_restart_priority field of the given VM.
Get the ha_restart_priority field of the given VM. (Raise error on XMLRPC failure)
Get the hardware_platform_version field of the given VM.
Get the hardware_platform_version field of the given VM. (Raise error on XMLRPC failure)
Get the has_vendor_device field of the given VM.
Get the has_vendor_device field of the given VM. (Raise error on XMLRPC failure)
Get the is_a_snapshot field of the given VM.
Get the is_a_snapshot field of the given VM. (Raise error on XMLRPC failure)
Get the is_a_template field of the given VM.
Get the is_a_template field of the given VM. (Raise error on XMLRPC failure)
Get the is_control_domain field of the given VM.
Get the is_control_domain field of the given VM. (Raise error on XMLRPC failure)
Get the is_default_template field of the given VM.
Get the is_default_template field of the given VM. (Raise error on XMLRPC failure)
Get the is_snapshot_from_vmpp field of the given VM.
Get the is_snapshot_from_vmpp field of the given VM. (Raise error on XMLRPC failure)
Get the is_vmss_snapshot field of the given VM.
Get the is_vmss_snapshot field of the given VM. (Raise error on XMLRPC failure)
Get the last_boot_CPU_flags field of the given VM.
Get the last_boot_CPU_flags field of the given VM. (Raise error on XMLRPC failure)
Get the last_booted_record field of the given VM.
Get the last_booted_record field of the given VM. (Raise error on XMLRPC failure)
Get the memory/dynamic_max field of the given VM.
Get the memory/dynamic_max field of the given VM. (Raise error on XMLRPC failure)
Get the memory/dynamic_min field of the given VM.
Get the memory/dynamic_min field of the given VM. (Raise error on XMLRPC failure)
Get the memory/overhead field of the given VM.
Get the memory/overhead field of the given VM. (Raise error on XMLRPC failure)
Get the memory/static_max field of the given VM.
Get the memory/static_max field of the given VM. (Raise error on XMLRPC failure)
Get the memory/static_min field of the given VM.
Get the memory/static_min field of the given VM. (Raise error on XMLRPC failure)
Get the memory/target field of the given VM.
Get the memory/target field of the given VM. (Raise error on XMLRPC failure)
Get the metrics field of the given VM.
Get the metrics field of the given VM. (Raise error on XMLRPC failure)
Get the NVRAM field of the given VM.
Get the NVRAM field of the given VM. (Raise error on XMLRPC failure)
Get the name/description field of the given VM.
Get the name/description field of the given VM. (Raise error on XMLRPC failure)
Get the name/label field of the given VM.
Get the name/label field of the given VM. (Raise error on XMLRPC failure)
Get the order field of the given VM.
Get the order field of the given VM. (Raise error on XMLRPC failure)
Get the other_config field of the given VM.
Get the other_config field of the given VM. (Raise error on XMLRPC failure)
Get the PCI_bus field of the given VM.
Get the PCI_bus field of the given VM. (Raise error on XMLRPC failure)
Get the PV/args field of the given VM.
Get the PV/args field of the given VM. (Raise error on XMLRPC failure)
Get the PV/bootloader field of the given VM.
Get the PV/bootloader field of the given VM. (Raise error on XMLRPC failure)
Get the PV/bootloader_args field of the given VM.
Get the PV/bootloader_args field of the given VM. (Raise error on XMLRPC failure)
Get the PV/kernel field of the given VM.
Get the PV/kernel field of the given VM. (Raise error on XMLRPC failure)
Get the PV/legacy_args field of the given VM.
Get the PV/legacy_args field of the given VM. (Raise error on XMLRPC failure)
Get the PV/ramdisk field of the given VM.
Get the PV/ramdisk field of the given VM. (Raise error on XMLRPC failure)
Get the parent field of the given VM.
Get the parent field of the given VM. (Raise error on XMLRPC failure)
Get the platform field of the given VM.
Get the platform field of the given VM. (Raise error on XMLRPC failure)
Return the list of hosts on which this VM may run.
Return the list of hosts on which this VM may run. (Raise error on XMLRPC failure)
Get the power_state field of the given VM.
Get the power_state field of the given VM. (Raise error on XMLRPC failure)
Get the protection_policy field of the given VM.
Get the protection_policy field of the given VM. (Raise error on XMLRPC failure)
Get the recommendations field of the given VM.
Get the recommendations field of the given VM. (Raise error on XMLRPC failure)
Get a record containing the current state of the given VM.
Get a record containing the current state of the given VM. (Raise error on XMLRPC failure)
Get the reference_label field of the given VM.
Get the reference_label field of the given VM. (Raise error on XMLRPC failure)
Get the requires_reboot field of the given VM.
Get the requires_reboot field of the given VM. (Raise error on XMLRPC failure)
Get the resident_on field of the given VM.
Get the resident_on field of the given VM. (Raise error on XMLRPC failure)
List all the SR's that are required for the VM to be recovered
List all the SR's that are required for the VM to be recovered (Raise error on XMLRPC failure)
Get the shutdown_delay field of the given VM.
Get the shutdown_delay field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_info field of the given VM.
Get the snapshot_info field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_metadata field of the given VM.
Get the snapshot_metadata field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_of field of the given VM.
Get the snapshot_of field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_schedule field of the given VM.
Get the snapshot_schedule field of the given VM. (Raise error on XMLRPC failure)
Get the snapshot_time field of the given VM.
Get the snapshot_time field of the given VM. (Raise error on XMLRPC failure)
Get the snapshots field of the given VM.
Get the snapshots field of the given VM. (Raise error on XMLRPC failure)
Get the start_delay field of the given VM.
Get the start_delay field of the given VM. (Raise error on XMLRPC failure)
Get the suspend_SR field of the given VM.
Get the suspend_SR field of the given VM. (Raise error on XMLRPC failure)
Get the suspend_VDI field of the given VM.
Get the suspend_VDI field of the given VM. (Raise error on XMLRPC failure)
Get the tags field of the given VM.
Get the tags field of the given VM. (Raise error on XMLRPC failure)
Get the transportable_snapshot_id field of the given VM.
Get the transportable_snapshot_id field of the given VM. (Raise error on XMLRPC failure)
Get the user_version field of the given VM.
Get the user_version field of the given VM. (Raise error on XMLRPC failure)
Get the uuid field of the given VM.
Get the uuid field of the given VM. (Raise error on XMLRPC failure)
Get the VBDs field of the given VM.
Get the VBDs field of the given VM. (Raise error on XMLRPC failure)
Get the VCPUs/at_startup field of the given VM.
Get the VCPUs/at_startup field of the given VM. (Raise error on XMLRPC failure)
Get the VCPUs/max field of the given VM.
Get the VCPUs/max field of the given VM. (Raise error on XMLRPC failure)
Get the VCPUs/params field of the given VM.
Get the VCPUs/params field of the given VM. (Raise error on XMLRPC failure)
Get the VGPUs field of the given VM.
Get the VGPUs field of the given VM. (Raise error on XMLRPC failure)
Get the VIFs field of the given VM.
Get the VIFs field of the given VM. (Raise error on XMLRPC failure)
Get the VTPMs field of the given VM.
Get the VTPMs field of the given VM. (Raise error on XMLRPC failure)
Get the VUSBs field of the given VM.
Get the VUSBs field of the given VM. (Raise error on XMLRPC failure)
Get the version field of the given VM.
Get the version field of the given VM. (Raise error on XMLRPC failure)
Get the xenstore_data field of the given VM.
Get the xenstore_data field of the given VM. (Raise error on XMLRPC failure)
Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM.
Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM. (Raise error on XMLRPC failure)
Stop executing the specified VM without attempting a clean shutdown.
Stop executing the specified VM without attempting a clean shutdown. (Raise error on XMLRPC failure)
Import an XVA from a URI
Import an XVA from a URI (Raise error on XMLRPC failure)
import_convert(xen_session, type, username, password, sr, remote_config)
View SourceImport using a conversion service.
import_convert!(xen_session, type, username, password, sr, remote_config)
View SourceImport using a conversion service. (Raise error on XMLRPC failure)
Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory. If 'exact' is true then an exact calculation is performed using the VM's current settings. If 'exact' is false then a more conservative approximation is used
Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory. If 'exact' is true then an exact calculation is performed using the VM's current settings. If 'exact' is false then a more conservative approximation is used (Raise error on XMLRPC failure)
migrate_send(xen_session, vm, dest, live, vdi_map, vif_map, options, vgpu_map)
View SourceMigrate the VM to another host. This can only be called when the specified VM is in the Running state.
migrate_send!(xen_session, vm, dest, live, vdi_map, vif_map, options, vgpu_map)
View SourceMigrate the VM to another host. This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Pause the specified VM. This can only be called when the specified VM is in the Running state.
Pause the specified VM. This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Migrate a VM to another Host.
Migrate a VM to another Host. (Raise error on XMLRPC failure)
Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This is a potentially dangerous operation; use with care.
Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This is a potentially dangerous operation; use with care. (Raise error on XMLRPC failure)
Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script.
Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script. (Raise error on XMLRPC failure)
Query the latest value of the specified data source
Query the latest value of the specified data source (Raise error on XMLRPC failure)
Query the system services advertised by this VM and register them. This can only be applied to a system domain.
Query the system services advertised by this VM and register them. This can only be applied to a system domain. (Raise error on XMLRPC failure)
Start recording the specified data source
Start recording the specified data source (Raise error on XMLRPC failure)
Recover the VM
Recover the VM (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the blocked_operations field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the blocked_operations field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the HVM/boot_params field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the HVM/boot_params field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the other_config field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the other_config field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the platform field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the platform field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the VCPUs/params field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the VCPUs/params field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the xenstore_data field of the given VM. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the xenstore_data field of the given VM. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given value from the tags field of the given VM. If the value is not in that Set, then do nothing.
Remove the given value from the tags field of the given VM. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)
Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state.
Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state. (Raise error on XMLRPC failure)
Awaken the specified VM and resume it on a particular Host. This can only be called when the specified VM is in the Suspended state.
Awaken the specified VM and resume it on a particular Host. This can only be called when the specified VM is in the Suspended state. (Raise error on XMLRPC failure)
Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb. Rating is replaced with an error if the VM cannot boot there.
Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb. Rating is replaced with an error if the VM cannot boot there. (Raise error on XMLRPC failure)
Reverts the specified VM to a previous state.
Reverts the specified VM to a previous state. (Raise error on XMLRPC failure)
Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state.
Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Send the named trigger to this VM. This can only be called when the specified VM is in the Running state.
Send the named trigger to this VM. This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Sets the actions_after_crash parameter
Sets the actions_after_crash parameter (Raise error on XMLRPC failure)
Set the actions/after_reboot field of the given VM.
Set the actions/after_reboot field of the given VM. (Raise error on XMLRPC failure)
Set the actions/after_shutdown field of the given VM.
Set the actions/after_shutdown field of the given VM. (Raise error on XMLRPC failure)
Set the affinity field of the given VM.
Set the affinity field of the given VM. (Raise error on XMLRPC failure)
Assign this VM to an appliance.
Assign this VM to an appliance. (Raise error on XMLRPC failure)
Set custom BIOS strings to this VM. VM will be given a default set of BIOS strings, only some of which can be overridden by the supplied values. Allowed keys are: 'bios-vendor', 'bios-version', 'system-manufacturer', 'system-product-name', 'system-version', 'system-serial-number', 'enclosure-asset-tag', 'baseboard-manufacturer', 'baseboard-product-name', 'baseboard-version', 'baseboard-serial-number', 'baseboard-asset-tag', 'baseboard-location-in-chassis', 'enclosure-asset-tag'
Set custom BIOS strings to this VM. VM will be given a default set of BIOS strings, only some of which can be overridden by the supplied values. Allowed keys are: 'bios-vendor', 'bios-version', 'system-manufacturer', 'system-product-name', 'system-version', 'system-serial-number', 'enclosure-asset-tag', 'baseboard-manufacturer', 'baseboard-product-name', 'baseboard-version', 'baseboard-serial-number', 'baseboard-asset-tag', 'baseboard-location-in-chassis', 'enclosure-asset-tag' (Raise error on XMLRPC failure)
Set the blocked_operations field of the given VM.
Set the blocked_operations field of the given VM. (Raise error on XMLRPC failure)
Set the VM.domain_type field of the given VM, which will take effect when it is next started
Set the VM.domain_type field of the given VM, which will take effect when it is next started (Raise error on XMLRPC failure)
Set the HVM/boot_params field of the given VM.
Set the HVM/boot_params field of the given VM. (Raise error on XMLRPC failure)
Set the VM.HVM_boot_policy field of the given VM, which will take effect when it is next started
Set the VM.HVM_boot_policy field of the given VM, which will take effect when it is next started (Raise error on XMLRPC failure)
Set the shadow memory multiplier on a halted VM
Set the shadow memory multiplier on a halted VM (Raise error on XMLRPC failure)
Set the value of the ha_always_run
Set the value of the ha_always_run (Raise error on XMLRPC failure)
Set the value of the ha_restart_priority field
Set the value of the ha_restart_priority field (Raise error on XMLRPC failure)
Set the hardware_platform_version field of the given VM.
Set the hardware_platform_version field of the given VM. (Raise error on XMLRPC failure)
Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update. Usually this should never be changed on a VM on which Windows has been installed: changing it on such a VM is likely to lead to a crash on next start.
Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update. Usually this should never be changed on a VM on which Windows has been installed: changing it on such a VM is likely to lead to a crash on next start. (Raise error on XMLRPC failure)
Set the is_a_template field of the given VM.
Set the is_a_template field of the given VM. (Raise error on XMLRPC failure)
Set the memory allocation of this VM. Sets all of memory_static_max, memory_dynamic_min, and memory_dynamic_max to the given value, and leaves memory_static_min untouched.
Set the memory allocation of this VM. Sets all of memory_static_max, memory_dynamic_min, and memory_dynamic_max to the given value, and leaves memory_static_min untouched. (Raise error on XMLRPC failure)
Set the value of the memory_dynamic_max field
Set the value of the memory_dynamic_max field (Raise error on XMLRPC failure)
Set the value of the memory_dynamic_min field
Set the value of the memory_dynamic_min field (Raise error on XMLRPC failure)
Set the minimum and maximum amounts of physical memory the VM is allowed to use.
Set the minimum and maximum amounts of physical memory the VM is allowed to use. (Raise error on XMLRPC failure)
set_memory_limits(xen_session, vm_ref, static_min, static_max, dynamic_min, dynamic_max)
View SourceSet the memory limits of this VM.
set_memory_limits!(xen_session, vm_ref, static_min, static_max, dynamic_min, dynamic_max)
View SourceSet the memory limits of this VM. (Raise error on XMLRPC failure)
Set the value of the memory_static_max field
Set the value of the memory_static_max field (Raise error on XMLRPC failure)
Set the value of the memory_static_min field
Set the value of the memory_static_min field (Raise error on XMLRPC failure)
Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.
Set the static (ie boot-time) range of virtual memory that the VM is allowed to use. (Raise error on XMLRPC failure)
Set the memory target for a running VM
Set the memory target for a running VM (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Set the name/description field of the given VM.
Set the name/description field of the given VM. (Raise error on XMLRPC failure)
Set the name/label field of the given VM.
Set the name/label field of the given VM. (Raise error on XMLRPC failure)
Set this VM's boot order
Set this VM's boot order (Raise error on XMLRPC failure)
Set the other_config field of the given VM.
Set the other_config field of the given VM. (Raise error on XMLRPC failure)
Set the PCI_bus field of the given VM.
Set the PCI_bus field of the given VM. (Raise error on XMLRPC failure)
Set the PV/args field of the given VM.
Set the PV/args field of the given VM. (Raise error on XMLRPC failure)
Set the PV/bootloader field of the given VM.
Set the PV/bootloader field of the given VM. (Raise error on XMLRPC failure)
Set the PV/bootloader_args field of the given VM.
Set the PV/bootloader_args field of the given VM. (Raise error on XMLRPC failure)
Set the PV/kernel field of the given VM.
Set the PV/kernel field of the given VM. (Raise error on XMLRPC failure)
Set the PV/legacy_args field of the given VM.
Set the PV/legacy_args field of the given VM. (Raise error on XMLRPC failure)
Set the PV/ramdisk field of the given VM.
Set the PV/ramdisk field of the given VM. (Raise error on XMLRPC failure)
Set the platform field of the given VM.
Set the platform field of the given VM. (Raise error on XMLRPC failure)
Set the value of the protection_policy field
Set the value of the protection_policy field (Raise error on XMLRPC failure)
Set the recommendations field of the given VM.
Set the recommendations field of the given VM. (Raise error on XMLRPC failure)
Set the shadow memory multiplier on a running VM
Set the shadow memory multiplier on a running VM (Raise error on XMLRPC failure)
Set this VM's shutdown delay in seconds
Set this VM's shutdown delay in seconds (Raise error on XMLRPC failure)
Set the value of the snapshot schedule field
Set the value of the snapshot schedule field (Raise error on XMLRPC failure)
Set this VM's start delay in seconds
Set this VM's start delay in seconds (Raise error on XMLRPC failure)
Set the suspend_SR field of the given VM.
Set the suspend_SR field of the given VM. (Raise error on XMLRPC failure)
Set this VM's suspend VDI, which must be indentical to its current one
Set this VM's suspend VDI, which must be indentical to its current one (Raise error on XMLRPC failure)
Set the tags field of the given VM.
Set the tags field of the given VM. (Raise error on XMLRPC failure)
Set the user_version field of the given VM.
Set the user_version field of the given VM. (Raise error on XMLRPC failure)
Set the number of startup VCPUs for a halted VM
Set the number of startup VCPUs for a halted VM (Raise error on XMLRPC failure)
Set the maximum number of VCPUs for a halted VM
Set the maximum number of VCPUs for a halted VM (Raise error on XMLRPC failure)
Set the number of VCPUs for a running VM
Set the number of VCPUs for a running VM (Raise error on XMLRPC failure)
Set the VCPUs/params field of the given VM.
Set the VCPUs/params field of the given VM. (Raise error on XMLRPC failure)
Set the xenstore_data field of the given VM.
Set the xenstore_data field of the given VM. (Raise error on XMLRPC failure)
Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it.
Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it. (Raise error on XMLRPC failure)
Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write).
Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). (Raise error on XMLRPC failure)
Snapshots the specified VM with quiesce, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write).
Snapshots the specified VM with quiesce, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). (Raise error on XMLRPC failure)
Start the specified VM. This function can only be called with the VM is in the Halted State.
Start the specified VM. This function can only be called with the VM is in the Halted State. (Raise error on XMLRPC failure)
Start the specified VM on a particular host. This function can only be called with the VM is in the Halted State.
Start the specified VM on a particular host. This function can only be called with the VM is in the Halted State. (Raise error on XMLRPC failure)
Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state.
Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state. (Raise error on XMLRPC failure)
Resume the specified VM. This can only be called when the specified VM is in the Paused state.
Resume the specified VM. This can only be called when the specified VM is in the Paused state. (Raise error on XMLRPC failure)
Recomputes the list of acceptable operations
Recomputes the list of acceptable operations (Raise error on XMLRPC failure)
Wait for a running VM to reach its current memory target
Wait for a running VM to reach its current memory target (Raise error on XMLRPC failure)