man7.org > Linux > man-pages

Linux/UNIX system programming training

lxc-console(1) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | COMMON OPTIONS | DIAGNOSTIC | SEE ALSO | COLOPHON 

lxc-console(1)                                            lxc-console(1)

NAME         top

       lxc-console - Launch a console for the specified container

SYNOPSIS         top

       lxc-console {-n name} [-e escape character] [-t ttynum]

DESCRIPTION         top

       If  the  tty service has been configured and is available for the
       container specified as parameter, this command will launch a con‐
       sole allowing to log on the container.

       The available tty are free slots  taken  by  this  command.  That
       means  if  the  container has four ttys available and the command
       has been launched four times each taking  a  different  tty,  the
       fifth command will fail because no console will be available.

       The  command  will connect to a tty. If the connection is lost or
       broken, the command can be launched again and regain the  tty  at
       the state it was before the disconnection.

       A ttynum of 0 may be given to attach to the container's /dev/con‐
       sole instead of its dev/tty<ttynum>.

       A keyboard escape sequence may be used to disconnect from the tty
       and quit lxc-console. The default escape sequence is <Ctrl+a q>.

OPTIONS         top

       -e, --escape escape character
              Specify the escape sequence prefix to use instead of <Ctrl
              a>.  This may be given as '^letter' or just 'letter'. For
              example to use <Ctrl+b q> as the escape sequence use -e
              '^b'.

       -t, --tty ttynum
              Specify the tty number to connect to or 0 for the console.
              If not specified the next available tty number will be au‐
              tomatically chosen by the container.

COMMON OPTIONS         top

       These options are common to most of lxc commands.

       -?, -h, --help
              Print a longer usage message than normal.

       --usage
              Give the usage message

       -q, --quiet
              mute on

       -P, --lxcpath=PATH
              Use an alternate container path. The default is
              /var/lib/lxc.

       -o, --logfile=FILE
              Output to an alternate log FILE. The default is no log.

       -l, --logpriority=LEVEL
              Set log priority to LEVEL. The default log priority is ER‐
              ROR. Possible values are : FATAL, ALERT, CRIT, WARN, ER‐
              ROR, NOTICE, INFO, DEBUG, TRACE.

              Note that this option is setting the priority of the
              events log in the alternate log file. It do not have ef‐
              fect on the ERROR events log on stderr.

       -n, --name=NAME
              Use container identifier NAME.  The container identifier
              format is an alphanumeric string.

       --rcfile=FILE
              Specify the configuration file to configure the virtual‐
              ization and isolation functionalities for the container.

              This configuration file if present will be used even if
              there is already a configuration file present in the pre‐
              viously created container (via lxc-create).

       --version
              Show the version number.

DIAGNOSTIC         top

       tty service denied
              No tty is available or there is not enough privilege to
              use the console. For example, the container belongs to
              user "foo" and "bar" is trying to open a console to it.

SEE ALSO         top

       lxc(7), lxc-create(1), lxc-copy(1), lxc-destroy(1), lxc-start(1),
       lxc-stop(1), lxc-execute(1), lxc-console(1), lxc-monitor(1),
       lxc-wait(1), lxc-cgroup(1), lxc-ls(1), lxc-info(1),
       lxc-freeze(1), lxc-unfreeze(1), lxc-attach(1), lxc.conf(5)

COLOPHON         top

       This page is part of the lxc (Linux containers) project.  Infor‐
       mation about the project can be found at 
       ⟨http://linuxcontainers.org/⟩.  If you have a bug report for this
       manual page, send it to lxc-devel@lists.linuxcontainers.org.
       This page was obtained from the project's upstream Git repository
       ⟨https://github.com/lxc/lxc.git⟩ on 2024-06-14.  (At that time,
       the date of the most recent commit that was found in the
       repository was 2024-06-05.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                               2024-04-03                 lxc-console(1)

Pages that refer to this page: lxc-attach(1),  lxc-autostart(1),  lxc-cgroup(1),  lxc-checkconfig(1),  lxc-checkpoint(1),  lxc-config(1),  lxc-console(1),  lxc-copy(1),  lxc-create(1),  lxc-destroy(1),  lxc-device(1),  lxc-execute(1),  lxc-freeze(1),  lxc-info(1),  lxc-ls(1),  lxc-monitor(1),  lxc-snapshot(1),  lxc-start(1),  lxc-stop(1),  lxc-top(1),  lxc-unfreeze(1),  lxc-unshare(1),  lxc-update-config(1),  lxc-usernsexec(1),  lxc-wait(1),  lxc.container.conf(5),  lxc.system.conf(5),  lxc(7)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI