This topic describes the stop command in gfsh, the VMware Tanzu GemFire command-line interface.

Use this command to stop gateway receivers, gateway senders, locators, and servers.

stop gateway-receiver

Stop the gateway receiver on a member or members.

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

Syntax:

stop gateway-receiver [--groups=value(,value)*] [--members=value(,value)*]

Name Description
‑‑groups Groups of members on which to stop the Gateway Receiver. Use a comma-separated list for multiple member groups.
‑‑members Name/Id of the members on which to stop the Gateway Receiver.

Table 1. Stop Gateway-Receiver Parameters

Example Commands:

stop gateway-receiver --members=receiver1-LN 
stop gateway-receiver --groups=LN-Group1

Sample Output:

gfsh>stop gateway-receiver
      Member                | Result | Message
--------------------------- | -------| -----------------------------------------------------------------------
pc13(2266)<v6>:56852        | OK     | GatewayReceiver is stopped on member pc13(2266)<v6>:56852
pc13(Manager:2242)<v5>:57631| Error  | GatewayReceiver is not available on member pc13(Manager:2242)<v5>:57631
pc13(2275)<v7>:47480        | OK     | GatewayReceiver is stopped on member pc13(2275)<v7>:47480
pc13(2293)<v8>:55472        | OK     | GatewayReceiver is stopped on member pc13(2293)<v8>:55472

gfsh>stop gateway-receiver --members=pc13(2266)<v14>:36579
GatewayReceiver is stopped on member pc13(2266)<v14>:36579

gfsh>stop gateway-receiver --groups=RG1
         Member      | Result | Message
-------------------- | -------| ----------------------------------------------------------
pc13(2275)<v23>:27484| OK     | GatewayReceiver is stopped on member pc13(2275)<v23>:27484
pc13(2293)<v24>:55810| OK     | GatewayReceiver is stopped on member pc13(2293)<v24>:55810
pc13(2266)<v22>:4522 | OK     | GatewayReceiver is stopped on member pc13(2266)<v22>:4522

stop gateway-sender

Stop a gateway sender with a given id on a specified member or members of a specified member group.

CAUTION: Use caution with the stop gateway-sender command (or equivalent GatewaySender.stop() API) on parallel gateway senders. Instead of stopping an individual parallel gateway sender on a member, we recommend shutting down the entire member to ensure that proper failover of partition region events to other gateway sender members. Using this command on an individual parallel gateway sender can occur in event loss. See Stopping Gateway Senders for more details.

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

Syntax:

stop gateway-sender --id=value [--groups=value(,value)*] [--members=value(,value)*]

Name Description
‑‑id Required. ID of the Gateway Sender.
‑‑groups Groups of members on which to stop the Gateway Sender.
‑‑members Name/Id of the members on which to stop the Gateway Sender.

Table 2. Stop Gateway-Sender Parameters

Example Commands:

stop gateway-sender --id=ln --members=server1

Sample Output:

gfsh>stop gateway-sender --id=ln
Member                       | Result | Message
---------------------------- | ------ | ------------------------------------------------------------------------
pc13(5184)<v7>:41914         | OK     | GatewaySender ln is stopped on member pc13(5184)<v7>:41914
pc13(5192)<v8>:25704         | OK     | GatewaySender ln is stopped on member pc13(5192)<v8>:25704
pc13(5174)<v6>:53996         | OK     | GatewaySender ln is stopped on member pc13(5174)<v6>:53996
pc13(Manager:5148)<v5>:64040 | Error  | GatewaySender ln is not available on member pc13(Manager:5148)<v5>:64040

gfsh>stop gateway-sender --id=ln --members=pc13(5174)<v14>:17819
GatewaySender ln is stopped on member pc13(5174)<v14>:17819

gfsh>stop gateway-sender --id=ln --groups=SenderGroup1

Member                | Result | Message
--------------------- | ------ | -----------------------------------------------------------
pc13(5174)<v18>:63332 | OK     | GatewaySender ln is stopped on member pc13(5174)<v18>:63332
pc13(5184)<v19>:20055 | OK     | GatewaySender ln is stopped on member pc13(5184)<v19>:20055
pc13(5192)<v20>:14622 | OK     | GatewaySender ln is stopped on member pc13(5192)<v20>:14622

stop locator

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:

stop locator --name=value | --dir=value

Name Description Default Value
‑‑name The Tanzu GemFire 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.
‑‑dir Directory in which the locator was started. current directory

Table 3. Stop Locator Parameters

Example Commands:

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].

stop server

Stop a Tanzu GemFire cache server.

Availability: Online or offline. If you want to stop a cache server while you are offline, use the --dir option.

Syntax:

stop server [--name=value] [--dir=value]

Name Description Default Value
‑‑name Name/Id of the Tanzu GemFire Cache Server to stop. You must be connected to the JMX Manager to use this option. Can be used to stop remote servers. See Using gfsh to Manage a Remote Cluster Over HTTP or HTTPS.  
‑‑dir Directory in which the Tanzu GemFire Cache Server was started. current directory

Table 4. Stop Server Parameters

Example Commands:

stop server --name=server1
stop server --dir=server1
check-circle-line exclamation-circle-line close-line
Scroll to top icon