Apache Geode

gfsh

gfsh (pronounced “jee-fish”) provides a single, powerful command-line interface from which you can launch, manage, and monitor Geode processes, data, and applications.

• What You Can Do with gfsh

  gfsh supports the administration, debugging, and deployment of Apache Geode processes and applications.

• Starting gfsh

  Before you start gfsh, confirm that you have set JAVA_HOME and that your PATH variable includes the gfsh executable.

• Configuring the gfsh Environment

  The gfsh.bat and gfsh bash script automatically append the required Apache Geode and JDK .jar libraries to your existing CLASSPATH. There are user-configurable properties you can set for security, environment variables, logging, and troubleshooting.

• Useful gfsh Shell Variables

  You can use the built-in gfsh shell variables in scripts.

• Basic Shell Features and Command-Line Usage

  The gfsh utility provides useful features for a shell environment, including command auto-complete, preserved command history, and delimiting of multi-line commands. Context-sensitive help is available by command and by topic.

• Specifying JSON within Command-Line Options

  Some gfsh commands allow JSON specifications within command-line options.

• Tutorial—Performing Common Tasks with gfsh

  This topic takes you through a typical sequence of tasks that you execute after starting gfsh.

• Quick Reference of gfsh Commands by Functional Area

  This quick reference sorts all commands into functional areas.

• gfsh Command Help

  This section provides help and usage information on all gfsh commands, listed alphabetically.

• Creating and Running gfsh Command Scripts

  gfsh offers several ways to run commands in a scripting environment.

• Running gfsh Commands on the OS Command Line

• Mapping of cache.xml Elements to gfsh Configuration Commands.

  You can configure a Geode cluster using either cache.xml files, or you can use gfsh and the cluster configuration service to configure a cluster. This section maps cache.xml elements to the gfsh commands that configure and manage a cluster.