Classes / VM / create.html

Create a new VM instance, and return its handle.

Return value
type description
VM reference to the newly created object
Parameters
name type description
session_id session valid session reference
name_label string a human-readable name
name_description string a notes field containg human-readable description
user_version int a user version number for this machine
is_a_template bool true if this is a template. Template VMs can never be started, they are used only for cloning other VMs
affinity host a host which the VM has some affinity for (or NULL). This is used as a hint to the start call when it decides where to run the VM. Implementations are free to ignore this field.
memory_target int Dynamically-set memory target (bytes). The value of this field indicates the current target for memory available to this VM.
memory_static_max int Statically-set (i.e. absolute) maximum (bytes). The value of this field at VM start time acts as a hard limit of the amount of memory a guest can use. New values only take effect on reboot.
memory_dynamic_max int Dynamic maximum (bytes)
memory_dynamic_min int Dynamic minimum (bytes)
memory_static_min int Statically-set (i.e. absolute) mininum (bytes). The value of this field indicates the least amount of memory this VM can boot with without crashing.
VCPUs_params Map[string,string] configuration parameters for the selected VCPU policy
VCPUs_max int Max number of VCPUs
VCPUs_at_startup int Boot number of VCPUs
actions_after_shutdown enum on_normal_exit action to take after the guest has shutdown itself
actions_after_reboot enum on_normal_exit action to take after the guest has rebooted itself
actions_after_crash enum on_crash_behaviour action to take if the guest crashes
PV_bootloader string name of or path to bootloader
PV_kernel string path to the kernel
PV_ramdisk string path to the initrd
PV_args string kernel command-line arguments
PV_bootloader_args string miscellaneous arguments for the bootloader
PV_legacy_args string to make Zurich guests boot
HVM_boot_policy string HVM boot policy
HVM_boot_params Map[string,string] HVM boot params
HVM_shadow_multiplier float multiplier applied to the amount of shadow that will be made available to the guest
platform Map[string,string] platform-specific configuration
PCI_bus string PCI bus path for pass-through devices
other_config Map[string,string] additional configuration
recommendations string An XML specification of recommended values and ranges for properties of this VM
xenstore_data Map[string,string] data to be inserted into the xenstore tree (/local/domain/<domid>/vm-data) after the VM is created.
ha_always_run bool if true then the system will attempt to keep the VM running as much as possible.
ha_restart_priority string Only defined if ha_always_run is set possible values: "best-effort" meaning "try to restart this VM if possible but don't consider the Pool to be overcommitted if this is not possible"; and a numerical restart priority (e.g. 1, 2, 3,...)
tags Set[string] user-specified tags for categorization purposes
blocked_operations Map[enum vm_operations,string] List of operations which have been explicitly blocked and an error code
protection_policy VMPP Ref pointing to a protection policy for this VM
is_snapshot_from_vmpp bool true if this snapshot was created by the protection policy
Errors
name arguments description