NAME

vhalt - shutdown a running netkit virtual machine

SYNOPSIS

vhalt [options] MACHINE-ID...

DESCRIPTION

The vhalt command can be used to gracefully shutdown running virtual machines. Using vhalt has exactly the same effect as issuing the 'halt' command inside the virtual machine.

MACHINE-ID is either the name or the PID of a virtual machine.

This command supports the following options.

-q

--quick

--quiet

The default behaviour is to wait a few seconds in order to check whether the virtual machine has actually shut down. By using this option, vhalt issues the shutdown command and exits immediately, without waiting for termination of the virtual machine. This option also suppresses any output, except errors and warnings.

This is useful, for example, to embed invocations of vhalt inside scripts.

-r

--remove-fs

Delete virtual machine (COW) filesystem after halting machine. This option does not affect in any way the model filesystem. In particular, using this option has no effect on machines started with the --no-cow or -W option. See the README in the Netkit filesystem package for more information about COW and model filesystems.

-u USERNAME

--user=USERNAME

Restrict the vhalt range of action to virtual machines owned by USERNAME. By using this option, only machines started by USERNAME can be halted. This option is useful, for example, if you want to halt someone else's machines (this requires administrative privileges). By default vhalt only considers virtual machines owned by the current user (the one who launched the vhalt command). The special USERNAME '-' is reserved and can be used to kill virtual machines regardless of their owner.

Special care must be taken if you choose to pass virtual machine names to vhalt and the '--user=-' option is being used. If two (or more) different users are running virtual machines having the same name, then only the one returned by

'vlist --user=- name'

is halted.

Other available options are:

-h

--help

Show usage information.

--version

Print information about the installed Netkit release and the host kernel version and exit. If ''<unavailable>'' is printed instead of a version number, then the corresponding information could not be retrieved (for example because a non-standard Netkit kernel or filesystem is being used).

ENVIRONMENT VARIABLES

All Netkit commands require that the NETKIT_HOME variable contains the name of the directory Netkit is installed in.

Apart from this, vhalt supports no other environment variables.

SEE ALSO

vclean(1), vconf(1), vcrash(1), vlist(1), vstart(1), Netkit filesystem README.

AUTHOR

vhalt script: Massimo Rimondini
This man page: Massimo Rimondini, Fabio Ricci

REPORTING BUGS

Report bugs to the Github issues page: https://github.com/netkit-jh/netkit-jh-build/issues

Please follow the recommended templates when reporting bugs.