mirror of https://github.com/docker/docs.git
85 lines
3.0 KiB
YAML
85 lines
3.0 KiB
YAML
command: docker container restart
|
|
aliases: docker container restart, docker restart
|
|
short: Restart one or more containers
|
|
long: Restart one or more containers
|
|
usage: docker container restart [OPTIONS] CONTAINER [CONTAINER...]
|
|
pname: docker container
|
|
plink: docker_container.yaml
|
|
options:
|
|
- option: signal
|
|
shorthand: s
|
|
value_type: string
|
|
description: Signal to send to the container
|
|
details_url: '#signal'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: time
|
|
shorthand: t
|
|
value_type: int
|
|
default_value: "0"
|
|
description: Seconds to wait before killing the container
|
|
details_url: '#time'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
inherited_options:
|
|
- option: help
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Print usage
|
|
deprecated: false
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
examples: |-
|
|
```console
|
|
$ docker restart my_container
|
|
```
|
|
|
|
|
|
### Stop container with signal (-s, --signal) {#signal}
|
|
|
|
The `--signal` flag sends the system call signal to the container to exit.
|
|
This signal can be a signal name in the format `SIG<NAME>`, for instance
|
|
`SIGKILL`, or an unsigned number that matches a position in the kernel's
|
|
syscall table, for instance `9`. Refer to [signal(7)](https://man7.org/linux/man-pages/man7/signal.7.html)
|
|
for available signals.
|
|
|
|
The default signal to use is defined by the image's [`StopSignal`](https://github.com/opencontainers/image-spec/blob/v1.1.0/config.md),
|
|
which can be set through the [`STOPSIGNAL`](/reference/dockerfile/#stopsignal)
|
|
Dockerfile instruction when building the image, or configured using the
|
|
[`--stop-signal`](/reference/cli/docker/container/run/#stop-signal)
|
|
option when creating the container. If no signal is configured for the
|
|
container, `SIGTERM` is used as default.
|
|
|
|
### Stop container with timeout (-t, --timeout) {#time}
|
|
|
|
The `--time` flag sets the number of seconds to wait for the container
|
|
to stop after sending the pre-defined (see [`--signal`]{#signal)) system call signal.
|
|
If the container does not exit after the timeout elapses, it's forcibly killed
|
|
with a `SIGKILL` signal.
|
|
|
|
If you set `--time` to `-1`, no timeout is applied, and the daemon
|
|
waits indefinitely for the container to exit.
|
|
|
|
The default timeout can be specified using the [`--stop-timeout`](/reference/cli/docker/container/run/#stop-timeout)
|
|
option when creating the container. If no default is configured for the container,
|
|
the Daemon determines the default, and is 10 seconds for Linux containers, and
|
|
30 seconds for Windows containers.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|