You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by km...@apache.org on 2017/09/13 17:30:28 UTC
[geode] branch develop updated: GEODE-3579 Update gfsh stop locator
docs (#765)
This is an automated email from the ASF dual-hosted git repository.
kmiller pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push:
new e5a2319 GEODE-3579 Update gfsh stop locator docs (#765)
e5a2319 is described below
commit e5a2319b06b26af4d1c78771b87bc8f5e995486d
Author: Karen Miller <ka...@users.noreply.github.com>
AuthorDate: Wed Sep 13 10:30:25 2017 -0700
GEODE-3579 Update gfsh stop locator docs (#765)
---
.../gfsh/command-pages/stop.html.md.erb | 31 +++++++++++++++++++---
1 file changed, 27 insertions(+), 4 deletions(-)
diff --git a/geode-docs/tools_modules/gfsh/command-pages/stop.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/stop.html.md.erb
index f923dfc..4eeaba2 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/stop.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/stop.html.md.erb
@@ -146,27 +146,50 @@ pc13(5192)<v20>:14622 | OK | GatewaySender ln is stopped on member pc13(5192
Stop a locator.
+**Note:** One of the command line options `--name` or `--dir`
+must be specified to identify the locator to be stopped.
+
**Availability:** Online or offline. If you want to stop a locator while you are offline, use the `--dir` option.
**Syntax:**
``` pre
-stop locator [--name=value] [--host=value] [--port=value] [--dir=value]
+stop locator --name=value | --dir=value
```
<a id="topic_EF61C54B35BA4AB7B14E58CF911F283E__table_ojb_x5g_2w"></a>
| Name | Description | Default V [...]
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------- [...]
-| <span class="keyword parmname">‑‑name</span> | The <%=vars.product_name%> member name or id of the Locator to stop. You must be connected to the JMX Manager to use this option. Can be used to stop remote locators. See [Using gfsh to Manage a Remote Cluster Over HTTP or HTTPS](../../../configuring/cluster_config/gfsh_remote.html). | |
-| <span class="keyword parmname">\\-\\-dir</span> | Directory in which the Locator was started. | curre [...]
+| <span class="keyword parmname">‑‑name</span> | The <%=vars.product_name%> member name of the locator to stop. You must be connected to the JMX Manager to use this option. Can be used to stop remote locators. See [Using gfsh to Manage a Remote Cluster Over HTTP or HTTPS](../../../configuring/cluster_config/gfsh_remote.html). | |
+| <span class="keyword parmname">\\-\\-dir</span> | Directory in which the locator was started. | current directory |
<span class="tablecap">Table 3. Stop Locator Parameters</span>
**Example Commands:**
``` pre
-stop locator [--name=value] [--host=value] [--port=value] [--dir=value]
+stop locator --name=locator3
+```
+
+**Sample Output:**
+
+```
+gfsh>stop locator --name=locator3
+Stopping Locator running in /Users/test/locator3 on 192.0.2.0[10334] as locator3...
+Process ID: 71531
+Log File: /Users/test/locator3/locator3.log
+...
+No longer connected to 192.0.2.0[1099].
+```
+
+```
+gfsh>stop locator --dir=loc2
+Stopping Locator running in /Users/test/loc2 on 192.0.2.0[10334] as loc2...
+Process ID: 71714
+Log File: /Users/test/loc2/loc2.log
+...
+No longer connected to 192.0.2.0[1099].
```
## <a id="topic_723EE395A63A40D6819618AFC2902115" class="no-quick-link"></a>stop server
--
To stop receiving notification emails like this one, please contact
['"commits@geode.apache.org" <co...@geode.apache.org>'].