qemu-init

A virtual machine manager to make life with qemu more comfortable

User Tools

Site Tools


qemu-init user tools


qemu-adm

This is the same content like the man page qemu-adm(1). See naming conventions for abbreviations.


qemu-adm(1)

April 4, 2021

NAME

 qemu-adm  is the qemu-init administration tool

SYNOPSIS

         qemu-adm [ -a|-r|-u ] <name> 
         qemu-adm [ -S|-D|-R|-m|-s|–config|–vnc ] <name> 
         qemu-adm -c <command> <name> 
         qemu-adm [ -l ] | [ -h ] | [ -V ] 


DESCRIPTION

 qemu-adm  is the main tool of qemu-init. It provides the complete functionality of qemu-init through a unique interface to the library functions.

TERMS

Except explicit otherwise stated the term name is the short unique identifier which belongs to one dedicated virtual machine. It have to be unique between all registered virtual machines handled by  qemu-adm . The name is be used as prefix for several files as well for the qemu option  -name  and have to consist of alphanumeric characters only. Especially a  -  (minus) and a  .  (dot) are not allowed.

OPTIONS

There are two types of parameters: actions and options. Only one action is allowed at execution time.

If multiple actions are given the first one wins - all other will be ignored and a warning will be printed. Maybe the behavior of  qemu-adm  will be undefined in such a case.

Options extends actions with additional functionality.

Actions:
 -a | –autostart <name>      Enable or disable autostart of the virtual machine name. If the actual value is ON then it will be set to OFF and vice versa. All virtual machines with autostart enabled are listed in  ETCDIR/autostart .

 -c | –cmd <command> <name>      Execute command in the qemu monitor of name and exit. command have to be quoted properly. This action requires 2 arguments; an invalid number of arguments will result in an error.

 –config <name> (tab2) Show configuration of name from its config files  name-qemud.rc  and  name-user.cfg .

 -D | –stop <name>     Stop virtual machine name.

 -h | –help     Show the help screen and exit.

 -l | –list     List all registered virtual machines from  ETCDIR/registered .

 -m | –monitor <name>     Connect to the qemu monitor of name for interactive usage.

 -r | –register <name>      A virtual machine given by name will be created and registered. name MUST contain an absolute path here:  /full/path/to/name . The path will be separated from name and defines the location for all files which belongs to this dedicated virtual machine. If the path doesn't exist it will be created. Inside this directory the files  name-qemu.rc  and  name-user.cfg  will be created. If the  -f  option is given a default disk image file will be created.

All file names begins with prefix name (without the path) separated by a  -  (dash). Existing files will not be overwritten.

 –reset <name> \ \ Perform a “warm start” of name. This will be done with the qemu monitor command  system_reset .

 -R | –restart <name>      Restart the virtual machine name. This executes the start/stop functions of  qemud-init . The virtual machine will be stopped and afterwards new started.

 -s | –status <name>      Show the actual runtime configuration of name. If name is not given it shows a short status of all registered virtual machines,

 -S | –start <name>     Start the virtual machine name.

 -u | –unregister <name>      Unregister the virtual machine name. The entry will be removed from  ETCDIR/registered . All existing files of virtual machine  name  stay untouched.

 –vnc <name>      Calls  qemud-vnc  to start a vncviewer for name. If name is not specified the actual vnc status will be shown. Refer to  qemud-vnc.8  for details of its behavior.

 -V | –version     Show version info and exit.

Options:
 –cdrom [ <file> ]  Mount <file> at the first virtual cdrom drive. Usually <file> is an iso image. If <file> is not given, the first cdrom drive will be ejected. This option works with the action  –reset  only.

EXAMPLES

Register a new virtual machine with name 'pluto' and create all files:

  $> qemu-adm -r /home/vm/pluto -f

Unregister a virtual machine with name 'pluto':

  $> qemu-adm -u pluto

Check the char devices of 'pluto' through the qemu monitor:

  $> qemu-adm -c "info chardev" pluto

AUTHOR

Kai Peter (©2017-present)

SEE ALSO:

qemud-init(8), qemud(8) library qemud-ast(8), qemud-reg(8), qemud-sio,