VMs

List VM configurations

Command

List all your VM configurations. Orka provides detailed information about the VM configuration.

orka vm configs

OR

orka vm configs -f <USER>

Output

Options

You can pass the following option with orka vm configs in direct mode:

List VMs and VM configurations

List your VMs and VM configurations. If you are running this command in administrative mode, you can list the VMs and VM configurations of a specified user or for all users.

Command

orka vm list

OR

orka vm list -f <USER>

OR

orka vm list -f all

OR (with replicas expanded)

orka vm list --expand

Output

Options

You can pass the following options with orka vm list in direct mode:

Create VM configuration

Command

Create a VM configuration from which you can deploy virtual machines.

orka vm create-config

OR (create basic config)

orka vm create-config -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> -y

OR (create config with custom VM memory)

orka vm create-config -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> -M <MEMORY_IN_GB> -y

OR (create config with attached ISO)

orka vm create-config -v <NAME> -b <EMPTY_BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> -i <ISO> -y

OR (create config with attached additional storage)

orka vm create-config -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> -d <ADDITIONAL_STORAGE> -y

OR (create config with disabled VNC)

orka vm create-config -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> --vnc no -y

OR (create config with enabled IO boost)
orka vm create-config -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> --io-boost yes -y

OR (create config with a required tag)

orka vm create-config -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> --tag <TAG> --tag-required yes -y

OR (create config with a custom scheduler)

orka vm create-config -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> --scheduler <SCHEDULER> -y

Output

📘

VM name limitations

The name you specify under VM Name must meet the following requirements:

• Doesn't exceed 38 characters.
• Contains only lowercase Latin alphanumeric characters (0-9, a-z) and dashes (-).
• Begins and ends with an alphanumeric character.

Options

You can pass the following options with orka vm create-config in direct mode:

• This option is supported or applicable to Intel-based nodes only. Read more about Apple ARM-based Support to see which commands and options are supported for Apple ARM-based nodes.

Create VM

Command

Create a VM configuration and deploy a VM from it. This command is shorthand for orka vm create-config && orka vm deploy.

orka vm create

OR (create and deploy basic VM)

orka vm create -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> -y

OR (create and deploy basic VM with custom memory)

orka vm create -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> -M <MEMORY_IN_GB> -y

OR (create and deploy VM on a specified node)

orka vm create -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> -n <NODE> -y

OR (create and deploy VM with attached ISO)

orka vm create -v <NAME> -b <EMPTY_BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> -i <ISO> -y

OR (create and deploy VM with attached additional storage)

orka vm create -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> -d <ADDITIONAL_STORAGE> -y

OR  (create and deploy VM with disabled VNC)

orka vm create -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> --vnc no -y

OR  (create and deploy VM with enabled IO boost)

orka vm create -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> --io-boost yes -y

OR  (create and deploy VM with required tag)

orka vm create -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> --tag <TAG> --tag-required yes -y


OR  (create and deploy VM with a custom scheduler)

orka vm create -v <NAME> -b <BASE_IMAGE> -c <CPU_COUNT> -C <vCPU_COUNT> --scheduler <SCHEDULER> -y

Output

Options

You can pass the following options with orka vm create in direct mode:

• This option is supported or applicable to Intel-based nodes only. Read more about Apple ARM-based Support to see which commands and options are supported for Apple ARM-based nodes.

Deploy VM

Command

Deploy a new virtual machine from the specified VM configuration.

orka vm deploy

OR

orka vm deploy -v <NAME> -y

OR  (deploy on a specified node)

orka vm deploy -v <NAME> -n <NODE> -y

OR (deploy a scaled VM)

orka vm deploy -v <NAME> -r <NUMBER_OF_REPLICAS> -y

OR (deploy with additional ports)

orka vm deploy -v <NAME> -p <NODE_PORT>:<VM_PORT> -y

OR (deploy with attached ISO)

orka vm deploy -v <NAME> -i <ISO> -y

OR  (deploy with additional storage)

orka vm deploy -v <NAME> -d <ADDITIONAL_STORAGE> -y

OR (deploy with disabled VNC)

orka vm deploy -v <NAME> --vnc no -y

OR (deploy with required tag)

orka vm deploy -v <NAME> --tag <TAG> --tag-required yes -y

OR (deploy with a custom scheduler)

orka vm deploy -v <NAME> --scheduler <SCHEUDLER> -y

Output

Options

You can pass the following options with orka vm deploy in direct mode:

• This option is supported or applicable to Intel-based nodes only. Read more about Apple ARM-based Support to see which commands and options are supported for Apple ARM-based nodes.

(DEPRECATED) Scale a deployed VM

Command

Change the scale at which a VM is deployed. By default, VMs are deployed non-scaled (one VM at a time with a unique ID). When you increase the scale, Orka deploys replicas of the same VM and they share one ID.

🚧

DEPRECATED COMMAND

Scaling a deployed VM is deprecated with Orka 2.2.0 and will be removed in a future version of Orka.

📘

Limitations

When you are working with scaled VMs, the following limitations are in place:

• Some operations are not available for scaled VMs (orka image save, orka image commit, orka vm clone, orka vm migrate).
• If you specify a node during deployment, scaling is limited to the resources of that node and will not create new replicas on other nodes.
• All replicas share the same ID.
• To view detailed information about each replica, run orka vm status -v <NAME> -y.
• When you scale down, you have no control over which replicas will be destroyed and which ones will be preserved. This might result in loss of data.
• When you scale up, newly deployed replicas use the base image of the original VM config. Changes from any other running replicas are not applied to the new replicas.
• You can delete replicas only by ID. This operation deletes all replicas with the specified ID.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka vm scale

OR

orka vm scale -v <VM_ID> -r <NUMBER_OF_REPLICAS> -y

Output

Options

You can pass the following options with orka vm scale in direct mode:

Check the status of a VM

Command

Get deployment status and system information for the specified VM. If you are running this command in administrative mode, you can get the status for another user's VM.

orka vm status

OR

orka vm status -v <NAME> -y

OR

orka vm status -v <VM_ID> -y

Output

Options

You can pass the following options with orka vm status in direct mode:

Attach non-bootable disk

Command

Attach a non-bootable disk to the specified VM. The disk must be listed by the orka image list command.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka vm attach-disk

OR

orka vm attach-disk -v <VM_ID> -d <ADDITIONAL_STORAGE> -y

OR (if attaching a second or a third image to this VM)

orka vm attach-disk -v <VM_ID> -m <MOUNT_POINT> -d <ADDITIONAL_STORAGE> -y

Output

Options

You can pass the following options with orka vm attach-disk in direct mode:

List VM disks

Command

List the disks attached to the specified VM. You must specify the VM by ID.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka vm list-disks

OR

orka vm list-disks -v <VM_ID> -y

Output

Options

You can pass the following option with orka vm list-disks in direct mode:

(DEPRECATED) Migrate VM

Command

Move a VM to another node. This operation changes the IP of the VM and might change its assigned ports.

🚧

DEPRECATED COMMAND

Migrating a VM is deprecated with Orka 2.2.0 and will be removed in a future version of Orka.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka vm migrate

OR

orka vm migrate -v <VM_ID> -n <CURRENT_NODE> --to-node <TARGET_NODE> -y

Output

Options

You can pass the following options with orka vm migrate in direct mode:

(DEPRECATED) Clone VM

Command

Create a copy of the specified VM. The copy receives a new ID and might receive a new IP and new ports, based on the target node.

🚧

DEPRECATED COMMAND

Cloning a VM is deprecated with Orka 2.2.0 and will be removed in a future version of Orka.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka vm clone

OR

orka vm clone -v <VM_ID> -n <CURRENT_NODE> --to-node <TARGET_NODE> -y

Output

Options

You can pass the following options with orka vm clone in direct mode:

Stop, start, suspend, or resume a VM

Commands

Stop, start, suspend, or resume the specified VM. You can specify a VM by name and node, or by ID.

🚧

Apple ARM-based nodes support

These commands are not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka vm [stop / start / suspend / resume] 

OR

orka vm [stop / start / suspend / resume] -v <NAME> -n <NODE> -y

OR

orka vm [stop / start / suspend / resume] -v <VM_ID> -y

Options

You can pass the following options with orka vm stop, orka vm start, orka vm suspend and orka vm resume in direct mode:

Revert VM

Command

Revert VM to the latest state of its base image. This operation restarts the VM. You can specify a VM by name, name and node, or by ID.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka vm revert

OR

orka vm revert -v <NAME> -n <NODE> -y

OR

orka vm revert -v <VM_ID> -y

Output

Options

You can pass the following options with orka vm revert in direct mode:

Save VM State

Command

Save the state (disk and memory) of the specified deployed VM. The VM should be running. The VM state is associated with the respective VM configuration. Every VM you deploy from the VM configuration after this operation, will use the saved VM state to boot.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka vm save-state

OR

orka vm save-state -v <VM_ID> -y

OR

orka vm save-state -v <VM_ID> --json

Output

Delete VM State

Command

Delete the saved state (disk and memory) of the specified VM configuration. Every VM you deploy from the VM configuration after this operation, will use the base image to boot.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka vm delete-state

OR

orka vm delete-state -v <VM_ID> -y

Output

Delete VM

Command

Remove the specified deployed VM(s) but retain the respective VM configuration. You will be able to continue deploying VMs from the VM configuration.

orka vm delete

OR (delete all VMs with the specified name)

orka vm delete -v <NAME> -y

OR (delete all VMs with the specified name from the specified node)

orka vm delete -v <NAME> -n <NODE> -y

OR (delete all VMs with the specified ID)

orka vm delete -v <VM_ID> -y

📘

Is your VM instance in an ERROR state?

Always delete VMs in an ERROR state by ID.

Output

Options

You can pass the following options with orka vm delete in direct mode:

Purge VM

Command

Delete all deployed VMs with the specified name and the respective VM configuration. You will not be able to continue deploying VMs from the VM configuration.

orka vm purge

OR

orka vm purge -v <NAME> -y

Output

Options

You can pass the following options with orka vm purge in direct mode: