Menu Close
Settings Close

Language and Page Formatting Options

Chapter 17. Reference

17.1. Data Grid Server 8.3.1 Readme

Information about Data Grid Server 13.0.10.Final-redhat-00001 distribution.

17.1.1. Requirements

Data Grid Server requires JDK 11 or later.

17.1.2. Starting servers

Use the server script to run Data Grid Server instances.

Unix / Linux





Include the --help or -h option to view command arguments.

17.1.3. Stopping servers

Use the shutdown command with the CLI to perform a graceful shutdown.

Alternatively, enter Ctrl-C from the terminal to interrupt the server process or kill it via the TERM signal.

17.1.4. Configuration

Server configuration extends Data Grid configuration with the following server-specific elements:

Defines cache containers for managing cache lifecycles.
Enables and configures endpoint connectors for client protocols.
Configures endpoint security realms.
Maps endpoint connectors to interfaces and ports.

The default configuration file is $RHDG_HOME/server/conf/infinispan.xml.

Use different configuration files with the -c argument, as in the following example that starts a server without clustering capabilities:

Unix / Linux

$RHDG_HOME/bin/ -c infinispan-local.xml


$RHDG_HOME\bin\server.bat -c infinispan-local.xml

17.1.5. Bind address

Data Grid Server binds to the loopback IP address localhost on your network by default.

Use the -b argument to set a different IP address, as in the following example that binds to all network interfaces:

Unix / Linux

$RHDG_HOME/bin/ -b


$RHDG_HOME\bin\server.bat -b

17.1.6. Bind port

Data Grid Server listens on port 11222 by default.

Use the -p argument to set an alternative port:

Unix / Linux

$RHDG_HOME/bin/ -p 30000


$RHDG_HOME\bin\server.bat -p 30000

17.1.7. Clustering address

Data Grid Server configuration defines cluster transport so multiple instances on the same network discover each other and automatically form clusters.

Use the -k argument to change the IP address for cluster traffic:

Unix / Linux

$RHDG_HOME/bin/ -k


$RHDG_HOME\bin\server.bat -k

17.1.8. Cluster stacks

JGroups stacks configure the protocols for cluster transport. Data Grid Server uses the tcp stack by default.

Use alternative cluster stacks with the -j argument, as in the following example that uses UDP for cluster transport:

Unix / Linux

$RHDG_HOME/bin/ -j udp


$RHDG_HOME\bin\server.bat -j udp

17.1.9. Authentication

Data Grid Server requires authentication.

Create a username and password with the CLI as follows:

Unix / Linux

$RHDG_HOME/bin/ user create username -p "qwer1234!"


$RHDG_HOME\bin\cli.bat user create username -p "qwer1234!"

17.1.10. Server home directory

Data Grid Server uses infinispan.server.home.path to locate the contents of the server distribution on the host filesystem.

The server home directory, referred to as $RHDG_HOME, contains the following folders:

├── bin
├── boot
├── docs
├── lib
├── server
└── static


Contains scripts to start servers and CLI.


Contains JAR files to boot servers.


Provides configuration examples, schemas, component licenses, and other resources.


Contains JAR files that servers require internally.
Do not place custom JAR files in this folder.


Provides a root folder for Data Grid Server instances.


Contains static resources for Data Grid Console.

17.1.11. Server root directory

Data Grid Server uses infinispan.server.root.path to locate configuration files and data for Data Grid Server instances.

You can create multiple server root folders in the same directory or in different directories and then specify the locations with the -s or --server-root argument, as in the following example:

Unix / Linux

$RHDG_HOME/bin/ -s server2


$RHDG_HOME\bin\server.bat -s server2

Each server root directory contains the following folders:

├── server
│   ├── conf
│   ├── data
│   ├── lib
│   └── log
FolderDescriptionSystem property override


Contains server configuration files.



Contains data files organized by container name.


Contains server extension files.
This directory is scanned recursively and used as a classpath.

Separate multiple paths with the following delimiters:
: on Unix / Linux
; on Windows


Contains server log files.


17.1.12. Logging

Configure Data Grid Server logging with the log4j2.xml file in the server/conf folder.

Use the --logging-config=<path_to_logfile> argument to use custom paths, as follows:

Unix / Linux

$RHDG_HOME/bin/ --logging-config=/path/to/log4j2.xml


To ensure custom paths take effect, do not use the ~ shortcut.


$RHDG_HOME\bin\server.bat --logging-config=path\to\log4j2.xml