GEODE-2991 Add man page for gfsh destroy gateway-sender
This closes #615
Project: http://git-wip-us.apache.org/repos/asf/geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/e715abfb
Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/e715abfb
Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/e715abfb
Branch: refs/heads/feature/GEODE-3109
Commit: e715abfb9fc12857c634875a1b9898c098e8642b
Parents: 1e3cc13
Author: Karen Miller <[email protected]>
Authored: Mon Jul 3 09:34:23 2017 -0700
Committer: Karen Miller <[email protected]>
Committed: Wed Jul 5 09:58:49 2017 -0700
----------------------------------------------------------------------
.../source/subnavs/geode-subnav.erb | 3 ++
.../gfsh/command-pages/destroy.html.md.erb | 48 ++++++++++++++++++++
.../gfsh/quick_ref_commands_by_area.html.md.erb | 1 +
3 files changed, 52 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/geode/blob/e715abfb/geode-book/master_middleman/source/subnavs/geode-subnav.erb
----------------------------------------------------------------------
diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index 37c0b83..52e31a7 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -1918,6 +1918,9 @@ gfsh</a>
<a
href="/docs/guide/12/tools_modules/gfsh/command-pages/destroy.html#topic_E48C2DF809054C12A162026D8A2139BB">destroy
function</a>
</li>
<li>
+ <a
href="/docs/guide/12/tools_modules/gfsh/command-pages/destroy.html#destroy-gs">destroy
gateway-sender</a>
+ </li>
+ <li>
<a
href="/docs/guide/12/tools_modules/gfsh/command-pages/destroy.html#topic_D00219CCD6F64C1582A0802AC5CDF3F3">destroy
index</a>
</li>
<li>
http://git-wip-us.apache.org/repos/asf/geode/blob/e715abfb/geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb
b/geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb
index afd78ee..a0834ba 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb
@@ -30,6 +30,10 @@ Delete or unregister functions, remove indexes, disk stores
and regions.
Destroy or unregister a function.
+- **[destroy gateway-sender](#destroy-gs)**
+
+ Destroy a gateway sender.
+
- **[destroy index](#topic_D00219CCD6F64C1582A0802AC5CDF3F3)**
Destroy or remove the specified index.
@@ -108,6 +112,50 @@ destroy function --id=value [--group=value]
[--member=value]
(3) destroy function --id=InterestCalculations --group=Group1
```
+## <a id="destroy-gs" class="no-quick-link"></a>destroy gateway-sender
+
+Destroy a gateway sender that is no longer used by a region.
+
+The default is for the gateway sender to be destroyed on all members.
+
+No region may be attached to the gateway sender to be destroyed.
+If a region is still attached, the system issues an error message
+similar to:
+
+``` pre
+ERROR: The GatewaySender ParallelGatewaySender{id=ln,remoteDsId=2,isRunning
=false}
+could not be destroyed as it is still used by region(s).
+```
+Remove the gateway sender from the region with a command
+similar to:
+
+``` pre
+gfsh>alter region --name=regionA --gateway-sender-id=""
+```
+
+**Availability:** Online. You must be connected in `gfsh` to a JMX Manager
member to use this command.
+
+**Syntax:**
+
+``` pre
+destroy gateway-sender --id=value [--group=value(,value)*]
+ [--member=value(,value)*]
+```
+
+**Parameters, destroy gateway-sender:**
+
+| Name | Description
|
+|------------------------------------------------|--------------------------------------------------------------------------------------------|
+| <span class="keyword parmname">\\-\\-id</span> | *Required.* Unique
gateway sender identifier. Use the `list gateways` command to obtain the ID. |
+| <span class="keyword parmname">\\-\\-group</span> | One or more groups of
members from which this gateway sender will be destroyed. |
+| <span class="keyword parmname">‑‑member</span> | Name or ID of
the member from which this gateway sender will be destroyed. |
+
+**Example Commands:**
+
+``` pre
+destroy gateway-sender --id=SiteASender
+```
+
## <a id="topic_D00219CCD6F64C1582A0802AC5CDF3F3"
class="no-quick-link"></a>destroy index
Destroy or remove the specified index.
http://git-wip-us.apache.org/repos/asf/geode/blob/e715abfb/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
----------------------------------------------------------------------
diff --git
a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
index f707a64..14636d8 100644
--- a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
@@ -189,6 +189,7 @@ limitations under the License.
| [create async-event-queue](command-pages/create.html#topic_ryz_pb1_dk)
| Creates
an asynchronous event queue.
| online |
| [create gateway-receiver](command-pages/create.html#topic_a4x_pb1_dk) |
Creates a gateway receiver on one or more members.
| online |
| [create gateway-sender](command-pages/create.html#topic_hg2_bjz_ck)
| Creates a gateway sender on one or more members.
| online |
+| [destroy gateway-sender](command-pages/destroy.html#destroy-gs)
| Destroys a gateway sender on one or more members.
|
online |
| [list async-event-queues](command-pages/list.html#topic_j22_kzk_2l)
| Display a list of async event queues
for all members.
| online |
| [list
gateways](command-pages/list.html#topic_B1D89671C7B74074899C7D52F15849ED)
| Displays the gateway senders and receivers for a member or
members.
| online |
| [load-balance
gateway-sender](command-pages/load-balance.html#concept_fn2_qls_5q)
| Causes the specified gateway sender to close its current
connections and reconnect to remote gateway receivers in a more balanced
fashion. | online |
