github.com/pwn-term/docker@v0.0.0-20210616085119-6e977cce2565/cli/docs/reference/commandline/stack_ps.md (about) 1 --- 2 title: "stack ps" 3 description: "The stack ps command description and usage" 4 keywords: "stack, ps" 5 --- 6 7 # stack ps 8 9 ```markdown 10 Usage: docker stack ps [OPTIONS] STACK 11 12 List the tasks in the stack 13 14 Options: 15 -f, --filter filter Filter output based on conditions provided 16 --format string Pretty-print tasks using a Go template 17 --help Print usage 18 --kubeconfig string Kubernetes config file 19 --namespace string Kubernetes namespace to use 20 --no-resolve Do not map IDs to Names 21 --no-trunc Do not truncate output 22 --orchestrator string Orchestrator to use (swarm|kubernetes|all) 23 -q, --quiet Only display task IDs 24 ``` 25 26 ## Description 27 28 Lists the tasks that are running as part of the specified stack. 29 30 > **Note** 31 > 32 > This is a cluster management command, and must be executed on a swarm 33 > manager node. To learn about managers and workers, refer to the 34 > [Swarm mode section](https://docs.docker.com/engine/swarm/) in the 35 > documentation. 36 37 ## Examples 38 39 ### List the tasks that are part of a stack 40 41 The following command shows all the tasks that are part of the `voting` stack: 42 43 ```bash 44 $ docker stack ps voting 45 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 46 xim5bcqtgk1b voting_worker.1 dockersamples/examplevotingapp_worker:latest node2 Running Running 2 minutes ago 47 q7yik0ks1in6 voting_result.1 dockersamples/examplevotingapp_result:before node1 Running Running 2 minutes ago 48 rx5yo0866nfx voting_vote.1 dockersamples/examplevotingapp_vote:before node3 Running Running 2 minutes ago 49 tz6j82jnwrx7 voting_db.1 postgres:9.4 node1 Running Running 2 minutes ago 50 w48spazhbmxc voting_redis.1 redis:alpine node2 Running Running 3 minutes ago 51 6jj1m02freg1 voting_visualizer.1 dockersamples/visualizer:stable node1 Running Running 2 minutes ago 52 kqgdmededccb voting_vote.2 dockersamples/examplevotingapp_vote:before node2 Running Running 2 minutes ago 53 t72q3z038jeh voting_redis.2 redis:alpine node3 Running Running 3 minutes ago 54 ``` 55 56 ### Filtering 57 58 The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there 59 is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`). 60 Multiple filter flags are combined as an `OR` filter. For example, 61 `-f name=redis.1 -f name=redis.7` returns both `redis.1` and `redis.7` tasks. 62 63 The currently supported filters are: 64 65 * [id](#id) 66 * [name](#name) 67 * [node](#node) 68 * [desired-state](#desired-state) 69 70 #### id 71 72 The `id` filter matches on all or a prefix of a task's ID. 73 74 ```bash 75 $ docker stack ps -f "id=t" voting 76 ID NAME IMAGE NODE DESIRED STATE CURRENTSTATE ERROR PORTS 77 tz6j82jnwrx7 voting_db.1 postgres:9.4 node1 Running Running 14 minutes ago 78 t72q3z038jeh voting_redis.2 redis:alpine node3 Running Running 14 minutes ago 79 ``` 80 81 #### name 82 83 The `name` filter matches on task names. 84 85 ```bash 86 $ docker stack ps -f "name=voting_redis" voting 87 ID NAME IMAGE NODE DESIRED STATE CURRENTSTATE ERROR PORTS 88 w48spazhbmxc voting_redis.1 redis:alpine node2 Running Running 17 minutes ago 89 t72q3z038jeh voting_redis.2 redis:alpine node3 Running Running 17 minutes ago 90 ``` 91 92 #### node 93 94 The `node` filter matches on a node name or a node ID. 95 96 ```bash 97 $ docker stack ps -f "node=node1" voting 98 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 99 q7yik0ks1in6 voting_result.1 dockersamples/examplevotingapp_result:before node1 Running Running 18 minutes ago 100 tz6j82jnwrx7 voting_db.1 postgres:9.4 node1 Running Running 18 minutes ago 101 6jj1m02freg1 voting_visualizer.1 dockersamples/visualizer:stable node1 Running Running 18 minutes ago 102 ``` 103 104 #### desired-state 105 106 The `desired-state` filter can take the values `running`, `shutdown`, `ready` or `accepted`. 107 108 ```bash 109 $ docker stack ps -f "desired-state=running" voting 110 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 111 xim5bcqtgk1b voting_worker.1 dockersamples/examplevotingapp_worker:latest node2 Running Running 21 minutes ago 112 q7yik0ks1in6 voting_result.1 dockersamples/examplevotingapp_result:before node1 Running Running 21 minutes ago 113 rx5yo0866nfx voting_vote.1 dockersamples/examplevotingapp_vote:before node3 Running Running 21 minutes ago 114 tz6j82jnwrx7 voting_db.1 postgres:9.4 node1 Running Running 21 minutes ago 115 w48spazhbmxc voting_redis.1 redis:alpine node2 Running Running 21 minutes ago 116 6jj1m02freg1 voting_visualizer.1 dockersamples/visualizer:stable node1 Running Running 21 minutes ago 117 kqgdmededccb voting_vote.2 dockersamples/examplevotingapp_vote:before node2 Running Running 21 minutes ago 118 t72q3z038jeh voting_redis.2 redis:alpine node3 Running Running 21 minutes ago 119 ``` 120 121 ### Formatting 122 123 The formatting options (`--format`) pretty-prints tasks output using a Go template. 124 125 Valid placeholders for the Go template are listed below: 126 127 Placeholder | Description 128 ----------------|------------------------------------------------------------------------------------------ 129 `.ID` | Task ID 130 `.Name` | Task name 131 `.Image` | Task image 132 `.Node` | Node ID 133 `.DesiredState` | Desired state of the task (`running`, `shutdown`, or `accepted`) 134 `.CurrentState` | Current state of the task 135 `.Error` | Error 136 `.Ports` | Task published ports 137 138 When using the `--format` option, the `stack ps` command will either 139 output the data exactly as the template declares or, when using the 140 `table` directive, includes column headers as well. 141 142 The following example uses a template without headers and outputs the 143 `Name` and `Image` entries separated by a colon (`:`) for all tasks: 144 145 ```bash 146 $ docker stack ps --format "{{.Name}}: {{.Image}}" voting 147 voting_worker.1: dockersamples/examplevotingapp_worker:latest 148 voting_result.1: dockersamples/examplevotingapp_result:before 149 voting_vote.1: dockersamples/examplevotingapp_vote:before 150 voting_db.1: postgres:9.4 151 voting_redis.1: redis:alpine 152 voting_visualizer.1: dockersamples/visualizer:stable 153 voting_vote.2: dockersamples/examplevotingapp_vote:before 154 voting_redis.2: redis:alpine 155 ``` 156 157 ### Do not map IDs to Names 158 159 The `--no-resolve` option shows IDs for task name, without mapping IDs to Names. 160 161 ```bash 162 $ docker stack ps --no-resolve voting 163 ID NAME IMAGE NODE DESIRED STATE CURRENT STATE ERROR PORTS 164 xim5bcqtgk1b 10z9fjfqzsxnezo4hb81p8mqg.1 dockersamples/examplevotingapp_worker:latest qaqt4nrzo775jrx6detglho01 Running Running 30 minutes ago 165 q7yik0ks1in6 hbxltua1na7mgqjnidldv5m65.1 dockersamples/examplevotingapp_result:before mxpaef1tlh23s052erw88a4w5 Running Running 30 minutes ago 166 rx5yo0866nfx qyprtqw1g5nrki557i974ou1d.1 dockersamples/examplevotingapp_vote:before kanqcxfajd1r16wlnqcblobmm Running Running 31 minutes ago 167 tz6j82jnwrx7 122f0xxngg17z52be7xspa72x.1 postgres:9.4 mxpaef1tlh23s052erw88a4w5 Running Running 31 minutes ago 168 w48spazhbmxc tg61x8myx563ueo3urmn1ic6m.1 redis:alpine qaqt4nrzo775jrx6detglho01 Running Running 31 minutes ago 169 6jj1m02freg1 8cqlyi444kzd3panjb7edh26v.1 dockersamples/visualizer:stable mxpaef1tlh23s052erw88a4w5 Running Running 31 minutes ago 170 kqgdmededccb qyprtqw1g5nrki557i974ou1d.2 dockersamples/examplevotingapp_vote:before qaqt4nrzo775jrx6detglho01 Running Running 31 minutes ago 171 t72q3z038jeh tg61x8myx563ueo3urmn1ic6m.2 redis:alpine kanqcxfajd1r16wlnqcblobmm Running Running 31 minutes ago 172 ``` 173 174 ### Do not truncate output 175 176 When deploying a service, docker resolves the digest for the service's 177 image, and pins the service to that digest. The digest is not shown by 178 default, but is printed if `--no-trunc` is used. The `--no-trunc` option 179 also shows the non-truncated task IDs, and error-messages, as can be seen below: 180 181 ```bash 182 $ docker stack ps --no-trunc voting 183 ID NAME IMAGE NODE DESIRED STATE CURREN STATE ERROR PORTS 184 xim5bcqtgk1bxqz91jzo4a1s5 voting_worker.1 dockersamples/examplevotingapp_worker:latest@sha256:3e4ddf59c15f432280a2c0679c4fc5a2ee5a797023c8ef0d3baf7b1385e9fed node2 Running Runnin 32 minutes ago 185 q7yik0ks1in6kv32gg6y6yjf7 voting_result.1 dockersamples/examplevotingapp_result:before@sha256:83b56996e930c292a6ae5187fda84dd6568a19d97cdb933720be15c757b7463 node1 Running Runnin 32 minutes ago 186 rx5yo0866nfxc58zf4irsss6n voting_vote.1 dockersamples/examplevotingapp_vote:before@sha256:8e64b182c87de902f2b72321c89b4af4e2b942d76d0b772532ff27ec4c6ebf6 node3 Running Runnin 32 minutes ago 187 tz6j82jnwrx7n2offljp3mn03 voting_db.1 postgres:9.4@sha256:6046af499eae34d2074c0b53f9a8b404716d415e4a03e68bc1d2f8064f2b027 node1 Running Runnin 32 minutes ago 188 w48spazhbmxcmbjfi54gs7x90 voting_redis.1 redis:alpine@sha256:9cd405cd1ec1410eaab064a1383d0d8854d1ef74a54e1e4a92fb4ec7bdc3ee7 node2 Running Runnin 32 minutes ago 189 6jj1m02freg1n3z9n1evrzsbl voting_visualizer.1 dockersamples/visualizer:stable@sha256:f924ad66c8e94b10baaf7bdb9cd491ef4e982a1d048a56a17e02bf5945401e5 node1 Running Runnin 32 minutes ago 190 kqgdmededccbhz2wuc0e9hx7g voting_vote.2 dockersamples/examplevotingapp_vote:before@sha256:8e64b182c87de902f2b72321c89b4af4e2b942d76d0b772532ff27ec4c6ebf6 node2 Running Runnin 32 minutes ago 191 t72q3z038jehe1wbh9gdum076 voting_redis.2 redis:alpine@sha256:9cd405cd1ec1410eaab064a1383d0d8854d1ef74a54e1e4a92fb4ec7bdc3ee7 node3 Running Runnin 32 minutes ago 192 ``` 193 194 ### Only display task IDs 195 196 The `-q ` or `--quiet` option only shows IDs of the tasks in the stack. 197 This example outputs all task IDs of the "voting" stack; 198 199 ```bash 200 $ docker stack ps -q voting 201 xim5bcqtgk1b 202 q7yik0ks1in6 203 rx5yo0866nfx 204 tz6j82jnwrx7 205 w48spazhbmxc 206 6jj1m02freg1 207 kqgdmededccb 208 t72q3z038jeh 209 ``` 210 211 This option can be used to perform batch operations. For example, you can use 212 the task IDs as input for other commands, such as `docker inspect`. The 213 following example inspects all tasks of the "voting" stack; 214 215 ```bash 216 $ docker inspect $(docker stack ps -q voting) 217 218 [ 219 { 220 "ID": "xim5bcqtgk1b1gk0krq1", 221 "Version": { 222 (...) 223 ``` 224 225 ## Related commands 226 227 * [stack deploy](stack_deploy.md) 228 * [stack ls](stack_ls.md) 229 * [stack rm](stack_rm.md) 230 * [stack services](stack_services.md)