Running Geode Server Processes

A Geode server is a process that runs as a long-lived, configurable member of a client/server system.

The Geode server is used primarily for hosting long-lived data regions and for running standard Geode processes such as the server in a client/server configuration. You can start and stop servers using the following methods:

  • The gfsh tool allows you to manage Geode server processes from the command line.
  • You can also start, stop and manage the Geode servers through the org.apache.geode.distributed.ServerLauncher API. The ServerLauncher API can only be used for Geode Servers that were started with gfsh or with the ServerLauncher class itself. See the JavaDocs for additional specifics on using the ServerLauncher API.

Default Server Configuration and Log Files

The gfsh utility uses a working directory for its configuration files and log files. These are the defaults and configuration options:

  • When you start a standalone server using gfsh, gfsh will automatically load the required JAR files $GEMFIRE/lib/server-dependencies.jar and $JAVA_HOME/lib/tools.jar into the CLASSPATH of the JVM process. If you start a standalone server using the ServerLauncher API, you must specify $GEMFIRE/lib/server-dependencies.jar inside your command to launch the process. For more information on CLASSPATH settings in Geode, see Setting Up the CLASSPATH.
  • Servers are configured like any other Geode process, with and shared cluster configuration files. It is not programmable except through application plug-ins. Typically, you provide the file and the file (if you are using a separate, restricted access security settings file). You can also specify a cache.xml file in the cache server’s working directory.
  • By default, a new server started with gfsh receives its initial cache configuration from the cluster configuration service, assuming the locator is running the cluster configuration service. If you specify a group when starting the server, the server also receives configurations that apply to a group. The shared configuration consists of cache.xml files, files, and deployed jar files. You can disable use of the cluster configuration service by specifying --use-cluster-configuration=false when starting the server using gfsh.

    See Overview of the Cluster Configuration Service.

  • If you are using the Spring Framework, you can specify a Spring ApplicationContext XML file when starting up your server in gfsh by using the --spring-xml-location command-line option. This option allows you to bootstrap your Geode server process with your Spring application’s configuration. See Spring documentation for more information on this file.

  • For logging output, log file output defaults to server_name.log in the cache server’s working directory. If you restart a server with the same server name, the existing server_name.log file is automatically renamed for you (for example, server1-01-01.log or server1-02-01.log). You can modify the level of logging details in this file by specifying a level in the --log-level argument when starting up the server.

  • By default, the server will start in a subdirectory (named after the server’s specified --name) under the directory where gfsh is executed. This subdirectory is considered the current working directory. You can also specify a different working directory when starting the cache server in gfsh.

  • By default, a server process that has been shutdown and disconnected due to a network partition event or member unresponsiveness will restart itself and automatically try to reconnect to the existing distributed system. See Handling Forced Cache Disconnection Using Autoreconnect for more details.

  • You can pass JVM parameters to the server’s JVM by using the upon server startup. These parameters can be Java properties or Geode configuration properties such as gemfire.jmx-manager. For example:

    gfsh>start server --name=server1 --J=-Dgemfire.jmx-manager=true \
    --J=-Dgemfire.jmx-manager-start=true --J=-Dgemfire.http-port=8080
  • We recommend that you do not use the -XX:+UseCompressedStrings and -XX:+UseStringCache JVM configuration properties when starting up servers. These JVM options can cause issues with data corruption and compatibility.

Start the Server

The startup syntax for Geode servers in gfsh is:

start server --name=value [--assign-buckets(=value)] [--bind-address=value]
    [--cache-xml-file=value] [--classpath=value] [--disable-default-server(=value)]
    [--disable-exit-when-out-of-memory(=value)] [--enable-time-statistics(=value)]
    [--force(=value)] [--include-system-classpath(=value)] [--properties-file=value]
    [--group=value] [--locators=value] [--locator-wait-time=value] [--log-level=value]
    [--mcast-address=value] [--mcast-port=value] [--memcached-port=value]
    [--memcached-protocol=value] [--rebalance(=value)] [--server-bind-address=value]
    [--server-port=value] [--spring-xml-location=value]
    [--statistic-archive-file=value] [--dir=value] [--initial-heap=value]
    [--max-heap=value] [--use-cluster-configuration(=value)] [--J=value(,value)*]
    [--critical-heap-percentage=value] [--critical-off-heap-percentage=value] 
    [--eviction-heap-percentage=value] [--eviction-off-heap-percentage=value]
    [--hostname-for-clients=value] [--max-connections=value]
    [--message-time-to-live=value] [--max-message-count=value] [--max-threads=value]
    [--socket-buffer-size=value] [--lock-memory=value] [--off-heap-memory-size=value] 

Note: When both --max-heap and --initial-heap are specified during server startup, additional GC parameters are specified internally by Geode’s Resource Manager. If you do not want the additional default GC properties set by the Resource Manager, then use the -Xms & -Xmx JVM options. See Controlling Heap Use with the Resource Manager for more information.

The following gfsh start server start sequences specify a cache.xml file for cache configuration, and use different incoming client connection ports:

gfsh>start server --name=server1 --mcast-port=10338 \
--cache-xml-file=../ServerConfigs/cache.xml --server-port=40404

gfsh>start server --name=server2 --mcast-port=10338 \
--cache-xml-file=../ServerConfigs/cache.xml --server-port=40405

Here is a portion of a file that sets the location of acache.xml file for the server and sets the mcast-port:


To start the server using this file, enter:

gfsh>start server --name=server1 \

To start a server with an embedded JMX Manager, you can enter the following command:

gfsh>start server --name=server2 \
--J=-Dgemfire.jmx-manager=true --J=-Dgemfire.jmx-manager-start=true

To start a server and provide JVM configuration settings, you can issue a command like the following:

gfsh>start server --name=server3 \
--J=-Xms80m,-Xmx80m --J=-XX:+UseConcMarkSweepGC,-XX:CMSInitiatingOccupancyFraction=65

Start the Server Programmatically

Use org.apache.geode.distributed.ServerLauncher API to start the cache server process inside your code. Use the ServerLauncher.Builder class to construct an instance of the ServerLauncher, and then use the start() method to start the server service. The other methods in the ServerLauncher class provide status information about the server and allow you to stop the server.

import org.apache.geode.distributed.ServerLauncher;

 public class MyEmbeddedServer {

    public static void main(String[] args){
        ServerLauncher serverLauncher  = new ServerLauncher.Builder()
          .set("jmx-manager", "true")
          .set("jmx-manager-start", "true")


          System.out.println("Cache server successfully started");

Check Server Status

If you are connected to the distributed system in gfsh, you can check the status of a running cache server by providing the server name. For example:

gfsh>status server --name=server1

If you are not connected to a distributed system, you can check the status of a local cache server by providing the process ID or the server’s current working directory. For example:

gfsh>status server --pid=2484


% gfsh status server --dir=<server_working_directory>

where <server_working_directory> corresponds to the local working directory where the cache server is running.

If successful, the command returns the following information (with the JVM arguments that were provided at startup):

% gfsh status server --dir=server4
Server in /home/user/server4 on ubuntu.local[40404] as server4 is currently online.
Process ID: 3324
Uptime: 1 minute 5 seconds
GemFire Version: 8.0.0
Java Version: 1.7.0_65
Log File: /home/user/server4/server4.log
JVM Arguments: 

Stop Server

If you are connected to the distributed system in gfsh, you can stop a running cache server by providing the server name. For example:

gfsh>stop server --name=server1

If you are not connected to a distributed system, you can stop a local cache server by specify the server’s current working directory or the process ID. For example:

gfsh>stop server --pid=2484


gfsh>stop server --dir=<server_working_directory>

where <server_working_directory> corresponds to the local working directory where the cache server is running.

You can also use the gfsh shutdown command to shut down all cache servers in an orderly fashion. This is useful if you are using persistent regions. See Starting Up and Shutting Down Your System for more details.