Server Create VM

From INAP Dropzone API
Jump to: navigation, search

The server create VM command



  • /server/createvm



Required Data Parameters

  • {$hostname}: The hostname of new virtual machine, it must be unique and not currently in use on any other server or virtual machine in LEAP.
  • {$osid}: The operating system that will be installed on the virtual machine, all operating systems available will be returned by using the list snapshots command.
  • {$ips}: The number of IP addresses to be assigned to the virtual machine in cidr format (30 = 1 Usable, 29 = 5 Usable, 28 = 13 Usable, 27 = 29 Usable)
  • {$storagetype}: The type of storage that the virtual machine will use (canopy = cloud storage, local = servers local hard drive).
  • {$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.
    • {$priority}: The CPU priority for the virtual machine (1 – 100)%, (pool, limited, dedicated).
      • 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'

Optional Data Parameters

  • None

Returned Data

stdClass Object(
  [success] => TRUE/FALSE
  [data] => stdClass Object(
    [vmid] => The server ID of the new VM.
Personal tools