Server Edit VM

From INAP Dropzone API
Jump to: navigation, search

The server create VM command



  • /server/editvm/$vmid



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