dilim/moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2026-08-08 09:01:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Standardized formatting of CLI reference commands

Browse Source 
Command name should be a H1

Only Description, Examples, and Related Commands should be H2

Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands

Added some examples where relevant

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit 52df69f00d)
This commit is contained in:
Misty Stanley-Jones
2017-04-03 14:16:43 -07:00
parent ce07fb6b0f
commit 68e914ce62
101 changed files with 2740 additions and 1726 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/reference/commandline/node_ls.md
View File

@@ -29,9 +29,13 @@ Options:
-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](#filtering) section for more information about available filter options.
## Description
Example output:
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
@@ -42,7 +46,7 @@ ID HOSTNAME STATUS AVAILABILITY MANAGER STATU
e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader
```
## Filtering
### 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"`)
@@ -55,7 +59,7 @@ The currently supported filters are:
* [name](node_ls.md#name)
* [role](node_ls.md#role)
#### ID
#### id
The `id` filter matches all or part of a node's id.
@@ -66,7 +70,7 @@ ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
```
#### Label
#### 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.
@@ -79,7 +83,7 @@ ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0 swarm-worker2 Ready Active
```
#### Membership
#### membersip
The `membership` filter matches nodes based on the presence of a `membership` and a value
`accepted` or `pending`.
@@ -94,7 +98,7 @@ ID HOSTNAME STATUS AVAILABILITY MANAGER STATU
38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active
```
#### Name
#### name
The `name` filter matches on all or part of a node hostname.
@@ -107,7 +111,7 @@ ID HOSTNAME STATUS AVAILABILITY MANAGER STATU
e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader
```
#### Role
#### role
The `role` filter matches nodes based on the presence of a `role` and a value `worker` or `manager`.
@@ -120,7 +124,7 @@ ID HOSTNAME STATUS AVAILABILITY MANAGER STATU
e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader
```
## Related information
## Related commands
* [node demote](node_demote.md)
* [node inspect](node_inspect.md)