virt-login-shell(1)

1VIRT-LOGIN-SHELL(1)         Virtualization Support         VIRT-LOGIN-SHELL(1)
2
3
4

NAME

6       virt-login-shell - tool to execute a shell within a container matching
7       the users name
8

SYNOPSIS

10       virt-login-shell [OPTION]
11

DESCRIPTION

13       The virt-login-shell program is a setuid shell that is used to join an
14       LXC container that matches the user's name.  If the container is not
15       running, virt-login-shell will attempt to start the container.  virt-
16       login-shell is not allowed to be run by root.  Normal users will get
17       added to a container that matches their username, if it exists, and
18       they are configured in /etc/libvirt/virt-login-shell.conf.
19
20       The basic structure of most virt-login-shell usage is:
21
22         virt-login-shell
23

OPTIONS

25       -c CMD
26           Instruct the shell to run CMD instead of presenting an interactive
27           shell prompt.
28
29       -h, --help
30           Display command line help usage then exit.
31
32       -V, --version
33           Display version information then exit.
34

CONFIG

36       By default, virt-login-shell will execute the /bin/sh program for the
37       user.  You can modify this behaviour by defining the shell variable in
38       /etc/libvirt/virt-login-shell.conf.
39
40       eg.  shell = [ "/bin/bash" ]
41
42       If the 'auto_shell' config option is set then it will attempt to
43       automatically detect the shell from /etc/password inside the container.
44       This should only be done if the container has a separate /etc directory
45       from the host, otherwise it will end up recursively invoking virt-
46       login-shell.
47
48       eg. auto_shell = 1
49
50       By default no users are allowed to use virt-login-shell, if you want to
51       allow certain users to use virt-login-shell, you need to modify the
52       allowed_users variable in /etc/libvirt/virt-login-shell.conf.
53
54       eg. allowed_users = [ "tom", "dick", "harry" ]
55

EXIT STATUS

57       virt-login-shell normally returns the exit status of the command it
58       executed. If the command was killed by a signal, but that signal is not
59       fatal to virt-login-shell, then it returns the signal number plus 128.
60
61       Exit status generated by virt-login-shell itself:
62
63       0 An option was used to learn more about this binary.
64       125 Generic error before attempting execution of the configured shell;
65       for example, if libvirtd is not running.
66       126 The configured shell exists but could not be executed.
67       127 The configured shell could not be found.
68

BUGS

70       Report any bugs discovered to the libvirt community via the mailing
71       list <https://libvirt.org/contact.html> or bug tracker
72       <https://libvirt.org/bugs.html>.  Alternatively report bugs to your
73       software distributor / vendor.
74

AUTHORS

76         Please refer to the AUTHORS file distributed with libvirt.
77
78         Daniel Walsh <dwalsh at redhat dot com>
79

COPYRIGHT

81       Copyright (C) 2013-2014 Red Hat, Inc., and the authors listed in the
82       libvirt AUTHORS file.
83

LICENSE

85       virt-login-shell is distributed under the terms of the GNU LGPL v2+.
86       This is free software; see the source for copying conditions. There is
87       NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
88       PURPOSE
89