mirror of
https://github.com/genuinetools/reg.git
synced 2024-08-19 21:30:24 -04:00
173 lines
5.3 KiB
Markdown
173 lines
5.3 KiB
Markdown
---
|
|
title: "node ls"
|
|
description: "The node ls command description and usage"
|
|
keywords: "node, list"
|
|
---
|
|
|
|
<!-- This file is maintained within the docker/cli GitHub
|
|
repository at https://github.com/docker/cli/. 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.
|
|
-->
|
|
|
|
# node ls
|
|
|
|
```markdown
|
|
Usage: docker node ls [OPTIONS]
|
|
|
|
List nodes in the swarm
|
|
|
|
Aliases:
|
|
ls, list
|
|
|
|
Options:
|
|
-f, --filter filter Filter output based on conditions provided
|
|
--format string Pretty-print nodes using a Go template
|
|
--help Print usage
|
|
-q, --quiet Only display IDs
|
|
```
|
|
|
|
## Description
|
|
|
|
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.
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
$ 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
|
|
```
|
|
> **Note**:
|
|
> In the above example output, there is a hidden column of `.Self` that indicates if the
|
|
> node is the same node as the current docker daemon. A `*` (e.g., `e216jshn25ckzbvmwlnh5jr3g *`)
|
|
> means this node is the current docker daemon.
|
|
|
|
|
|
### 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:
|
|
|
|
* [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)
|
|
|
|
#### id
|
|
|
|
The `id` filter matches all or part of a node's id.
|
|
|
|
```bash
|
|
$ docker node ls -f id=1
|
|
|
|
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
|
|
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
|
|
```
|
|
|
|
#### label
|
|
|
|
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.
|
|
|
|
```bash
|
|
$ docker node ls -f "label=foo"
|
|
|
|
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
|
|
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
|
|
```
|
|
|
|
#### membership
|
|
|
|
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`.
|
|
|
|
```bash
|
|
$ docker node ls -f "membership=accepted"
|
|
|
|
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
|
|
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
|
|
38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active
|
|
```
|
|
|
|
#### 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
|
|
```
|
|
|
|
### Formatting
|
|
|
|
The formatting options (`--format`) pretty-prints nodes output
|
|
using a Go template.
|
|
|
|
Valid placeholders for the Go template are listed below:
|
|
|
|
Placeholder | Description
|
|
-----------------|------------------------------------------------------------------------------------------
|
|
`.ID` | Node ID
|
|
`.Self` | Node of the daemon (`true/false`, `true`indicates that the node is the same as current docker daemon)
|
|
`.Hostname` | Node hostname
|
|
`.Status` | Node status
|
|
`.Availability` | Node availability ("active", "pause", or "drain")
|
|
`.ManagerStatus` | Manager status of the node
|
|
`.TLSStatus` | TLS status of the node ("Ready", or "Needs Rotation" has TLS certificate signed by an old CA)
|
|
`.EngineVersion` | Engine version
|
|
|
|
When using the `--format` option, the `node ls` 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
|
|
`ID`, `Hostname`, and `TLS Status` entries separated by a colon for all nodes:
|
|
|
|
```bash
|
|
$ docker node ls --format "{{.ID}}: {{.Hostname}} {{.TLSStatus}}"
|
|
e216jshn25ckzbvmwlnh5jr3g: swarm-manager1 Ready
|
|
35o6tiywb700jesrt3dmllaza: swarm-worker1 Needs Rotation
|
|
```
|
|
|
|
|
|
## Related commands
|
|
|
|
* [node demote](node_demote.md)
|
|
* [node inspect](node_inspect.md)
|
|
* [node promote](node_promote.md)
|
|
* [node ps](node_ps.md)
|
|
* [node rm](node_rm.md)
|
|
* [node update](node_update.md)
|