Usage: docker node ls [OPTIONS] List nodes in the swarm Aliases: ls, list Options: -f, --filter value Filter output based on conditions provided --help Print usage -q, --quiet Only display IDs
Lists all the nodes that the Docker Swarm manager knows about. You can filter using the -f
or --filter
flag. Refer to the filtering section for more information about available filter options.
Example output:
$ docker node ls ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS 1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active 38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader
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:
The id
filter matches all or part of a node's id.
$ docker node ls -f id=1 ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS 1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
The label
filter matches nodes based on engine labels and on the presence of a label
alone or a label
and a value. Node labels are currently not used for filtering.
The following filter matches nodes with the foo
label regardless of its value.
$ docker node ls -f "label=foo" ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS 1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
The membership
filter matches nodes based on the presence of a membership
and a value accepted
or pending
.
The following filter matches nodes with the membership
of accepted
.
$ docker node ls -f "membership=accepted" ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS 1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active 38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active
The name
filter matches on all or part of a node hostname.
The following filter matches the nodes with a name equal to swarm-master
string.
$ docker node ls -f name=swarm-manager1 ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader
The role
filter matches nodes based on the presence of a role
and a value worker
or manager
.
The following filter matches nodes with the manager
role.
$ docker node ls -f "role=manager" ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader