gfsh Command Help

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.

• alter

  Modify an existing Tanzu GemFire resource.

• backup disk-store

  Back up persistent data from all members to the specified directory.

• cancel

  Cancel a currently executing query.

• change loglevel

  Changes the logging level on specified members.

• clear defined indexes

  Clears all the defined indexes.

• close

  Close durable client CQs and durable clients.

• compact

  Compact online and offline disk-stores.

• configure

  Configure Portable Data eXchange for all the caches in the cluster.

• connect

  Connect to a jmx-manager either directly or via a locator.

• create

  Create async-event-queues, disk-stores, gateway receivers, gateway senders, indexes, and regions.

• debug

  Activate or deactivate debugging output in gfsh.

• define index

  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

  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.

• describe

  Display details of a member’s configuration, shell connection, disk-stores, members, or regions.

• destroy

  Delete or unregister functions, remove indexes, disk stores, and regions.

• disconnect

  Close any active connections.

• echo

  Echo the given text, which may include system and user variables.

• execute function

  Execute functions on members or regions.

• exit

  Exit the gfsh shell. You can also use quit to exit the shell.

• export

  Export configurations, data, logs and stack-traces.

• gc

  Force GC (Garbage Collection) on a member or members.

• get

  Display an entry in a region.

• help

  Display syntax and usage information for all the available commands.

• hint

  Display information about topics and a list of commands associated with a topic.

• history

  Show or save the command history.

• import

  You can import data into a region or import an existing cluster configuration into the cluster.

• list

  List existing Tanzu GemFire resources such as deployed applications, disk-stores, functions, members, servers, and regions.

• load-balance gateway-sender

  Causes the specified gateway sender to close its current connections and reconnect to remote gateway receivers in a more balanced fashion.

• locate entry

  Locate a region entry on a member.

• netstat

  Report network information and statistics via the “netstat” operating system command.

• pause gateway-sender

  Pause a gateway sender.

• pdx rename

  Renames PDX types in an offline disk store.

• put

  Add or update a region entry.

• query

  Run queries against Tanzu GemFire regions.

• rebalance

  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

  Remove an entry from a region.

• restore redundancy

  Restore redundancy to partitioned regions and optionally reassign which members host the primary copies.

• resume

  Resume a paused asynch event dispatcher or gateway sender.

• revoke missing-disk-store

  Instruct the members of a distributed system to stop waiting for a disk store to be available.

• run

  Execute a set of GFSH commands.

• set variable

  Set variables in the GFSH environment.

• sh

  Execute operating system commands.

• show

  Display deadlocks, logs, metrics and missing disk-stores.

• shutdown

  Stop all members.

• sleep

  Delay gfsh command execution.

• start

  Start servers, locators, gateway senders and gateway receivers, and monitoring tools.

• status

  Check the status of the cluster configuration service and Tanzu GemFire member processes, including locators, gateway receivers, gateway senders, and servers.

• stop

  Stop gateway receivers, gateway senders, locators and servers.

• undeploy

  Undeploy the JAR files that were deployed on members or groups using deploy command.

• upgrade

  Upgrade offline disk stores from the format used in GemFire releases prior to 10.1 to the segmented disk store type introduced in GemFire version 10.1.

• validate offline-disk-store

  Validate offline disk stores.

• version

  Display product version information.

• wan-copy region

  Copy the data of a region from a WAN site to the same region on another WAN site by using a gateway sender.