acrn-hypervisor/tools/acrn-manager
yuhong.tao@intel.com 7706e5cef4 tools: acrnd: store/load timer list
When system is going to shutdown, or someone kills Acrnd, and
Acrnd still hold some UOS works in its timer list. Thus Acrnd need
to store UOS timer works to file, so that Acrnd can load and
continue these uncompleted works as it is restarted.

Reviewed-by: Yan Like <like.yan@intel.com>
Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2018-07-16 16:04:34 +08:00
..
Makefile tools: acrnd: the deamon for acrn-manager 2018-07-16 16:04:34 +08:00
README.rst tools: acrnctl: Add support for reseting vm 2018-06-07 14:36:18 +08:00
acrn_mngr.c tools: rework on vm ops 2018-07-16 16:04:34 +08:00
acrn_mngr.h tools: rework on vm ops 2018-07-16 16:04:34 +08:00
acrn_vm_ops.c tools: rework on vm ops 2018-07-16 16:04:34 +08:00
acrnctl.c tools: rework on vm ops 2018-07-16 16:04:34 +08:00
acrnctl.h tools: rework on vm ops 2018-07-16 16:04:34 +08:00
acrnd.c tools: acrnd: store/load timer list 2018-07-16 16:04:34 +08:00
acrnd.service tools: acrnd: the deamon for acrn-manager 2018-07-16 16:04:34 +08:00

README.rst

.. _acrnctl:

acrnctl
#######


Description
***********

The ``acrnctl`` tool helps users create, delete, launch, and stop a User
OS (UOS).  The tool runs under the Service OS, and UOSs should be based
on ``acrn-dm``.



Usage
*****

You can see the available ``acrnctl`` commands by running:

.. code-block:: none

   # acrnctl help
   support:
     list
     start
     stop
     del
     add
     pause
     continue
     suspend
     resume
     reset
   Use acrnctl [cmd] help for details

Here are some usage examples:

Add a VM
========

The ``add`` command lets you add a VM by specifying a
script that will launch a UOS, for example ``launch_UOS.sh``:

.. code-block:: none

   # acrnctl add launch_UOS.sh -U 1
   vm1-14:59:30 added

Note that the launch script must only launch one UOS instance.
The VM name is important. ``acrnctl`` searches VMs by their
names so duplicate VM names are not allowed. If the
launch script changes the VM name at launch time, ``acrnctl``
will not recognize it.

Delete VMs
==========

Use the ``delete`` command with a VM name to delete that VM:

.. code-block:: none

   # acrnctl del vm1-14:59:30

List VMs
========

Use the ``list`` command to display VMs and their state:

.. code-block:: none

   # acrnctl list
   vm1-14:59:30            untracked
   vm-yocto                stopped
   vm-android              stopped

Start VM
========

If a VM is in a ``stopped`` state, you can start it with the ``start``
command:

.. code-block:: none

   # acrnctl start vm-yocto

Stop VM
=======

Use the ``stop`` command to stop one or more running VM:

.. code-block:: none

   # acrnctl stop vm-yocto vm1-14:59:30 vm-android

Build and Install
*****************

Source code for ``acrnctl`` is in the ``tools/acrn-manager`` folder.
Change to that folder and run:

.. code-block:: none

   # make
   # make install