Skip to content

Commit

Permalink
GEODE-6809 Document the gfsh destroy gateway-receiver command (apache…
Browse files Browse the repository at this point in the history
  • Loading branch information
karensmolermiller authored May 29, 2019
1 parent b2928c9 commit 23fdac1
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
3 changes: 3 additions & 0 deletions geode-book/master_middleman/source/subnavs/geode-subnav.erb
Original file line number Diff line number Diff line change
Expand Up @@ -1762,6 +1762,9 @@ gfsh</a>
<li>
<a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/destroy.html#topic_E48C2DF809054C12A162026D8A2139BB">destroy function</a>
</li>
<li>
<a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/destroy.html#destroy-gr">destroy gateway-receiver</a>
</li>
<li>
<a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/destroy.html#destroy-gs">destroy gateway-sender</a>
</li>
Expand Down
32 changes: 32 additions & 0 deletions geode-docs/tools_modules/gfsh/command-pages/destroy.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ Delete or unregister functions, remove indexes, disk stores and regions.

Destroy or unregister a function.

- **[destroy gateway-receiver](#destroy-gr)**

Destroy a gateway receiver.

- **[destroy gateway-sender](#destroy-gs)**

Destroy a gateway sender.
Expand Down Expand Up @@ -147,6 +151,34 @@ destroy function --id=value [--groups=value(,value)*] [--member=value]
(2) destroy function --id=InterestCalculations --member=server1
(3) destroy function --id=InterestCalculations --group=Group1
```
## <a id="destroy-gr" class="no-quick-link"></a>destroy gateway-receiver

Destroy the gateway receiver on one or more members.
Since there can be only one gateway receiver per member,
specifying the member specifies which gateway receiver to destroy.

**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command.

**Syntax:**

``` pre
destroy gateway-receiver [--group=value(,value)*]
[--member=value(,value)*] [--if-exists(=value)?]
```

**Parameters, destroy gateway-receiver:**

| Name | Description |
|------------------------------------------------|--------------------------------------------------------------------------------------------|
| <span class="keyword parmname">\\-\\-group</span> | One or more groups of members on which the gateway receiver will be destroyed. |
| <span class="keyword parmname">&#8209;&#8209;members</span> | Name or ID of each member on which the gateway receiver will be destroyed. |
| &#8209;&#8209;if&#8209;exists | If this option is true and the gateway receiver does not exist, gfsh responds with a message prefixed with the label "Skipping: ". If this option is false and the gateway receiver does not exist, an error message is output. Default (if this option is not specified): false. Default (if this option is specified without a value): true. |

**Example Commands:**

``` pre
destroy gateway-receiver --member=server1,server2
```

## <a id="destroy-gs" class="no-quick-link"></a>destroy gateway-sender

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ This section provides help and usage information on all `gfsh` commands, listed
- **[destroy](../../tools_modules/gfsh/command-pages/destroy.html)**
Delete or unregister functions, remove indexes, disk stores and regions.
Delete or unregister functions, remove indexes, gateway senders, gateway receivers, disk stores and regions.
- **[disconnect](../../tools_modules/gfsh/command-pages/disconnect.html)**
Expand Down

0 comments on commit 23fdac1

Please sign in to comment.