github.com/panekj/cli@v0.0.0-20230304125325-467dd2f3797e/docs/reference/commandline/service_ps.md (about) 1 # service ps 2 3 <!---MARKER_GEN_START--> 4 List the tasks of one or more services 5 6 ### Options 7 8 | Name | Type | Default | Description | 9 |:---------------------------------------|:---------|:--------|:-------------------------------------------| 10 | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided | 11 | [`--format`](#format) | `string` | | Pretty-print tasks using a Go template | 12 | `--no-resolve` | | | Do not map IDs to Names | 13 | `--no-trunc` | | | Do not truncate output | 14 | `-q`, `--quiet` | | | Only display task IDs | 15 16 17 <!---MARKER_GEN_END--> 18 19 ## Description 20 21 Lists the tasks that are running as part of the specified services. 22 23 > **Note** 24 > 25 > This is a cluster management command, and must be executed on a swarm 26 > manager node. To learn about managers and workers, refer to the 27 > [Swarm mode section](https://docs.docker.com/engine/swarm/) in the 28 > documentation. 29 30 ## Examples 31 32 ### List the tasks that are part of a service 33 34 The following command shows all the tasks that are part of the `redis` service: 35 36 ```console 37 $ docker service ps redis 38 39 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 40 0qihejybwf1x redis.1 redis:3.0.5 manager1 Running Running 8 seconds 41 bk658fpbex0d redis.2 redis:3.0.5 worker2 Running Running 9 seconds 42 5ls5s5fldaqg redis.3 redis:3.0.5 worker1 Running Running 9 seconds 43 8ryt076polmc redis.4 redis:3.0.5 worker1 Running Running 9 seconds 44 1x0v8yomsncd redis.5 redis:3.0.5 manager1 Running Running 8 seconds 45 71v7je3el7rr redis.6 redis:3.0.5 worker2 Running Running 9 seconds 46 4l3zm9b7tfr7 redis.7 redis:3.0.5 worker2 Running Running 9 seconds 47 9tfpyixiy2i7 redis.8 redis:3.0.5 worker1 Running Running 9 seconds 48 3w1wu13yupln redis.9 redis:3.0.5 manager1 Running Running 8 seconds 49 8eaxrb2fqpbn redis.10 redis:3.0.5 manager1 Running Running 8 seconds 50 ``` 51 52 In addition to _running_ tasks, the output also shows the task history. For 53 example, after updating the service to use the `redis:3.0.6` image, the output 54 may look like this: 55 56 ```console 57 $ docker service ps redis 58 59 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 60 50qe8lfnxaxk redis.1 redis:3.0.6 manager1 Running Running 6 seconds ago 61 ky2re9oz86r9 \_ redis.1 redis:3.0.5 manager1 Shutdown Shutdown 8 seconds ago 62 3s46te2nzl4i redis.2 redis:3.0.6 worker2 Running Running less than a second ago 63 nvjljf7rmor4 \_ redis.2 redis:3.0.6 worker2 Shutdown Rejected 23 seconds ago "No such image: redis@sha256:6…" 64 vtiuz2fpc0yb \_ redis.2 redis:3.0.5 worker2 Shutdown Shutdown 1 second ago 65 jnarweeha8x4 redis.3 redis:3.0.6 worker1 Running Running 3 seconds ago 66 vs448yca2nz4 \_ redis.3 redis:3.0.5 worker1 Shutdown Shutdown 4 seconds ago 67 jf1i992619ir redis.4 redis:3.0.6 worker1 Running Running 10 seconds ago 68 blkttv7zs8ee \_ redis.4 redis:3.0.5 worker1 Shutdown Shutdown 11 seconds ago 69 ``` 70 71 The number of items in the task history is determined by the 72 `--task-history-limit` option that was set when initializing the swarm. You can 73 change the task history retention limit using the 74 [`docker swarm update`](swarm_update.md) command. 75 76 When deploying a service, docker resolves the digest for the service's 77 image, and pins the service to that digest. The digest is not shown by 78 default, but is printed if `--no-trunc` is used. The `--no-trunc` option 79 also shows the non-truncated task ID, and error-messages, as can be seen below; 80 81 ```console 82 $ docker service ps --no-trunc redis 83 84 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 85 50qe8lfnxaxksi9w2a704wkp7 redis.1 redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842 manager1 Running Running 5 minutes ago 86 ky2re9oz86r9556i2szb8a8af \_ redis.1 redis:3.0.5@sha256:f8829e00d95672c48c60f468329d6693c4bdd28d1f057e755f8ba8b40008682e worker2 Shutdown Shutdown 5 minutes ago 87 bk658fpbex0d57cqcwoe3jthu redis.2 redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842 worker2 Running Running 5 seconds 88 nvjljf7rmor4htv7l8rwcx7i7 \_ redis.2 redis:3.0.6@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842 worker2 Shutdown Rejected 5 minutes ago "No such image: redis@sha256:6a692a76c2081888b589e26e6ec835743119fe453d67ecf03df7de5b73d69842" 89 ``` 90 91 ### <a name="filter"></a> Filtering (--filter) 92 93 The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there 94 is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`). 95 Multiple filter flags are combined as an `OR` filter. For example, 96 `-f name=redis.1 -f name=redis.7` returns both `redis.1` and `redis.7` tasks. 97 98 The currently supported filters are: 99 100 * [id](#id) 101 * [name](#name) 102 * [node](#node) 103 * [desired-state](#desired-state) 104 105 106 #### id 107 108 The `id` filter matches on all or a prefix of a task's ID. 109 110 ```console 111 $ docker service ps -f "id=8" redis 112 113 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 114 8ryt076polmc redis.4 redis:3.0.6 worker1 Running Running 9 seconds 115 8eaxrb2fqpbn redis.10 redis:3.0.6 manager1 Running Running 8 seconds 116 ``` 117 118 #### name 119 120 The `name` filter matches on task names. 121 122 ```console 123 $ docker service ps -f "name=redis.1" redis 124 125 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 126 qihejybwf1x5 redis.1 redis:3.0.6 manager1 Running Running 8 seconds 127 ``` 128 129 130 #### node 131 132 The `node` filter matches on a node name or a node ID. 133 134 ```console 135 $ docker service ps -f "node=manager1" redis 136 137 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 138 0qihejybwf1x redis.1 redis:3.0.6 manager1 Running Running 8 seconds 139 1x0v8yomsncd redis.5 redis:3.0.6 manager1 Running Running 8 seconds 140 3w1wu13yupln redis.9 redis:3.0.6 manager1 Running Running 8 seconds 141 8eaxrb2fqpbn redis.10 redis:3.0.6 manager1 Running Running 8 seconds 142 ``` 143 144 #### desired-state 145 146 The `desired-state` filter can take the values `running`, `shutdown`, or `accepted`. 147 148 ### <a name="format"></a> Format the output (--format) 149 150 The formatting options (`--format`) pretty-prints tasks output 151 using a Go template. 152 153 Valid placeholders for the Go template are listed below: 154 155 | Placeholder | Description | 156 |-----------------|------------------------------------------------------------------| 157 | `.ID` | Task ID | 158 | `.Name` | Task name | 159 | `.Image` | Task image | 160 | `.Node` | Node ID | 161 | `.DesiredState` | Desired state of the task (`running`, `shutdown`, or `accepted`) | 162 | `.CurrentState` | Current state of the task | 163 | `.Error` | Error | 164 | `.Ports` | Task published ports | 165 166 When using the `--format` option, the `service ps` command will either 167 output the data exactly as the template declares or, when using the 168 `table` directive, includes column headers as well. 169 170 The following example uses a template without headers and outputs the 171 `Name` and `Image` entries separated by a colon (`:`) for all tasks: 172 173 ```console 174 $ docker service ps --format "{{.Name}}: {{.Image}}" top 175 176 top.1: busybox 177 top.2: busybox 178 top.3: busybox 179 ``` 180 181 ## Related commands 182 183 * [service create](service_create.md) 184 * [service inspect](service_inspect.md) 185 * [service logs](service_logs.md) 186 * [service ls](service_ls.md) 187 * [service rm](service_rm.md) 188 * [service rollback](service_rollback.md) 189 * [service scale](service_scale.md) 190 * [service update](service_update.md)