umladmin

umladmin − Administrative interface to UMLMON

umladmin [OPTIONS] (list|start|stop|update|password|config) [vmname ...]

This command provides a collection of administrative interfaces to UMLMON. In particular, one can list the configured virtual machines (VMs), one can start and stop them, and one can do some manipulations of the configuration file.

The first non−optional keyword selects the mode of operation:

list:

The VMs configured in /etc/umlmon are listed together with the current runtime status. Note that VMs whose monitor is running but that have been removed from /etc/umlmon are not shown.

If names of VMs are passed on the command line, the statuses of these VMs are determined and printed.

start:

The VMs configured in /etc/umlmon are started, if possible. In particular, it is checked how far the VM should be started up by inspecting the start parameter of the configuration file. If this parameter is off, the VM is not started at all. If the parameter is manual, the umlmon daemon is started, but the virtual system is not booted. If the parameter is boot, the daemon is started, and the UML kernel is booted.

If there is already a running daemon, its state is not changed at all, i.e. this command affects only VMs that are completely down.

Note that the boot process is performed in the background, i.e. the command does not wait until the started systems are ready.

If names of VMs are passed on the command line, these VMs are started instead of the configured ones.

stop:

The VMs configured in /etc/umlmon are shut down. If there is a running UML kernel, it is tried to shut it down properly by sending a CTRL−ALT−DEL event. If the kernel is not down after a certain period of time (300 seconds by default), more drastic measures are taken. In particular, it is then tried to sync and umount the virtual disks, before the kernel is immediately halted. As a last resort, the UML kernel is killed.

After the kernel is shut down, the umlmon monitor is terminated, too.

The command initiates the shutdown of all affected VMs in parallel, and waits until all VMs are down.

If names of VMs are passed on the command line, these VMs are shut down instead of the configured ones.

update:

After VMs have been added to the configuration file or have been removed from it, this command can be used to synchronize the run−time state with the configuration. In particular, newly added VMs are started (as for the start command), and removed VMs are shut down (as for the stop command). VMs whose start parameter is set to off are shut down, too.

password:

Reads a password from stdin, and prints the corresponding MD5 hash on stdout.

config:

The name of a single VM must be passed on the command line. The effective configuration of this VM is printed to stdout, i.e. the configuration after merging /etc/umlmon with the user−supplied changes of the configuration.

There are options to modify the printed configuration. These options do not modify the stored configuration, however.

−active:

The list command lists only VMs with running UML kernel.

−inactive:

The list command lists only VMs with inactive UML kernel and running umlmon daemon.

−off:

The list command lists only VMs without umlmon daemon.

−timeout n:

Changes the timeout for the shutdown of a virtual system from 300 seconds to n seconds. This options has only an effect for the stop and update commands.

−clear param:

The config command deletes this parameter from the printed configuration.

−set param=value

The config command sets this parameter in the printed configuration.

−rename vmname:

The config command renames the VM in the printed configuration to vmname.

−version:

Outputs the version number and exits.

These are the default locations of the files. One can change the locations in /etc/umlmon.

/etc/umlmon:

The main configuration file, see umlmon(5) for a description.

/var/run/umlmon/vmname.pid:

The process ID of the umlmon daemon for vmname.

/var/lib/umlmon/vmname/ctrl:

This is the Unix Domain socket connecting to the RPC interface of the umlmon daemon for vmname.

/var/lib/umlmon/vmname/config:

These are the user changes of the configuration for the VM vmname. These settings override the settings in /etc/umlmon.

UMLMON was written by Gerd Stolpmann.

Report bugs to gerd@gerd−stolpmann.de

You can get commercial support for UMLMON. Please ask Gerd Stolpmann <gerd@gerd−stolpmann.de>.

Copyright (C) 2005 Informatikbuero Gerd Stolpmann. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

umlwatch(1), umlmon(5), umlmon(7), umlmon (8), umldir(8)