2016-10-14 18:30:36 -04:00
---
title: "node ls"
description: "The node ls command description and usage"
2016-11-03 18:48:30 -04:00
keywords: "node, list"
2016-10-14 18:30:36 -04:00
---
2016-06-13 22:57:19 -04:00
2016-10-19 13:25:45 -04:00
<!-- This file is maintained within the docker/docker Github
repository at https://github.com/docker/docker/. Make all
pull requests against that repo. If you see this file in
another repository, consider it read-only there, as it will
periodically be overwritten by the definitive file. Pull
requests which include edits to this file in other repositories
will be rejected.
-->
2016-06-13 22:57:19 -04:00
# node ls
2016-07-07 14:43:18 -04:00
```markdown
Usage: docker node ls [OPTIONS]
2016-06-13 22:57:19 -04:00
2016-07-07 14:43:18 -04:00
List nodes in the swarm
2016-06-13 22:57:19 -04:00
2016-07-07 14:43:18 -04:00
Aliases:
ls, list
2016-06-13 22:57:19 -04:00
2016-07-07 14:43:18 -04:00
Options:
-f, --filter value Filter output based on conditions provided
--help Print usage
-q, --quiet Only display IDs
```
2016-06-13 22:57:19 -04:00
Lists all the nodes that the Docker Swarm manager knows about. You can filter using the `-f` or `--filter` flag. Refer to the [filtering ](#filtering ) section for more information about available filter options.
Example output:
2016-07-22 07:13:30 -04:00
```bash
$ docker node ls
2016-06-13 22:57:19 -04:00
2016-07-22 07:13:30 -04:00
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active
e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader
```
2016-06-13 22:57:19 -04:00
## 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:
2016-11-08 23:06:00 -05:00
* [id ](node_ls.md#id )
* [label ](node_ls.md#label )
* [membership ](node_ls.md#membership )
* [name ](node_ls.md#name )
* [role ](node_ls.md#role )
2016-06-13 22:57:19 -04:00
2016-11-08 23:06:00 -05:00
#### ID
2016-06-13 22:57:19 -04:00
2016-11-08 23:06:00 -05:00
The `id` filter matches all or part of a node's id.
2016-06-13 22:57:19 -04:00
2016-07-22 07:13:30 -04:00
```bash
2016-11-08 23:06:00 -05:00
$ docker node ls -f id=1
2016-07-22 07:13:30 -04:00
2016-11-08 23:06:00 -05:00
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
2016-07-22 07:13:30 -04:00
```
2016-06-13 22:57:19 -04:00
2016-11-08 23:06:00 -05:00
#### Label
2016-06-13 22:57:19 -04:00
2016-11-08 23:06:00 -05:00
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.
2016-06-13 22:57:19 -04:00
2016-07-22 07:13:30 -04:00
```bash
2016-11-08 23:06:00 -05:00
$ docker node ls -f "label=foo"
2016-06-13 22:57:19 -04:00
2016-07-22 07:13:30 -04:00
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
```
2016-06-13 22:57:19 -04:00
2016-11-08 23:06:00 -05:00
#### Membership
2016-06-13 22:57:19 -04:00
2016-11-08 23:06:00 -05:00
The `membership` filter matches nodes based on the presence of a `membership` and a value
`accepted` or `pending` .
2016-06-13 22:57:19 -04:00
2016-11-08 23:06:00 -05:00
The following filter matches nodes with the `membership` of `accepted` .
2016-06-13 22:57:19 -04:00
```bash
2016-11-08 23:06:00 -05:00
$ docker node ls -f "membership=accepted"
2016-07-22 07:13:30 -04:00
2016-11-08 23:06:00 -05:00
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active
2016-06-13 22:57:19 -04:00
```
2016-11-08 23:06:00 -05:00
#### Name
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.
```bash
$ docker node ls -f name=swarm-manager1
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader
```
#### Role
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.
```bash
$ docker node ls -f "role=manager"
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader
```
2016-06-13 22:57:19 -04:00
## Related information
2016-12-13 09:15:08 -05:00
* [node demote ](node_demote.md )
2016-06-13 22:57:19 -04:00
* [node inspect ](node_inspect.md )
2016-12-13 09:15:08 -05:00
* [node promote ](node_promote.md )
2016-07-19 17:01:31 -04:00
* [node ps ](node_ps.md )
2016-06-13 22:57:19 -04:00
* [node rm ](node_rm.md )
2016-12-13 09:15:08 -05:00
* [node update ](node_update.md )