Skip to content

Latest commit

History

History
146 lines (103 loc) · 5.68 KB

File metadata and controls

146 lines (103 loc) · 5.68 KB

node ps

List tasks running on one or more nodes, defaults to current node

Options

NameTypeDefaultDescription
-f, --filterfilterFilter output based on conditions provided
--formatstringPretty-print tasks using a Go template
--no-resolveboolDo not map IDs to Names
--no-truncboolDo not truncate output
-q, --quietboolOnly display task IDs

Description

Lists all the tasks on a Node that Docker knows about. You can filter using the -f or --filter flag. Refer to the filtering section for more information about available filter options.

Note

This is a cluster management command, and must be executed on a swarm manager node. To learn about managers and workers, refer to the Swarm mode section in the documentation.

Examples

$ docker node ps swarm-manager1NAME IMAGE NODE DESIRED STATE CURRENT STATEredis.1.7q92v0nr1hcgts2amcjyqg3pq redis:7.4.1 swarm-manager1 Running Running 5 hoursredis.6.b465edgho06e318egmgjbqo4o redis:7.4.1 swarm-manager1 Running Running 29 secondsredis.7.bg8c07zzg87di2mufeq51a2qp redis:7.4.1 swarm-manager1 Running Running 5 secondsredis.9.dkkual96p4bb3s6b10r7coxxt redis:7.4.1 swarm-manager1 Running Running 5 secondsredis.10.0tgctg8h8cech4w0k0gwrmr23 redis:7.4.1 swarm-manager1 Running Running 5 seconds

Filtering (--filter)

The filtering flag (-f or --filter) format is of "key=value". If there is more than one filter, then pass multiple flags (e.g., --filter "foo=bar" --filter "bif=baz").

The currently supported filters are:

name

The name filter matches on all or part of a task's name.

The following filter matches all tasks with a name containing the redis string.

$ docker node ps -f name=redis swarm-manager1NAME IMAGE NODE DESIRED STATE CURRENT STATEredis.1.7q92v0nr1hcgts2amcjyqg3pq redis:7.4.1 swarm-manager1 Running Running 5 hoursredis.6.b465edgho06e318egmgjbqo4o redis:7.4.1 swarm-manager1 Running Running 29 secondsredis.7.bg8c07zzg87di2mufeq51a2qp redis:7.4.1 swarm-manager1 Running Running 5 secondsredis.9.dkkual96p4bb3s6b10r7coxxt redis:7.4.1 swarm-manager1 Running Running 5 secondsredis.10.0tgctg8h8cech4w0k0gwrmr23 redis:7.4.1 swarm-manager1 Running Running 5 seconds

id

The id filter matches a task's id.

$ docker node ps -f id=bg8c07zzg87di2mufeq51a2qp swarm-manager1NAME IMAGE NODE DESIRED STATE CURRENT STATEredis.7.bg8c07zzg87di2mufeq51a2qp redis:7.4.1 swarm-manager1 Running Running 5 seconds

label

The label filter matches tasks based on the presence of a label alone or a label and a value.

The following filter matches tasks with the usage label regardless of its value.

$ docker node ps -f "label=usage"NAME IMAGE NODE DESIRED STATE CURRENT STATEredis.6.b465edgho06e318egmgjbqo4o redis:7.4.1 swarm-manager1 Running Running 10 minutesredis.7.bg8c07zzg87di2mufeq51a2qp redis:7.4.1 swarm-manager1 Running Running 9 minutes

desired-state

The desired-state filter can take the values running, shutdown, or accepted.

Format the output (--format)

The formatting options (--format) pretty-prints tasks output using a Go template.

Valid placeholders for the Go template are listed below:

PlaceholderDescription
.IDTask ID
.NameTask name
.ImageTask image
.NodeNode ID
.DesiredStateDesired state of the task (running, shutdown, or accepted)
.CurrentStateCurrent state of the task
.ErrorError
.PortsTask published ports

When using the --format option, the node ps command will either output the data exactly as the template declares or, when using the table directive, includes column headers as well.

The following example uses a template without headers and outputs the Name and Image entries separated by a colon (:) for all tasks:

$ docker node ps --format "{{.Name}}: {{.Image}}"top.1: busyboxtop.2: busyboxtop.3: busybox

Related commands