Browse code
add documentation for desired_state filter
Signed-off-by: Harald Albers <github@albersweb.de>
Harald Albers authored on 2016/06/29 23:16:31Showing 3 changed files
- docs/reference/commandline/node_ls.md
- docs/reference/commandline/node_tasks.md
- docs/reference/commandline/service_tasks.md
| ... | ... |
@@ -41,12 +41,12 @@ than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "b |
| 41 | 41 |
|
| 42 | 42 |
The currently supported filters are: |
| 43 | 43 |
|
| 44 |
-* name |
|
| 45 |
-* id |
|
| 46 |
-* label |
|
| 47 |
-* desired_state |
|
| 44 |
+* [name](#name) |
|
| 45 |
+* [id](#id) |
|
| 46 |
+* [label](#label) |
|
| 47 |
+* [desired_state](#desired_state) |
|
| 48 | 48 |
|
| 49 |
-### name |
|
| 49 |
+#### name |
|
| 50 | 50 |
|
| 51 | 51 |
The `name` filter matches on all or part of a task's name. |
| 52 | 52 |
|
| ... | ... |
@@ -61,7 +61,7 @@ The following filter matches all tasks with a name containing the `redis` string |
| 61 | 61 |
0tgctg8h8cech4w0k0gwrmr23 redis.10 redis redis:3.0.6 Running 5 seconds Running swarm-manager1 |
| 62 | 62 |
|
| 63 | 63 |
|
| 64 |
-### id |
|
| 64 |
+#### id |
|
| 65 | 65 |
|
| 66 | 66 |
The `id` filter matches a task's id. |
| 67 | 67 |
|
| ... | ... |
@@ -85,6 +85,11 @@ bg8c07zzg87di2mufeq51a2qp redis.7 redis redis:3.0.6 Running 9 minutes Ru |
| 85 | 85 |
``` |
| 86 | 86 |
|
| 87 | 87 |
|
| 88 |
+#### desired_state |
|
| 89 |
+ |
|
| 90 |
+The `desired_state` filter can take the values `running` and `accepted`. |
|
| 91 |
+ |
|
| 92 |
+ |
|
| 88 | 93 |
## Related information |
| 89 | 94 |
|
| 90 | 95 |
* [node inspect](node_inspect.md) |
| ... | ... |
@@ -60,6 +60,7 @@ The currently supported filters are: |
| 60 | 60 |
|
| 61 | 61 |
* [id](#id) |
| 62 | 62 |
* [name](#name) |
| 63 |
+* [desired_state](#desired_state) |
|
| 63 | 64 |
|
| 64 | 65 |
|
| 65 | 66 |
#### ID |
| ... | ... |
@@ -84,6 +85,11 @@ ID NAME SERVICE IMAGE DESIRED STATE LAST S |
| 84 | 84 |
``` |
| 85 | 85 |
|
| 86 | 86 |
|
| 87 |
+#### desired_state |
|
| 88 |
+ |
|
| 89 |
+The `desired_state` filter can take the values `running` and `accepted`. |
|
| 90 |
+ |
|
| 91 |
+ |
|
| 87 | 92 |
## Related information |
| 88 | 93 |
|
| 89 | 94 |
* [service create](service_create.md) |