lxc-stop(1) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXIT VALUE | DIAGNOSTIC | SEE ALSO | COLOPHON

lxc-stop(1)                                                  lxc-stop(1)

NAME         top

       lxc-stop - stop the application running inside a container

SYNOPSIS         top

       lxc-stop {-n name} [-W] [-r] [-t timeout] [-k] [--nokill]
                [--nolock]

DESCRIPTION         top

       lxc-stop  reboots, cleanly shuts down, or kills all the processes
       inside the container. By default, it will request a  clean  shut‐
       down  of  the  container  by sending lxc.signal.halt (defaults to
       SIGPWR) to the container's init process, waiting up to 60 seconds
       for the container to exit, and then returning. If  the  container
       fails to cleanly exit in 60 seconds, it will be sent the lxc.sig‐
       nal.stop  (defaults  to  SIGKILL) to force it to shut down. A re‐
       quest to reboot will send the lxc.signal.reboot (defaults to SIG‐
       INT) to the container's init process.

       The [-W], [-r], [-k] and [--nokill] options specify the action to
       perform.  [-W] indicates that after performing the specified  ac‐
       tion, lxc-stop should immediately exit, while [-t TIMEOUT] speci‐
       fies the maximum amount of time to wait for the container to com‐
       plete the shutdown or reboot.

OPTIONS         top

       -r,--reboot
              Request a reboot of the container.

       -k,--kill
              Rather than requesting a clean shutdown of the container,
              explicitly kill all tasks in the container. This is the
              legacy lxc-stop behavior.

       --nokill
              Only request a clean shutdown, do not kill the container
              tasks if the clean shutdown fails.

       --nolock
              This option avoids the use of any of the API lxc locking,
              and should only be used if lxc-stop is hanging due to a
              bad system state.

       -W,--nowait
              Simply perform the requestion action (reboot, shutdown, or
              hard kill) and exit.

       -t,--timeout TIMEOUT
              Wait TIMEOUT seconds before hard-stopping the container.

EXIT VALUE         top

       0      The container was successfully stopped.

       1      An error occurred while stopping the container.

       2      The specified container exists but was not running.

DIAGNOSTIC         top

       The container was not found
              The specified container was not created before with the
              lxc-create command.

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 [email protected].
       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
       [email protected]

                               2024-04-03                    lxc-stop(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)