title: Basic VMware Tanzu GemFire gfsh Commands by Functional Area

This topic lists basic VMware Tanzu GemFire command-line interface (gfsh) commands, sorted into functional areas.

Command Description Availability
debug Activate or deactivate debugging output in gfsh. online, offline
echo Echo the given text, which may include system and user variables. online, offline
exit Exit the gfsh shell. You can also use quit to exit the shell. online, offline
help If the argument is a gfsh command, displays syntax and usage information for the command. If there are no arguments, displays a list of all available commands. online, offline
hint Display information about topics and a list of commands associated with a topic. online, offline
history Show or save the command history. online, offline
run Execute a set of gfsh commands. online, offline
set variable Set variables in the gfsh environment. online, offline
sh Execute operating system (OS) commands. offline, online
sleep Delay gfsh command execution. online, offline
version Display product version information. online, offline

Configuration Commands

Command Description Availability
alter runtime Alter configuration properties for a specific member or members while the member or members are running. online
change loglevel Change the logging level on specified servers. online
configure pdx Alter cluster-wide PDX configuration settings for all caches.
Note: This command must be run before starting data members in order to enforce configuration settings.
online
describe config Display the configuration of a member. online
export config Export configurations, data, logs and stack-traces. online
export cluster-configuration Export a shared configuration ZIP file that contains cache.xml files, gemfire.properties files and JAR files needed to configure and operate a GemFire cluster. online
import cluster-configuration Import an exported configuration. online
status cluster-config-service Report on the status of the cluster configuration server. online

Data Commands

Command Description Availability
export data Export user data from a region to a file. online
get Display an entry in a region. online
import data Import user data from a file to a region. online
locate entry Locate a region entry on a member. online
put Add or update a region entry. online
query Run queries against GemFire regions. online
remove Remove an entry from a region. online
wan-copy region Copy the entries of a region in a WAN site onto the same region in another WAN site, using a gateway sender. online

Deployment Commands

Command Description Availability
deploy Deploy JAR-packaged applications to a member or members. Note: When deploying a JAR, the name of the JAR cannot contain any of the following characters: *, !, #, @, ?. online
list deployed Display a list of JARs that were deployed to members using the deploy command. online
undeploy Undeploy the JAR files that were deployed on members or groups using the deploy command. online

Disk Store Commands

Command Description Availability
alter disk-store Modify an existing GemFire resource. online
backup disk-store Back up persistent data from all members to the specified directory. online
compact disk-store Compact an online disk store on all members with that disk store. online
compact offline-disk-store Compact an offline disk store. online, offline
create disk-store Define a pool of one or more disk stores, which can be used by regions and client subscription queues. online
describe disk-store Display information about a member’s disk store. online
describe offline-disk-store Display information about an offline member’s disk store online, offline
destroy disk-store Delete a disk store and all files on disk used by the disk store. Data for closed regions that previously used this disk store is lost. online
list disk-stores List all available disk stores in a GemFire cluster. online
revoke missing-disk-store Instruct the members of a distributed system to stop waiting for a disk store to be available. online
show missing-disk-stores Display a summary of the disk stores that are currently missing from a distributed system. online
upgrade offline-disk-store Upgrade offline disk-stores used in GemFire 6.5 or 6.6 installations to a format that is compatible with GemFire or GemFire 7.0 or higher. offline
validate offline-disk-store Validate offline disk stores. online, offline

Durable CQ and Client Commands

Command Description Availability
list durable-cqs List durable client CQs associated with the specified durable client id. online
close durable-cq Close the durable CQ registered by the durable client and drain events held for the durable CQ from the subscription queue. online
close durable-client Attempt to close the durable client. The client must be disconnected. online
show subscription-queue-size Show the number of events in the subscription queue. If a CQ name is provided, count the number of events in the subscription queue for the specified CQ. online

Function Execution Commands

Command Description Availability
destroy function Destroy or unregister a function. The default is for the function to be unregistered from all members. online
execute function Execute the function with the specified ID. By default, executes on all members. online
list functions Display a list of registered functions. The default is to display functions for all members. online

Gateway (WAN) Commands

Command Description Availability
alter async-event-queue Alter attributes of a specified asynchronous event queue. online
create async-event-queue Create an asynchronous event queue. online
create gateway-receiver Create a gateway receiver on one or more members. online
create gateway-sender Create a gateway sender on one or more members. online
destroy async-event-queue Destroy an asynchronous event queue on one or more members. online
destroy gateway-sender Destroy a gateway sender on one or more members. online
list async-event-queues Display a list of async event queues for all members. online
list gateways Display the gateway senders and receivers for a member or members. online
load-balance gateway-sender Cause the specified gateway sender to close its current connections and reconnect to remote gateway receivers in a more balanced fashion. online
pause gateway-sender Pause a gateway sender. online
resume async-event-queue-dispatcher Resume dispatching of events on a specified asynchronous event queue which is currently paused. online
resume gateway-sender Resume any gateway senders that you have paused. online
start gateway-receiver Start a gateway receiver on a given member or group of members. online
start gateway-sender Start a gateway sender on a member or members. online
status gateway-receiver Display the status of the specified gateway receiver. online
status gateway-sender Display the status of the specified gateway sender. online
stop gateway-receiver Stop a gateway receiver on a member or members. online
stop gateway-sender Stop a gateway sender with a given id on a specified member or members of a specified member group. online

GemFire AsyncEventQueue Commands

Command Description Availability
alter async-event-queue Alter attributes of a specified asynchronous event queue. online
create async-event-queue Create an asynchronous event queue. online
destroy async-event-queue Destroy an asynchronous event queue on one or more members. online
list async-event-queues Display a list of async event queues for all members. online
resume async-event-queue-dispatcher Resume dispatching of events on a specified asynchronous event queue which is currently in a paused state. online

GemFire Monitoring Commands

Command Description Availability
describe client Display details about a specified client. online
describe member Display details of a member with given name/id. online
export logs Export/dump logs to a given directory. online
export stack-traces Export the stack trace for a member or members. online
gc Force garbage collection on a member or members. online
list clients Display a list of connected clients. online
list members Display all or a subset of members. online
netstat Report network information and statistics via the “netstat” operating system command. online
show dead-locks Display deadlocks, logs, metrics and missing disk-stores. online
show log Display the log for a member. online
show metrics Display or export metrics for the entire distributed system, a member or a region. online
shutdown Shut down all members that have a cache. online
start jconsole Start the JDK JConsole monitoring application in a separate process. JConsole automatically connects to a running JMX Manager node if one is available online, offline
start jvisualvm Start the JDK’s Java VisualVM monitoring application in a separate process. online, offline
start pulse Launch the GemFire Pulse monitoring dashboard tool in the user’s default system browser. online, offline
start vsd Launch GemFire Visual Statistics Display (VSD) in a separate process. online, offline

Index Commands

Command Description Availability
clear defined indexes Clear all the defined indexes. online, offline
create defined indexes Create all the defined indexes. online
create index Create an index that can be used when executing queries. online
define index Define an index that can be used when executing queries. Then you can create multiple indexes all at once. online, offline
destroy index Destroy or remove the specified index. online
list indexes Display the list of indexes created for all members. online

JMX Connection Commands

Command Description Availability
connect Connect to a jmx-manager either directly or via a locator. offline
describe connection Display connection information details. online, offline
disconnect Close any active connections. online

Locator Commands

Command Description Availability
start locator Start a locator. The command creates a subdirectory and log file named after the locator. If the locator detects that no other JMX Manager exists, then the locator automatically starts an embedded JMX Manager and connects the current gfsh session to the JMX Manager. online, offline
status locator Displays the status of the specified locator. online, offline
stop locator Stop a locator. online, offline

PDX Commands

Command Description Availability
configure pdx Configure Portable Data eXchange for all the caches in the cluster. online, offline
pdx rename Rename PDX types in an offline disk store. online, offline

Region Commands

Command Description Availability
alter region Alter the configuration of a region. online
create region Create and configure a region. online
describe region Display the attributes and key information of a region. online
destroy region Destroy or remove a region. online
list regions Display regions of a member or members. If no parameter is specified, all regions in the GemFire distributed system are listed. online
rebalance Rebalance partitioned regions. online
restore redundancy Restore redundancy to partitioned regions and optionally reassign which members host the primary copies. online
status redundancy Display the redundancy status of partitioned regions. online

Server Commands

Command Description Availability
start server Start a GemFire cache server process. online, offline
status server Display the status of the specified GemFire cache server. online, offline
stop server Stop a GemFire cache server. online, offline
check-circle-line exclamation-circle-line close-line
Scroll to top icon