2016-10-14 18:30:36 -04:00
|
|
|
|
---
|
|
|
|
|
title: "kill"
|
|
|
|
|
description: "The kill command description and usage"
|
2016-11-03 18:48:30 -04:00
|
|
|
|
keywords: "container, kill, signal"
|
2016-10-14 18:30:36 -04:00
|
|
|
|
---
|
2015-06-21 16:41:38 -04:00
|
|
|
|
|
|
|
|
|
# kill
|
|
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
|
```markdown
|
|
|
|
|
Usage: docker kill [OPTIONS] CONTAINER [CONTAINER...]
|
2015-06-21 16:41:38 -04:00
|
|
|
|
|
2016-07-29 13:41:52 -04:00
|
|
|
|
Kill one or more running containers
|
2015-06-21 16:41:38 -04:00
|
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
|
Options:
|
|
|
|
|
--help Print usage
|
2021-08-21 08:06:41 -04:00
|
|
|
|
-s, --signal string Signal to send to the container
|
2016-07-07 14:43:18 -04:00
|
|
|
|
```
|
2015-06-21 16:41:38 -04:00
|
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
|
## Description
|
|
|
|
|
|
2017-06-29 04:18:06 -04:00
|
|
|
|
The `docker kill` subcommand kills one or more containers. The main process
|
|
|
|
|
inside the container is sent `SIGKILL` signal (default), or the signal that is
|
2021-08-21 07:50:05 -04:00
|
|
|
|
specified with the `--signal` option. You can reference a container by its
|
|
|
|
|
ID, ID-prefix, or name.
|
|
|
|
|
|
2021-08-11 05:00:27 -04:00
|
|
|
|
The `--signal` flag sets the system call signal that is sent to the container.
|
|
|
|
|
This signal can be a signal name in the format `SIG<NAME>`, for instance `SIGINT`,
|
|
|
|
|
or an unsigned number that matches a position in the kernel's syscall table,
|
|
|
|
|
for instance `2`.
|
2021-08-21 07:50:05 -04:00
|
|
|
|
|
|
|
|
|
While the default (`SIGKILL`) signal will terminate the container, the signal
|
|
|
|
|
set through `--signal` may be non-terminal, depending on the container's main
|
|
|
|
|
process. For example, the `SIGHUP` signal in most cases will be non-terminal,
|
|
|
|
|
and the container will continue running after receiving the signal.
|
2015-10-28 14:06:21 -04:00
|
|
|
|
|
2020-04-19 09:43:08 -04:00
|
|
|
|
> **Note**
|
|
|
|
|
>
|
|
|
|
|
> `ENTRYPOINT` and `CMD` in the *shell* form run as a child process of
|
2017-02-07 18:42:48 -05:00
|
|
|
|
> `/bin/sh -c`, which does not pass signals. This means that the executable is
|
|
|
|
|
> not the container’s PID 1 and does not receive Unix signals.
|
2017-06-29 04:18:06 -04:00
|
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
|
2021-08-21 07:50:05 -04:00
|
|
|
|
### Send a KILL signal to a container
|
2017-06-29 04:18:06 -04:00
|
|
|
|
|
2021-08-21 07:50:05 -04:00
|
|
|
|
The following example sends the default `SIGKILL` signal to the container named
|
2017-06-29 04:18:06 -04:00
|
|
|
|
`my_container`:
|
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
|
```console
|
2017-06-29 04:18:06 -04:00
|
|
|
|
$ docker kill my_container
|
|
|
|
|
```
|
|
|
|
|
|
2022-03-30 09:05:29 -04:00
|
|
|
|
### <a name=signal></a>Send a custom signal to a container (--signal)
|
2017-06-29 04:18:06 -04:00
|
|
|
|
|
|
|
|
|
The following example sends a `SIGHUP` signal to the container named
|
|
|
|
|
`my_container`:
|
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
|
```console
|
2017-06-29 04:18:06 -04:00
|
|
|
|
$ docker kill --signal=SIGHUP my_container
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can specify a custom signal either by _name_, or _number_. The `SIG` prefix
|
|
|
|
|
is optional, so the following examples are equivalent:
|
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
|
```console
|
2017-06-29 04:18:06 -04:00
|
|
|
|
$ docker kill --signal=SIGHUP my_container
|
|
|
|
|
$ docker kill --signal=HUP my_container
|
|
|
|
|
$ docker kill --signal=1 my_container
|
|
|
|
|
```
|
|
|
|
|
|
2021-10-14 18:04:36 -04:00
|
|
|
|
Refer to the [`signal(7)`](https://man7.org/linux/man-pages/man7/signal.7.html)
|
2017-06-29 04:18:06 -04:00
|
|
|
|
man-page for a list of standard Linux signals.
|