From 44766978671aec3ecd62765d2c508e33a6e1dc30 Mon Sep 17 00:00:00 2001 From: Harald Albers Date: Wed, 29 Jun 2016 07:16:31 -0700 Subject: [PATCH] add documentation for desired_state filter Signed-off-by: Harald Albers (cherry picked from commit 36f57f7d024e44b1db7f5cd0c24526f4cdfb7234) --- docs/reference/commandline/node_ls.md | 1 - docs/reference/commandline/node_tasks.md | 17 +++++++++++------ docs/reference/commandline/service_tasks.md | 6 ++++++ 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/reference/commandline/node_ls.md b/docs/reference/commandline/node_ls.md index 56e157a38e..d2f9ec074c 100644 --- a/docs/reference/commandline/node_ls.md +++ b/docs/reference/commandline/node_ls.md @@ -45,7 +45,6 @@ The currently supported filters are: * name * id * label -* desired_state ### name diff --git a/docs/reference/commandline/node_tasks.md b/docs/reference/commandline/node_tasks.md index d4c258c1aa..4cfa4cd23e 100644 --- a/docs/reference/commandline/node_tasks.md +++ b/docs/reference/commandline/node_tasks.md @@ -42,12 +42,12 @@ than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "b The currently supported filters are: -* name -* id -* label -* desired_state +* [name](#name) +* [id](#id) +* [label](#label) +* [desired_state](#desired_state) -### name +#### name The `name` filter matches on all or part of a task's name. @@ -62,7 +62,7 @@ The following filter matches all tasks with a name containing the `redis` string 0tgctg8h8cech4w0k0gwrmr23 redis.10 redis redis:3.0.6 Running 5 seconds Running swarm-manager1 -### id +#### id The `id` filter matches a task's id. @@ -86,6 +86,11 @@ bg8c07zzg87di2mufeq51a2qp redis.7 redis redis:3.0.6 Running 9 minutes Ru ``` +#### desired_state + +The `desired_state` filter can take the values `running` and `accepted`. + + ## Related information * [node inspect](node_inspect.md) diff --git a/docs/reference/commandline/service_tasks.md b/docs/reference/commandline/service_tasks.md index e3a4907541..e6cbcf935e 100644 --- a/docs/reference/commandline/service_tasks.md +++ b/docs/reference/commandline/service_tasks.md @@ -61,6 +61,7 @@ The currently supported filters are: * [id](#id) * [name](#name) +* [desired_state](#desired_state) #### ID @@ -85,6 +86,11 @@ ID NAME SERVICE IMAGE DESIRED STATE LAST S ``` +#### desired_state + +The `desired_state` filter can take the values `running` and `accepted`. + + ## Related information * [service create](service_create.md)