qemu-init library


qemud-reg

This is the same content like the man page qemud-reg(8). See naming conventions for abbreviations.


qemud-reg(8)

April 21, 2021

NAME

 qemud-reg  - register, unregister and list virtual machines.

SYNOPSIS

         qemud-reg [ -l | -r [ -p <arg> ] [ -U ] | -s | -u ] <name> 

DESCRIPTION

 qemud-reg  is designed as an executable library to be invoked by  qemu-adm . The option handling is to a large extend fault-tolerant. Without any arguments it behaves like the option  -l  was specified.

OPTIONS

Options is a series of getopt-style short options. If <name> is required by an option it should be the last (positional) argument.

 -l  Print a table of registered virtual machines. This option doesn't require an argument. If <name> is given it will be ignored silently.

 -r <name>  Register a virtual machine <name>. To register a virtual machine a location (path) is required. This could be done either with the  -p  option or by specifying <name> with an absolute path. The latter is recommended and used by  qemu-adm . The option  -p  takes precedence over <name> with an absolute path.

Internally  qemud-reg  does some checks to validate <name>. Example: If <name> contains a dot, everything after and including the first dot will be cut off.

 -s  Print the short actual status of all registered virtual machines. The term 'short' means here that a registered virtual machine is running or not.

 -u <name>  Unregister virtual machine <name>. This option alone doesn't remove any files.

CONFIG FILES

All registered virtual machines will be written to  ETCDIR/registered , one per line. A line contains the <name> with the absolute path. It is highly recommended to NOT edit this file manually. Invalid entries could lead into undefined behavior.

RETURN CODES

 qemud-reg  returns 0 on success. Otherwise it returns non zero with an error code.

AUTHOR

Kai Peter (©2020-present)

SEE ALSO:

qemu-adm(1)