====== Introduction to CLI ======

OpenNEbula provides two commands to interact with the system:
  * ''onevm'': to submit, control and monitor virtual machines
  * ''onehost'': to add, delete and monitor hosts

====== onevm ======

This command enables the user to manage virtual machines in the Open Nebula server. The user can allocate, deploy, migrate, suspend, resume and shutdown a virtual machine with the functionality present in **onevm**.

<code>
    onevm <command> [<parameters>]
</code>   

===== Command Summary =====

**submit** 

Submits a new virtual machine, adding it to the ONE VM pool. It requires the filename of the VM template.
<code>
    onevm submit <template>
</code>   

**deploy** 

Starts a previously submitted VM on a specific host

<code>
    onevm deploy <vm_id> <host_id>
</code> 

**shutdown** 

Shutdown an already deployed VM
<code>
    onevm shutdown <vm_id>   
</code>

**livemigrate**

Migrates a running VM to another host without downtime
<code>
    onevm livemigrate <vm_id> <host_id>   
</code>

**migrate**

Saves a running VM and starts it again in the specified host
<code>
    onevm migrate <vm_id> <host_id>
</code>

**suspend**

Saves a running VM
<code>
    onevm suspend <vm_id> 
</code>

**resume** 

Resumes the execution of a saved VM
<code>
    onevm resume <vm_id>   
</code>

**list** 

Shows VMs in the pool
<code>
    onevm list   
</code>

**show**

Gets information about a specific VM
<code>
    onevm show <vm_id>
</code>

===== Information Columns =====

^ ID       | ONE VM identifier |
^ NAME     | Name automatically given by ONE |
^ STAT     | Status of the VM |
^ CPU      | CPU percentile used by the VM |
^ MEM      | Memory used by the VM |
^ HOSTNAME | Host where the VM is being or was run |
^ TIME     | Time since the submission of the VM (days hours:minutes:seconds |

===== VM States =====

^ pend | pending |
^ hold | VM on hold (not runnable) |
^ stop | stopped |
^ susp | suspended |
^ done | finished |
^ prol | prolog |
^ boot | booting |
^ runn | running |
^ migr | migrating |
^ save | saving the VM to disk |
^ epil | epilog |
^ shut | shutting down |



====== onehost ======


This command enables the user to manage hosts in the Open Nebula server. It provides functionality to allocate, get information and delete a particular host or to list all the available hosts.

<code>
    onehost <command> [<parameters>]
</code>



===== Command Summary =====

**add** 

Adds a new machine to the pool
<code>
    onehost add <hostname> <im_mad> <vmm_mad>
</code>

//im_mad// and //vmm_mad// as written in oned.conf.

**show** 

Gets info from a single host

<code>
    onehost show <host_id>
</code>    

**delete** 

Removes a machine from the pool

<code>
    onehost delete <host_id>
</code>

**list** 

Lists machines in the pool
<code>
    onehost list
</code>




===== Information Columns =====

^ HID  | Host ID |
^ NAME | Host name |
^ RVM  | Running VMs |
^ TCPU | Total CPU (percentage) |
^ FCPU | Free CPU (percentage) |
^ ACPU | Available CPU (not allocated by VMs) |
^ TMEM | Total memory |
^ FMEM | Free memory |