6a1ceaa1e1
Rather than conflict with the unexposed task model, change the names of the object-oriented task display to `docker <object> ps`. The command works identically to `docker service tasks`. This change is superficial. This provides a more sensical docker experience while not trampling on the task model that may be introduced as a top-level command at a later date. The following is an example of the display using `docker service ps` with a service named `condescending_cori`: ``` $ docker service ps condescending_cori ID NAME SERVICE IMAGE LAST STATE DESIRED STATE NODE e2cd9vqb62qjk38lw65uoffd2 condescending_cori.1 condescending_cori alpine Running 13 minutes ago Running 6c6d232a5d0e ``` The following shows the output for the node on which the command is running: ```console $ docker node ps self ID NAME SERVICE IMAGE LAST STATE DESIRED STATE NODE b1tpbi43k1ibevg2e94bmqo0s mad_kalam.1 mad_kalam apline Accepted 2 seconds ago Accepted 6c6d232a5d0e e2cd9vqb62qjk38lw65uoffd2 condescending_cori.1 condescending_cori alpine Running 12 minutes ago Running 6c6d232a5d0e 4x609m5o0qyn0kgpzvf0ad8x5 furious_davinci.1 furious_davinci redis Running 32 minutes ago Running 6c6d232a5d0e ``` Signed-off-by: Stephen J Day <stephen.day@docker.com> Upstream-commit: 0aa4e1e68973ede0c73f8a4356e2a17fc903f549 Component: engine
101 lines
3.4 KiB
Markdown
101 lines
3.4 KiB
Markdown
<!--[metadata]>
|
|
+++
|
|
title = "service ps"
|
|
description = "The service ps command description and usage"
|
|
keywords = ["service, tasks", "ps"]
|
|
aliases = ["/engine/reference/commandline/service_tasks/"]
|
|
[menu.main]
|
|
parent = "smn_cli"
|
|
+++
|
|
<![end-metadata]-->
|
|
|
|
# service ps
|
|
|
|
```Markdown
|
|
Usage: docker service ps [OPTIONS] SERVICE
|
|
|
|
List the tasks of a service
|
|
|
|
Options:
|
|
-a, --all Display all tasks
|
|
-f, --filter value Filter output based on conditions provided
|
|
--help Print usage
|
|
--no-resolve Do not map IDs to Names
|
|
```
|
|
|
|
Lists the tasks that are running as part of the specified service. This command
|
|
has to be run targeting a manager node.
|
|
|
|
|
|
## Examples
|
|
|
|
### Listing the tasks that are part of a service
|
|
|
|
The following command shows all the tasks that are part of the `redis` service:
|
|
|
|
```bash
|
|
$ docker service ps redis
|
|
ID NAME SERVICE IMAGE LAST STATE DESIRED STATE NODE
|
|
0qihejybwf1x5vqi8lgzlgnpq redis.1 redis redis:3.0.6 Running 8 seconds Running manager1
|
|
bk658fpbex0d57cqcwoe3jthu redis.2 redis redis:3.0.6 Running 9 seconds Running worker2
|
|
5ls5s5fldaqg37s9pwayjecrf redis.3 redis redis:3.0.6 Running 9 seconds Running worker1
|
|
8ryt076polmclyihzx67zsssj redis.4 redis redis:3.0.6 Running 9 seconds Running worker1
|
|
1x0v8yomsncd6sbvfn0ph6ogc redis.5 redis redis:3.0.6 Running 8 seconds Running manager1
|
|
71v7je3el7rrw0osfywzs0lko redis.6 redis redis:3.0.6 Running 9 seconds Running worker2
|
|
4l3zm9b7tfr7cedaik8roxq6r redis.7 redis redis:3.0.6 Running 9 seconds Running worker2
|
|
9tfpyixiy2i74ad9uqmzp1q6o redis.8 redis redis:3.0.6 Running 9 seconds Running worker1
|
|
3w1wu13yuplna8ri3fx47iwad redis.9 redis redis:3.0.6 Running 8 seconds Running manager1
|
|
8eaxrb2fqpbnv9x30vr06i6vt redis.10 redis redis:3.0.6 Running 8 seconds Running manager1
|
|
```
|
|
|
|
|
|
## Filtering
|
|
|
|
The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there
|
|
is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`).
|
|
Multiple filter flags are combined as an `OR` filter. For example,
|
|
`-f name=redis.1 -f name=redis.7` returns both `redis.1` and `redis.7` tasks.
|
|
|
|
The currently supported filters are:
|
|
|
|
* [id](#id)
|
|
* [name](#name)
|
|
* [desired-state](#desired-state)
|
|
|
|
|
|
#### ID
|
|
|
|
The `id` filter matches on all or a prefix of a task's ID.
|
|
|
|
```bash
|
|
$ docker service ps -f "id=8" redis
|
|
ID NAME SERVICE IMAGE LAST STATE DESIRED STATE NODE
|
|
8ryt076polmclyihzx67zsssj redis.4 redis redis:3.0.6 Running 4 minutes Running worker1
|
|
8eaxrb2fqpbnv9x30vr06i6vt redis.10 redis redis:3.0.6 Running 4 minutes Running manager1
|
|
```
|
|
|
|
#### Name
|
|
|
|
The `name` filter matches on task names.
|
|
|
|
```bash
|
|
$ docker service ps -f "name=redis.1" redis
|
|
ID NAME SERVICE IMAGE DESIRED STATE LAST STATE NODE
|
|
0qihejybwf1x5vqi8lgzlgnpq redis.1 redis redis:3.0.6 Running Running 8 seconds manager1
|
|
```
|
|
|
|
|
|
#### desired-state
|
|
|
|
The `desired-state` filter can take the values `running` and `accepted`.
|
|
|
|
|
|
## Related information
|
|
|
|
* [service create](service_create.md)
|
|
* [service inspect](service_inspect.md)
|
|
* [service ls](service_ls.md)
|
|
* [service rm](service_rm.md)
|
|
* [service scale](service_scale.md)
|
|
* [service update](service_update.md)
|