VCPUs and CPU Allocation

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(Blanked the page)
 
Line 1: Line 1:
The [[Server|server]] create VM command
 
==Path==
 
*/server/editvm/$vmid
 
  
==Method==
 
*[[glossary#POST|POST]]
 
 
==Availability==
 
*[[servers#Dynamic Server|Dynamic Server]]
 
 
==Optional Data Parameters==
 
*{$hostname}: The hostname of the [[glossary#Virtual Machine|virtual machine]], it must be unique and not currently in use on any other server or [[glossary#Virtual Machine|virtual machine]] in [[glossary#LEAP|LEAP]].
 
*{$password}: The root password of the [[glossary#Virtual Machine|virtual machine]], the password will be changed on the [[glossary#Virtual Machine|virtual machine]] itself.
 
*{$memory}: The amount of RAM assigned to the [[glossary#Virtual Machine|virtual machine]] in kilobytes, it must be greater than 512 MB (524,288 KB).
 
*{$storage}: The amount of storage space assigned to the [[glossary#Virtual Machine|virtual machine]] in kilobytes, must be greater than 10GB (10,485,760 KB).
 
*{$cpu_allocation}: How vcpus/priority should be applied to a new virtual machine.
 
** dedicated - vcpus will be dedicated to the particular vm and priority is not set or needed.
 
** pool  - no vcpus are set the vm runs accross the entire physical cpu. allows priority to be set.
 
** limited (default) - allows you to set vcpus and also allows you to set cpu priority.  this setting allows multiple vms to overlap on the same physical cores.
 
**{$priority}: The CPU priority for the [[glossary#Virtual Machine|virtual machine]] (1 – 100)%.
 
*** If $cpu_allocation is 'dedicated', priority isn't used. If $cpu_allocation is 'limited', a VM will have access to multiple cores and will have a set priority to those cores. if $cpu_allocation is set to 'pool', the VM has access to the whole physical CPU but are limited to the priority they're assigned.
 
**{$cores}: Number of vCPUs to assign to a virtual machine.
 
*** If $cpu_allocation is 'dedicated', these cores are removed from the cpu pool and actually allocated to the VM so they cannot be used by other VMs. If $cpu_allocation is set to 'limited', the VM has access to that number of cores but may share them with other VMs. Cores do not apply if $cpu_allocation is set to 'pool'
 
 
==Returned Data==
 
<pre>
 
stdClass Object(
 
  [success] => TRUE/FALSE
 
  )
 
)
 
</pre>
 

Latest revision as of 18:14, 20 June 2012

Personal tools