This topic links to help and usage documentation for VMware Tanzu GemFire command-line interface (gfsh
) commands. Each topic provides additional information about the command, including syntax, a list of options, and examples.
Modify an existing Tanzu GemFire resource.
Back up persistent data from all members to the specified directory.
Changes the logging level on specified members.
Clears all the defined indexes.
Close durable client CQs and durable clients.
Compact online and offline disk-stores.
Configure Portable Data eXchange for all the caches in the cluster.
Connect to a jmx-manager either directly or via a locator.
Create async-event-queues, disk-stores, gateway receivers, gateway senders, indexes, and regions.
Activate or deactivate debugging output in gfsh
.
Define an index that can be used when executing queries. Then, you can execute a single command to create multiple indexes all at once using create defined indexes
.
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: *
, !
, #
, @
, ?
.
deregister driver
Deregister a driver with the cluster’s Driver Manager using the name of a driver class contained within a currently deployed jar.
Display details of a member’s configuration, shell connection, disk-stores, members, or regions.
Delete or unregister functions, remove indexes, disk stores, and regions.
Close any active connections.
Echo the given text, which may include system and user variables.
Execute functions on members or regions.
Exit the gfsh
shell. You can also use quit
to exit the shell.
Export configurations, data, logs and stack-traces.
Force GC (Garbage Collection) on a member or members.
Display an entry in a region.
Display syntax and usage information for all the available commands.
Display information about topics and a list of commands associated with a topic.
Show or save the command history.
You can import data into a region or import an existing cluster configuration into the cluster.
List existing Tanzu GemFire resources such as deployed applications, disk-stores, functions, members, servers, and regions.
Causes the specified gateway sender to close its current connections and reconnect to remote gateway receivers in a more balanced fashion.
Locate a region entry on a member.
Report network information and statistics via the “netstat” operating system command.
Pause a gateway sender.
Renames PDX types in an offline disk store.
Add or update a region entry.
Run queries against Tanzu GemFire regions.
Rebalance partitioned regions.
register driver
Register a driver with the cluster’s Driver Manager using the name of a driver class contained within a currently deployed jar.
Remove an entry from a region.
Restore redundancy to partitioned regions and optionally reassign which members host the primary copies.
Resume a paused asynch event dispatcher or gateway sender.
Instruct the members of a distributed system to stop waiting for a disk store to be available.
Execute a set of GFSH commands.
Set variables in the GFSH environment.
Execute operating system commands.
Display deadlocks, logs, metrics and missing disk-stores.
Stop all members.
Delay gfsh
command execution.
Start servers, locators, gateway senders and gateway receivers, and monitoring tools.
Check the status of the cluster configuration service and Tanzu GemFire member processes, including locators, gateway receivers, gateway senders, and servers.
Stop gateway receivers, gateway senders, locators and servers.
Undeploy the JAR files that were deployed on members or groups using deploy
command.
Validate offline disk stores.
Display product version information.
Copy the data of a region from a WAN site to the same region on another WAN site by using a gateway sender.