VCPUs and CPU Allocation

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
Line 11: Line 11:
 
==Optional Data Parameters==
 
==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]].
 
*{$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).
 
*{$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).
 
*{$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.
 
*{$cpu_allocation}: How vcpus/priority should be applied to a new virtual machine.
** dedicated - cpu cores will be dedicated to the particular vm.
+
** dedicated - vcpus will be dedicated to the particular vm and priority is not set or needed.
** limited - allows you to set cpu cores but allows you to set cpu priority
+
** pool  - no vcpus are set the vm runs accross the entire physical cpu. allows priority to be set.
** pool (default) - no cpu cores, but 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)%.
 
**{$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.
 
*** 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.
Line 27: Line 27:
 
stdClass Object(
 
stdClass Object(
 
   [success] => TRUE/FALSE
 
   [success] => TRUE/FALSE
  [data] => stdClass Object(
 
    [vmid] => The server ID of the new VM.
 
 
   )
 
   )
 
)
 
)
 
</pre>
 
</pre>

Revision as of 17:54, 20 June 2012

The server create VM command

Contents

Path

  • /server/editvm/$vmid

Method

Availability

Optional Data Parameters

  • {$hostname}: The hostname of the virtual machine, it must be unique and not currently in use on any other server or virtual machine in LEAP.
  • {$password}: The root password of the virtual machine, the password will be changed on the virtual machine itself.
  • {$memory}: The amount of RAM assigned to the virtual machine in kilobytes, it must be greater than 512 MB (524,288 KB).
  • {$storage}: The amount of storage space assigned to the 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 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

stdClass Object(
  [success] => TRUE/FALSE
  )
)
Personal tools