DockerCLI/docs/reference/commandline/node_ls.md

2.6 KiB

Warning: this command is part of the Swarm management feature introduced in Docker 1.12, and might be subject to non backward-compatible changes.

node ls

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                           NAME           MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
1bcef6utixb0l0ca7gxuivsj0    swarm-worker2   Accepted    Ready   Active
38ciaotwjuritcdtn9npbnkuz    swarm-worker1   Accepted    Ready   Active
e216jshn25ckzbvmwlnh5jr3g *  swarm-manager1  Accepted    Ready   Active        Reachable       Yes

Filtering

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
  • id
  • label
  • desired_state

name

The name filter matches on all or part of a node name.

The following filter matches the node with a name equal to swarm-master string.

$ docker node ls -f name=swarm-manager1
ID                           NAME            MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
e216jshn25ckzbvmwlnh5jr3g *  swarm-manager1  Accepted    Ready   Active        Reachable       Yes

id

The id filter matches all or part of a node's id.

$ docker node ls -f id=1
ID                         NAME           MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
1bcef6utixb0l0ca7gxuivsj0  swarm-worker2  Accepted    Ready   Active

label

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

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

$ docker node ls -f "label=foo"
ID                         NAME           MEMBERSHIP  STATUS  AVAILABILITY  MANAGER STATUS  LEADER
1bcef6utixb0l0ca7gxuivsj0  swarm-worker2  Accepted    Ready   Active