2016-10-14 18:30:36 -04:00
|
|
|
---
|
|
|
|
title: "pause"
|
|
|
|
description: "The pause command description and usage"
|
2016-11-03 18:48:30 -04:00
|
|
|
keywords: "cgroups, container, suspend, SIGSTOP"
|
2016-10-14 18:30:36 -04:00
|
|
|
---
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2017-10-04 13:03:55 -04:00
|
|
|
<!-- This file is maintained within the docker/cli GitHub
|
2017-07-28 13:28:23 -04:00
|
|
|
repository at https://github.com/docker/cli/. Make all
|
2016-10-19 13:25:45 -04:00
|
|
|
pull requests against that repo. If you see this file in
|
|
|
|
another repository, consider it read-only there, as it will
|
|
|
|
periodically be overwritten by the definitive file. Pull
|
|
|
|
requests which include edits to this file in other repositories
|
|
|
|
will be rejected.
|
|
|
|
-->
|
|
|
|
|
2015-06-21 16:41:38 -04:00
|
|
|
# pause
|
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
```markdown
|
|
|
|
Usage: docker pause CONTAINER [CONTAINER...]
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
Pause all processes within one or more containers
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
Options:
|
|
|
|
--help Print usage
|
|
|
|
```
|
2015-10-03 11:56:41 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Description
|
|
|
|
|
2016-12-15 05:47:57 -05:00
|
|
|
The `docker pause` command suspends all processes in the specified containers.
|
|
|
|
On Linux, this uses the cgroups freezer. Traditionally, when suspending a process
|
|
|
|
the `SIGSTOP` signal is used, which is observable by the process being suspended.
|
2016-09-08 20:31:04 -04:00
|
|
|
With the cgroups freezer the process is unaware, and unable to capture,
|
|
|
|
that it is being suspended, and subsequently resumed. On Windows, only Hyper-V
|
|
|
|
containers can be paused.
|
2015-06-21 16:41:38 -04:00
|
|
|
|
|
|
|
See the
|
2016-05-26 20:28:46 -04:00
|
|
|
[cgroups freezer documentation](https://www.kernel.org/doc/Documentation/cgroup-v1/freezer-subsystem.txt)
|
2015-06-21 16:41:38 -04:00
|
|
|
for further details.
|
2016-12-15 05:47:57 -05:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ docker pause my_container
|
|
|
|
```
|
|
|
|
|
|
|
|
## Related commands
|
2016-12-15 05:47:57 -05:00
|
|
|
|
|
|
|
* [unpause](unpause.md)
|