From 92b86eb31d67b4e7d307b66957f60cfdd65baaaf Mon Sep 17 00:00:00 2001 From: John McCabe Date: Tue, 22 Mar 2016 11:05:02 +0000 Subject: [PATCH 1/2] fix invoke params examples --- guide/ops/cli/cli-ref-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guide/ops/cli/cli-ref-guide.md b/guide/ops/cli/cli-ref-guide.md index 772aa5eb..1148f57a 100644 --- a/guide/ops/cli/cli-ref-guide.md +++ b/guide/ops/cli/cli-ref-guide.md @@ -217,7 +217,7 @@ policy pol - `br effector invoke` Invoke the effector without any parameters. -- `br effector invoke [= ...]` +- `br effector invoke [-P = ...]` Invoke the effector with one of more parameters. - `br effector` @@ -229,7 +229,7 @@ policy pol - `br effector invoke` Invoke the effector without any parameters. -- `br effector invoke [= ...]` +- `br effector invoke [-P = ...]` Invoke the effector with one of more parameters. If the parameter value is complex or multi-lined it may be provided in a file and referenced as: From 32368e459a777211aa668636d345b7b3b2eee0a6 Mon Sep 17 00:00:00 2001 From: John McCabe Date: Tue, 22 Mar 2016 11:06:18 +0000 Subject: [PATCH 2/2] fix invoke params app example --- guide/ops/cli/cli-usage-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guide/ops/cli/cli-usage-guide.md b/guide/ops/cli/cli-usage-guide.md index 16590cf7..95a329c3 100644 --- a/guide/ops/cli/cli-usage-guide.md +++ b/guide/ops/cli/cli-usage-guide.md @@ -258,13 +258,13 @@ $ br app WebCluster entity NginxController:CZ8Q effector update invoke Parameters can also be passed to the effector: {% highlight text %} -$ br app WebCluster entity NginxController:CZ8Q effector restart invoke restartChildren=true +$ br app WebCluster entity NginxController:CZ8Q effector restart invoke -P restartChildren=true {% endhighlight %} If a parameter value is complex or spans multiple lines, it may be provided in a file and used like this: {% highlight text %} -$ br app WebCluster effector start invoke locations=@data.txt +$ br app WebCluster effector start invoke -P locations=@data.txt {% endhighlight %} Shortcut commands are available for the 3 standard effectors of `start`, `restart` and `stop`.