Skip to content

Commit

Permalink
Add docker ps status descriptions
Browse files Browse the repository at this point in the history 
Signed-off-by: Sam Thibault <sam.thibault@docker.com>
(cherry picked from commit 8bf121c)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
  • Loading branch information
@sam-thibault @thaJeztah
sam-thibault authored and thaJeztah committed Oct 23, 2023
1 parent 30a185e commit 54d83fb
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions docs/reference/commandline/ps.md
View file
Expand Up @@ -174,9 +174,19 @@ Any of these events result in a `137` status:

#### status

The `status` filter matches containers by status. You can filter using
`created`, `restarting`, `running`, `removing`, `paused`, `exited` and `dead`. For example,
to filter for `running` containers:
The `status` filter matches containers by status. The possible values for the container status are:

| Status | Description |
| :----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `created` | A container that has never been started. |
| `running` | A running container, started by either `docker start` or `docker run`. |
| `paused` | A paused container. See `docker pause`. |
| `restarting` | A container which is starting due to the designated restart policy for that container. |
| `exited` | A container which is no longer running. For example, the process inside the container completed or the container was stopped using the `docker stop` command. |
| `removing` | A container which is in the process of being removed. See `docker rm`. |
| `dead` | A "defunct" container; for example, a container that was only partially removed because resources were kept busy by an external process. `dead` containers cannot be (re)started, only removed. |

For example, to filter for `running` containers:

```console
$ docker ps --filter status=running
Expand Down

0 comments on commit 54d83fb

Please sign in to comment.