acrn-hypervisor/devicemodel/tools/acrn-manager
Geoffroy Van Cutsem d93066f769 Move ACRN Device Model code in a devicemodel/ folder
This is part of the short series of commits that will lead
to a unified repository for the ACRN hypervisor, device model
and the associated documentation.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-05-10 01:51:51 +02:00
..
acrnctl.c Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
Makefile Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
README.rst Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00

acrnctl
#######

DESCRIPTION
###########
acrnctl: The acrnctl can help user to create, delete, launch and stop UOSs.
It runs under Service OS, and UOSs should be based on acrn-dm 

USAGE
#####
To see what it can do, just run:
        # acrnctl
or
        # acrnctl help
you may see:
        support:
                list
                start
                stop
                del
                add
        Use acrnctl [cmd] help for details

There are examples:
(1) add a VM
    Each time you can just add one VM. Suppose you have an UOS
    launch script, such as launch_UOS.sh
    you can run:
	# acrnctl add launch_UOS.sh -U 1
        vm1-14:59:30 added
    Note that, launch script shoud be able to launch ONE UOS. If
    it fail, it is better to print some error logs, to tell user
    the reason, so that he knows how to solve it.
    The vmname is important, the acrnctl searchs VMs by their
    names. so duplicated VM names are not allowed. Beside, if the
    launch script changes VM name at launch time, acrnctl will
    not recgonize it.
(2) delete VMs
        # acrnctl del vm1-14:59:30
(3) show VMs
        # acrnctl list
        vm1-14:59:30            untracked
        vm-yocto                stop
        vm-android              stop
(4) start VM
    you can start a vm with 'stop' status, each time can start
    one VM.
        # acrnctl start vm-yocto
(5) stop VM
    you can stop VMs, if their status is not 'stop'
        # acrnctl stop vm-yocto vm1-14:59:30 vm-android
BUILD
#####
# make