create vm image

create vm vm_name image image_file {memory memory_size} {cpus num_cpus} {slot slot_ID}{vnc [none | vnc_display]}

Description

Creates a guest virtual machine (VM) from a disk image file.

Syntax Description

vmDesignates creating a virtual machine.
vm_nameSpecifies the VM name.
imageDesignates using a disk image file to create the VM.
image_fileSpecifies the disk image file to use in qcow2 or any QEMU-supported (including VMDK) format.
memoryDesignates specifying the amount of RAM allocated to the VM.
memory_sizeSpecifies the amount of RAM (in MB) allocated to the VM. The default is 4,096.
cpusDesignates specifying the number of CPUs to allocate to the VM.
num_cpusSpecifies the number of CPUs to allocate to the VM. Range is 1–2. The default is 1.
slotSpecifies assigning the VM to run on a slot.
slot_IDSpecifies the slot number that the VM will run on.
vncSpecifies providing a display number for VNC access.
noneDisables VNC access (default).
vnc_displaySpecifies the VNC screen number. Range is 0–15.

Default

The default memory size to run the VM on is 4,096 MB.

The default number of CPUs to allocate to the VM is one.

By default, VNC access is disabled.

Usage Guidelines

The disk image must be a qcow2 or any QEMU-compatible file.

If the VM storage device has not been initialized when this command is run, you are prompted to run the clear vm storage command to initiate partitioning, file system creation, and initialization of the file/directory structure on the device.

The Integrated Application Hosting (IAH) feature requires the Solid State Storage Device SSD-120.

For the VNC display number (or screen number), you can use the values from 0 to 15. These correspond to TCP ports 5,900 to 5,915. Multiple VMs can be configured with the same VNC display, but VMs configured with the same display number cannot run at the same time. A VM cannot be started if the VNC port is already in use. For security reasons, the VNC display is only accessible using SSH tunnel. VNC cannot be configured on non-primary stack nodes.

Example

The following example creates a VM called "vm1" with disk image file "my_file" with 2,000 MB as the amount of RAM allocated to the VM:

# create vm vm1 image my_file memory 2000

History

This command was first available in ExtremeXOS 30.3.

VMDK format support was added in ExtremeXOS 30.4.

VNC capability and support for any QEMU-compatible disk was added in ExtremeXOS 30.5.

Stacking support was added in ExtremeXOS 30.6.

Platform Availability

This command is available on all platforms that support the Integrated Application Hosting (IAH) feature and have a Core or Extreme Platform ONE license installed. For a list of platforms that support the IAH feature and for information about licenses, see the licensing guide.