describe

This topic describes the describe command in gfsh, the VMware Tanzu GemFire command-line interface.

Use this command to display details of a member’s configuration, shell connection, disk-stores, members, or regions.

describe async-event-queue

Displays the details of the asynchronous event queue created in the cluster members.
describe client

Displays details about a specified client.
describe config

Display the configuration of a member.
describe connection

Display connection information details.
describe disk-store

Display information about a member’s disk store.
describe gateway-receiver

Display details about a gateway receiver created in the cluster members.
describe gateway-sender

Display details about a gateway sender created in the cluster members.
describe jndi-binding

Display information about the configuration of a JNDI binding.
describe member

Display details of a member with given name or ID.
describe offline-disk-store

Display information about an offline member’s disk store.
describe query

Display additional details about an executing query.
describe query-service

Display information about the configuration of the query service.
describe region

Display the attributes and key information of a region.

describe async-event-queue

Displays details about an asynchronous event queue created in the cluster members.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe async-event-queue --id=value [--members=value(,value)*] [--groups=value(,value)*]

Parameters, describe async-event-queue:

Name	Description
‑‑id	Required. ID of the asynchronous event queue whose details are to be described.
‑‑member ‑‑members	Optional. [Optional] Name and ID of member or members whose asynchronous event queue details are to be described.
‑‑group ‑‑groups	Optional. Group or groups of members whose asynchronous event queue details are to be described.

Example Commands:

describe async-event-queue --id=queue1
describe async-event-queue --id=queue1 --members=server1
describe async-event-queue --id=queue1 --groups=group1

Output:

Property	Description
Asynchronous event queue ID	The unique identifier associated with the asynchronous event queue.
Hosting members	Members in the cluster which contain the asynchronous event queue.
AEQ Listener class name	Fully-qualified class name of the listeners.
Batch conflation enabled	Whether or not batch conflation is enabled. true: Events in queue are conflated. false: Events in the queue are not conflated.
Batch size	Maximum number of messages in a batch that are sent for processing.
Batch time interval (ms)	Time, in milliseconds, that a member waits before sending a partially-filled batch for processing if there are no incoming events.
Disk synchronous	Whether or not writes to the disk are synchronous. true: Writes to the disk are synchronous. false: Writes to the disk are not synchronous.
Disk Store Name	Name of the disk store associated with the asynchronous event queue.
Forward expiration destroy	Whether or not `destroy` operations from expiration are forwarded to the queue. true: `destroy` operations from expiration are forwarded to the queue. false: `destroy` operations from expirations are not forwarded to the queue.
Gateway event filter class name	Fully-qualified class name of the gateway event filters associated with the queue.
Gateway event substitution filter	Fully-qualified class name of the gateway event substitution filter associated with the queue.
Maximum queue memory (MB)	Maximum memory, in megabytes, for the queue, after which entries overflow to the disk.
Number of dispatcher threads	Number of dispatcher threads working for the queue.
Order policy	Policy followed while dispatching events to the listeners. KEY THREAD PARTITION
Parallel	Whether the queue is parallel or serial. true: Parallel queue. false: Serial queue.
Persistence enabled	Whether or not the queue is configured to be persistent. true: Queue is configured to be persistent. false: Queue is not configured to be persistent.
Regions associated with the async event queue	Regions linked to the asynchronous event queue.
Status	Whether or not the queue is ready for dispatching events to the listener. READY FOR DISPATCHING: Queue is ready to dispatch events to the listener. PAUSED: Queue will not dispatch the events to the listener.
Is primary	Which member is the primary for the asynchronous event queue.

Sample Output:

gfsh>describe async-event-queue --id=queue1

Asynchronous event queue ID : queue1
Hosting members             : server-1,server-3

Properties shared by members:

                  Property                    | Value
--------------------------------------------- | -------------------------------------
AEQ Listener class name                       | MyAsyncEventListener
Batch conflation enabled                      | false
Batch size                                    | 100
Batch time interval (ms)                      | 5
Disk synchronous                              | true
Diskstore name                                | DEFAULT
Forward expiration destroy                    | false
Gateway event filter class name               | TestGatewayEventFilter
Gateway event substitution filter             | StringGatewayEventSubstitutionFilter
Maximum queue memory (MB)                     | 100
Number of dispatcher threads                  | 1
Order policy                                  | KEY
Parallel                                      | false
Persistence enabled                           | false
Regions associated with the async event queue | /region1
                                              | /region2
                                              | /region3
Status                                        | READY FOR DISPATCHING

----------------------------------------------------------------
Member specific properties:

 Member  |  Property  | Value
-------- | ---------- | -----
server-1 | Is primary | true
server-3 | Is primary | false

----------------------------------------------------------------
Members that did not return any information about queue id:queue1
server-2
----------------------------------------------------------------

describe client

Displays details about a specified client.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe client --clientID=value

Parameters, describe client:

Name	Description
‑‑clientID	Required. ID of the client. To find a client ID, you can use the `list clients` command to display a list of connected clients and their IDs.

Example Command:

describe client --clientID=192.0.2.0(4987:loner):58922:7b3398cf

Sample Output:

gfsh>describe client --clientID=192.0.2.0(4987:loner):58922:7b3398cf

-------------------------------------------------------------------
Primary Servers                : 192.0.2.0(server1:5764)<v1>:15189
Secondary Servers              : 192.0.2.0(server2:5891)<v2>:39082
CPU                            : 0
Number of Cache Listener Calls : 0
Number of Gets                 : 0
Number of Misses               : 0
Number of Puts                 : 0
Number of Threads              : 0
Process CPU Time (nanoseconds) : 0
Queue size                     : 1
UP Time (seconds)              : 67
Is Durable                     : No

describe config

Display the configuration of a member.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe config --member=value [--hide-defaults(=value)?]

Parameters, describe config:

Name	Description	Default Value
‑‑member	Name or ID of a member whose configuration is to be shown.
‑‑hide-defaults	Whether or not to hide configuration information for properties with the default value.	true

Example Command:

describe config --member=Member1;

Sample Output:

gfsh>describe config --member=server1

Configuration of member : "server1"


JVM command line arguments
-----------------------------------
-Dgemfire.locators=localhost[10334]

GemFire properties defined using the API
................................................
log-file                                 : vf.gf.server.log
name                                     : server1

GemFire properties defined at the runtime
................................................
log-level                                 : finest
statistic-sampling-enabled                : true

Cache attributes
................................................
is-server        : true

Cache-server attributes
 . bind-address         : localhost

describe connection

Display connection information details.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe connection

Example Command:

describe connection

Sample Output:

gfsh>describe connection

Connection Endpoints
--------------------
GemFireUser[1099]

describe disk-store

Display information about a member’s disk store.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe disk-store --member=value --name=value

Parameters, describe disk-store:

Name	Description
‑‑member	Required. Name or ID of the member with the disk store to be described.
‑‑name	Required. Name of the disk store to be described.

Example Command:

describe disk-store --member=server1 --name=DiskStore1

Sample Output:

gfsh>describe disk-store --name=disk1 --member=server1

Disk Store ID                      : a531bc7b-5188-4510-85d7-de7de30c6671
Disk Store Name                    : disk1
Segments                           : 42
Member ID                          : ubuntu(server1:7467)<v1>:35249
Member Name                        : server1
Allow Force Compaction             : No
Auto Compaction                    : Yes
Compaction Threshold               : 50
Max Oplog Size                     : 1024
Queue Size                         : 0
Time Interval                      : 1000
Write Buffer Size                  : 32768
Disk Usage Warning Percentage      : 90
Disk Usage Critical Percentage     : 99
PDX Serialization Meta-Data Stored : No

        Disk Directory          | Size
------------------------------- | ----------
/home/user/server1/DiskStore1   | 2147483647

Note: Segments will not be displayed if the disk store is a legacy disk store.

describe gateway-receiver

Display details about a gateway receiver created in the cluster members.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe gateway-receiver [--members=values(,values)*] [--groups=value(,value)*]

Parameters, describe gateway-receiver:

Name	Description
‑‑member ‑‑members	Optional. Member or members with the gateway receiver to describe.
‑‑group ‑‑groups	Optional. Group or groups of members for which the gateway receivers will be described.

Example Commands:

describe gateway-receiver
describe gateway-receiver --member=server-2
describe gateway-receiver --group=group1

Output:

Property	Description
Hosting Members	Members hosting the gateway receiver.
Gateway transport filter	All gateway transport filters associated with the gateway receiver.
End port	End limit of port range used by the receiver.
Hostname for senders	Hostname associated with receiver which the senders use to connect.
Maximum time between pings (ms)	Time, in millisecond, between pings to connected sites.
Socket buffer size (bytes)	Buffer size, in bytes, of the socket connection associated with the receiver.
Start port	Starting port number for the range used by the receiver.
Is Running	Whether or not the gateway receiver is in a running state.
Port	Port assigned to the receiver.
Sender count	Number of senders connected to the receiver.
Senders connected	Hosts and ports of all senders connected to the receiver.

Sample Output:

Hosting members : server-4,server-3

Properties shared by members:

           Property             | Values
------------------------------- | -------
End port                        | 29999
Gateway transport filter        | Not Available
Hostname for senders            |
Is Running                      | true
Maximum time between pings (ms) | 60000
Socket buffer size (bytes)      | 524288
Start port                      | 20001

----------------------------------------------------------------
Member specific properties:

 Member  |     Property      | Values
-------- | ----------------- | --------------------------------------
server-4 | Port              | 27144
         | Sender count      | 3
         | Senders connected | 192.168.50.8(server-6:75815)<v2>:55056
         |                   | 192.168.50.8(server-6:75815)<v2>:55056
         |                   | 192.168.50.8(server-6:75815)<v2>:55056
server-3 | Port              | 22079
         | Sender count      | 12
         | Senders connected | 192.168.50.8(server-5:75814)<v1>:54593
         |                   | 192.168.50.8(server-5:75814)<v1>:54593
         |                   | 192.168.50.8(server-5:75814)<v1>:54593
         |                   | 192.168.50.8(server-5:75814)<v1>:54593
         |                   | 192.168.50.8(server-5:75814)<v1>:54593
         |                   | 192.168.50.8(server-6:75815)<v2>:55056
         |                   | 192.168.50.8(server-6:75815)<v2>:55056
         |                   | 192.168.50.8(server-6:75815)<v2>:55056
         |                   | 192.168.50.8(server-6:75815)<v2>:55056
         |                   | 192.168.50.8(server-6:75815)<v2>:55056
         |                   | 192.168.50.8(server-6:75815)<v2>:55056
         |                   | 192.168.50.8(server-6:75815)<v2>:55056

describe gateway-sender

Display details about a gateway sender created in the cluster members.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe gateway-sender --id=value [--members=value(,value)*] [--groups=value(,value)*]

Parameters, describe gateway-sender:

Name	Description
‑‑id	Required. ID of the gateway sender.
‑‑member ‑‑members	Optional. Name of ID of the member or members with the gateway sender to describe.
‑‑group ‑‑groups	Optional. Group or groups of members for which the gateway sender will be described.

Example Commands:

describe gateway-sender --id=ln_Serial
describe gateway-sender --id=ln_Serial --group=group1
describe gateway-sender --id=ln_Serial --groups=group1,group2
describe gateway-sender --id=ln_Serial --member=member1
describe gateway-sender --id=ln_Serial --members=member1,member2

Output:

Property	Description
Gateway Sender ID	ID of the gateway sender.
Distributed System ID	ID of the member's distributed system where the gateway sender is running.
Remote Distributed System ID	Distributed system ID of the remote site to which the gateway sender is connected.
Hosting Members	Members that host the gateway sender.
Type	Type of gateway sender. Possible values are `Serial` and `Parallel`.
Batch Size	Maximum batch size that the gateway sender sends to the remote site.
Batch Time Interval (ms)	Maximum batch time interval, in milliseconds, that the gateway sender waits before attempting to send a batch of queued objects to the remote gateway receiver.
Persist Gateway Queue	Whether or not persistence is enabled for the gateway sender.
Disk Store	Name of the DiskStore used by the gateway sender when persisting the gateway sender queue's data.
Disk Synchronous	Whether or not the gateway sender is configured to use synchronous Disk Store writes.
Max Queue Memory (MB)	Maximum size, in megabytes, that the gateway sender's queue may take in heap memory before overflowing to disk.
Alert Threshold (ms)	Time, in milliseconds, that an object can be in the queue to be replicated before the gateway sender logs an alert.
Dispatcher Threads	Number of dispatcher threads that the gateway sender uses to dispatch the queued events.
Order Policy	Order policy followed while dispatching the events to a remote distributed system. Order policy is set only when the dispatcher threads are greater than one. Possible values: THREAD - Indicates that events are parallelized based on the event's originating member and thread. KEY - Indicates that events are parallelized based on the event's key. PARTITION - In the case of a partitioned region event, indicates that events are parallelized based on the event's partition. In the case of a replicated region event, indicates that events are parallelized based on the event's key.
Enforce Threads Connect Same Receiver	Whether or not the sender threads must verify the receiver member ID to verify if they are connected to the same server.
Group Transaction Events	Whether or not the gateway sender is configured to send all events of a transaction in the same batch.
Gateway Event Filters	Fully-qualified class names of GatewayEventFilters associated with the gateway sender. This serves as a callback for users to filter out events before dispatching to a remote distributed system.
Gateway Transport Filters	Fully-qualified class names of GatewayTransportFilters associated with the gateway sender.
Enable Batch Conflation	Whether or not the gateway sender is configured to use conflate entries in each batch.
Socket Buffer Size (bytes)	Buffer size, in bytes, of the socket connection between the gateway sender and its receiving gateway receiver.
Socket Read Timeout (ms)	Time, in milliseconds, that a socket read between a sending gateway sender and its receiving gateway receiver may block.
Regions	Region names that are configured with the gateway sender.

Sample Output:

Gateway Sender ID            : gatewaySender1
Distributed System ID        : 1
Remote Distributed System ID : 2
Hosting Members              : server-2, server-3, server-4, server-5

Properties Shared By Hosting Members

              Property                | Value
------------------------------------- | -------
Type                                  | Serial
Batch Time Interval (ms)              | 1000
Persist Gateway Queue                 | false
Disk Store                            | DEFAULT
Disk Synchronous                      | true
Max Queue Memory (MB)                 | 100
Dispatcher Threads                    | 5
Order Policy                          | KEY
Enforce Threads Connect Same Receiver | false
Enable Batch Conflation               | false
Socket Buffer Size (bytes)            | 524288
Socket Read Timeout                   | 0
Regions                               | Not Available
Gateway Transport Filters             | Not Available

Member-Specific Properties

 Member  |         Property         | Value
-------- | ------------------------ | --------------------------------------------------------------------
server-2 | Batch Size               | 100
         | Alert Threshold (ms)     | 0
         | Group Transaction Events | false
         | Gateway Event Filters    | org.apache.geode.internal.cache.wan.wancommand.MyGatewayEventFilter1
         |                          | org.apache.geode.internal.cache.wan.wancommand.MyGatewayEventFilter2
server-3 | Batch Size               | 100
         | Alert Threshold (ms)     | 0
         | Group Transaction Events | false
server-4 | Batch Size               | 300
         | Alert Threshold (ms)     | 10
         | Group Transaction Events | false
server-5 | Batch Size               | 100
         | Alert Threshold (ms)     | 5
         | Group Transaction Events | true

describe jndi-binding

Print the configuration information that describes a JDBC connection.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe jndi-binding --name=value

Parameters, describe jndi-binding:

Name	Description
‑‑name	Required. Name of the JNDI binding to be described.

Example Command:

describe jndi-binding --name=jndi1

Sample Output:

gfsh>describe jndi-binding --name=jndi1

    Property      | Value
----------------- | ------------------------------------
type              | SimpleDataSource
jndi-name         | jndi1
jdbc-driver-class | org.apache.derby.jdbc.EmbeddedDriver
user-name         |
connection-url    | jdbc:derby:newDB

describe member

Display details of a member with given name or ID.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe member --name=value
describe member --name=value [--verbose]
describe member --name=value [--configuration] [--extension][--membership-view][--status][--startup-lifecycle]

Parameters, describe member:

Name	Description
‑‑name	Required. Display information about a member.
‑‑verbose	Optional. Displays additional information about a member. This includes sections that displays the membership view, configuration, extensions, status, and the startup lifecycle progress of the member.
‑‑configuration	Optional. Displays only the properties and system configurations of the member.
‑‑extension	Optional. Displays only the extension services loaded on the member.
‑‑membership-view	Optional. Displays only the membership view of the cluster as seen by the member.
‑‑status	Optional. Displays only the current status of the member, including alerts, resource usage, and uptime.
‑‑startup-lifecycle	Optional. Displays only the initialization status of the member’s components during and after startup.

Example Command:

describe member --name=server1

Sample Output:

gfsh>describe member --name=server1

Name : server1
Id : GemFireUser(server1:240)<v1>:64871
Host : 192.0.2.0
Regions : region4
region5
region3
region2
region1
PID : 240
Groups :
Used Heap : 5M
Max Heap : 123M
Working Dir : c:\VMwareGemFire100\Latest\server1
Log file : C:\VMwareGemFire100\Latest\server1\vf.gf.server.log
Locators : localhost[10334]

Server Bind : localhost Server
Port : 40404
Running : true
Client Connections : 0

Example Command:

describe member --name=server1 --status

Sample Output:

gfsh>describe member --name=server1 --status

Name : server1
Id : GemFireUser(server1:240)<v1>:64871
Host : 192.0.2.0
Regions : region4
region5
region3
region2
region1
PID : 240
Groups :
Used Heap : 5M
Max Heap : 123M
Working Dir : c:\VMwareGemFire100\Latest\server1
Log file : C:\VMwareGemFire100\Latest\server1\vf.gf.server.log
Locators : localhost[10334]

Server Bind : localhost Server
Port : 40404
Running : true
Client Connections : 0
------------------------------
Status
------------------------------
Alerts :
  Statistics Sampler : No alert
  Memory Monitor : Low memory alert
  Eviction Status : Member: 172.20.10.5(server-2:48033)<v2>:46846 above heap eviction threshold
Uptime : 18 seconds
CPU use : 0%
Initial Heap : 512M
Used Heap : 146M
Max Heap : 491M
JVM Pauses : 0

Example Command:

describe member --name=server2 --verbose

Sample Output:

gfsh> describe member --name=server2 --verbose

Name            : server-2
Id              : 192.168.50.8(server-2:98952)<v2>:60157
Type            : Server
Host            : 192.168.50.8
Regions         :
Timezone        : America/Los_Angeles -07:00
Metrics URL     : Not Available
PID             : 98952
Groups          :
Redundancy-Zone : RACK1
Used Heap       : 145M
Max Heap        : 491M
Load Average1   : 11.21
Working Dir     : /test-worker-000001/dunit/vm2
Log file        : /test-worker-000001/dunit/vm2
Locators        : localhost[20004]

Cache Server Information
Server Bind              :
Server Port              : 20011
Running                  : true

Client Connections : 0

------------------------------
Startup Lifecycle
------------------------------
Membership Service Startup : Complete
Joined Cluster : Complete
Management Service Startup : Complete
Cache Server Startup : Complete
Gateway Receiver : Skipped
Gateway Senders : Skipped
Region Initialization : Skipped
Internal Region Init : Complete
Region Disk Recovery : Skipped

------------------------------
Status
------------------------------
Alerts :
  Statistics Sampler : No alert
  Memory Monitor : Low memory alert
  Eviction Status : Member: 172.20.10.5(server-2:48033)<v2>:46846 above heap eviction threshold
Uptime : 18 seconds
CPU use : 0%
Initial Heap : 512M
Used Heap : 146M
Max Heap : 491M
JVM Pauses : 0

------------------------------
Extensions
------------------------------
Test Extension
VMware Tanzu GemFire Prometheus Metrics

------------------------------
Membership View
------------------------------
View ID : 2
Members :
192.168.50.8(locator-0:98950:locator)<ec><v0>:50692
192.168.50.8(server-1:98951)<v1>:54927
192.168.50.8(server-2:98952)<v2>:60157

------------------------------
Configuration:
------------------------------
----------------------------------------
Test Extension
----------------------------------------
----------------------------------------
VMware Tanzu GemFire Prometheus Metrics
----------------------------------------
GemFire-Prometheus-Metrics-Version: 10.1.0-build.0
GemFire-Prometheus-Metrics-Source-Branch: feature/GEM-6216
GemFire-Prometheus-Metrics-Source-Date: 2023-09-18 10:47:20 -0700
GemFire-Prometheus-Metrics-Source-Revision: e726fc3ca559fc8d19da5ba550a6cf9b7fdc97ac
----------------------------------------
VMware GemFire
----------------------------------------
Build-Java-Vendor: BellSoft
GemFire-Source-Repository: feature/GEM-6216
GemFire-Source-Revision: e726fc3ca559fc8d19da5ba550a6cf9b7fdc97ac
Build-Id: nnag 0
GemFire-Source-Date: 2023-09-18 10:47:20 -0700
GemFire-Version: 10.1.0-build.0
Product-Name: VMware GemFire
Build-Platform: Mac OS X 10.16 x86_64
Build-Java-Version: 1.8.0_352

Running on: Running on: 192.168.50.8/192.168.50.8, 10 cpu(s), x86_64 Mac OS X 10.16

Communications version: 210
Process ID: 98952
User: nnag
Current dir: /Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-gfsh/build/distributedTest/test-worker-000001/dunit/vm2
Home dir: /Users/nnag
Command Line Parameters:
  -DDUnitLauncher.REMOTE_STUB_PORT=0
  -Dgemfire.DUnitLauncher.RMI_PORT=20001
  -Dgemfire.DUnitLauncher.VM_NUM=2
  -Dgemfire.DUnitLauncher.VM_VERSION=10240.0.0
  -DWORKSPACE_DIR=/Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-gfsh/build/distributedTest/test-worker-000001/.
  -DAvailablePort.lowerBound=20001
  -DAvailablePort.upperBound=29999
  -DLocator.inhibitDMBanner=true
  -Xrunjdwp:transport=dt_socket,server=y,suspend=n
  -XX:+HeapDumpOnOutOfMemoryError
  -Xmx512m
  -Dgemfire.DEFAULT_MAX_OPLOG_SIZE=10
  -Dgemfire.disallowMcastDefaults=true
  -Dgemfire.use-ephemeral-ports=true
  -Dgemfire.validate-serializable-objects=true
  -ea
  -XX:MetaspaceSize=512m
  -XX:SoftRefLRUPolicyMSPerMB=1
  -DdummyArg=true
  -Djboss.modules.system.pkgs=javax.management,java.lang.management
  -Dboot.module.loader=com.vmware.gemfire.bootstrap.internal.GemFireModuleLoader
Class Path:
  /Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-assembly/build/install/vmware-gemfire-distributed-testing/lib/gemfire-bootstrap-10.1.0-build.0.jar
Library Path:
  /Users/nnag/Library/Java/Extensions
  /Library/Java/Extensions
  /Network/Library/Java/Extensions
  /System/Library/Java/Extensions
  /usr/lib/java
  .
System Properties:
    AvailablePort.lowerBound = 20001
    AvailablePort.upperBound = 29999
    DUnitLauncher.REMOTE_STUB_PORT = 0
    Locator.inhibitDMBanner = true
    WORKSPACE_DIR = /Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-gfsh/build/distributedTest/test-worker-000001/.
    awt.toolkit = sun.lwawt.macosx.LWCToolkit
    boot.module.loader = com.vmware.gemfire.bootstrap.internal.GemFireModuleLoader
    dummyArg = true
    file.encoding = UTF-8
    file.encoding.pkg = sun.io
    file.separator = /
    gemfire.DEFAULT_MAX_OPLOG_SIZE = 10
    gemfire.DUnitLauncher.LAUNCHED = true
    gemfire.DUnitLauncher.RMI_PORT = 20001
    gemfire.DUnitLauncher.VM_NUM = 2
    gemfire.DUnitLauncher.VM_VERSION = 10240.0.0
    gemfire.disallowMcastDefaults = true
    gemfire.free-off-heap-memory = true
    gemfire.use-ephemeral-ports = true
    gemfire.validate-serializable-objects = true
    gopherProxySet = false
    java.awt.graphicsenv = sun.awt.CGraphicsEnvironment
    java.awt.printerjob = sun.lwawt.macosx.CPrinterJob
    java.class.version = 52.0
    java.endorsed.dirs = /Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib/endorsed
    java.ext.dirs = /Users/nnag/Library/Java/Extensions:/Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib/ext:/Library/Java/Extensions:/Network/Library/Java/Extensions:/System/Library/Java/Extensions:/usr/lib/java
    java.home = /Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre
    java.io.tmpdir = /var/folders/5d/wdm0b23d4md1m02f50mp44cw0000gp/T/
    java.runtime.name = OpenJDK Runtime Environment
    java.runtime.version = 1.8.0_352-b08
    java.specification.maintenance.version = 4
    java.specification.name = Java Platform API Specification
    java.specification.vendor = Oracle Corporation
    java.specification.version = 1.8
    java.vendor = BellSoft
    java.vendor.url = https://bell-sw.com/
    java.vendor.url.bug = https://bell-sw.com/support
    java.version = 1.8.0_352
    java.vm.info = mixed mode
    java.vm.name = OpenJDK 64-Bit Server VM
    java.vm.specification.name = Java Virtual Machine Specification
    java.vm.specification.vendor = Oracle Corporation
    java.vm.specification.version = 1.8
    java.vm.vendor = BellSoft
    java.vm.version = 25.352-b08
    jboss.modules.system.pkgs = javax.management,java.lang.management
    line.separator =

    module.path = /Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-assembly/build/install/vmware-gemfire-distributed-testing/moduleDescriptors/gemfire-gfsh:/Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-gfsh/build/distributedTest/test-worker-000001/dunit/vm2/deployments
    os.version = 10.16
    path.separator = :
    sun.arch.data.model = 64
    sun.boot.class.path = /Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib/resources.jar:/Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib/rt.jar:/Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib/sunrsasign.jar:/Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib/jsse.jar:/Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib/jce.jar:/Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib/charsets.jar:/Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib/jfr.jar:/Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/classes
    sun.boot.library.path = /Library/Java/JavaVirtualMachines/liberica-jdk-8.jdk/Contents/Home/jre/lib
    sun.cpu.endian = little
    sun.cpu.isalist =
    sun.io.unicode.encoding = UnicodeBig
    sun.java.command = org.jboss.modules.Main -mp /Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-assembly/build/install/vmware-gemfire-distributed-testing/moduleDescriptors/gemfire-gfsh:/Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-gfsh/build/distributedTest/test-worker-000001/dunit/vm2/deployments gemfire
    sun.java.launcher = SUN_STANDARD
    sun.jnu.encoding = UTF-8
    sun.management.compiler = HotSpot 64-Bit Tiered Compilers
    sun.os.patch.level = unknown
    user.country = US
    user.language = en
    user.timezone = America/Los_Angeles
Log4J 2 Configuration:
    jar:file:/Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-log4j/build/libs/gemfire-log4j-10.1.0-build.0.jar!/log4j2.xml
### GemFire Properties defined with system property ###
validate-serializable-objects=true
### GemFire Properties defined with api ###
http-service-port=0
locators=localhost[20004]
max-wait-time-reconnect=5000
name=server-2
redundancy-zone=RACK1
### GemFire Properties using default values ###
ack-severe-alert-threshold=0
ack-wait-threshold=15
archive-disk-space-limit=0
archive-file-size-limit=0
async-distribution-timeout=0
async-max-queue-size=8
async-queue-timeout=60000
bind-address=
cache-xml-file=cache.xml
cluster-configuration-dir=
cluster-ssl-ciphers=any
cluster-ssl-enabled=false
cluster-ssl-keystore=
cluster-ssl-keystore-password=
cluster-ssl-keystore-type=
cluster-ssl-protocols=any
cluster-ssl-require-authentication=true
cluster-ssl-truststore=
cluster-ssl-truststore-password=
conflate-events=server
conserve-sockets=false
delta-propagation=true
deploy-working-dir=/Users/nnag/Development/gemfireDev/gemfire/gemfire/gemfire-gfsh/build/distributedTest/test-worker-000001/dunit/vm2
disable-auto-reconnect=false
disable-jmx=false
disable-tcp=false
distributed-system-id=-1
distributed-transactions=false
durable-client-id=
durable-client-timeout=300
enable-cluster-configuration=true
enable-management-rest-service=true
enable-network-partition-detection=true
enable-time-statistics=true
enforce-unique-host=false
gateway-ssl-ciphers=any
gateway-ssl-enabled=false
gateway-ssl-keystore=
gateway-ssl-keystore-password=
gateway-ssl-keystore-type=
gateway-ssl-protocols=any
gateway-ssl-require-authentication=true
gateway-ssl-truststore=
gateway-ssl-truststore-password=
groups=
http-service-bind-address=
http-service-ssl-ciphers=any
http-service-ssl-enabled=false
http-service-ssl-keystore=
http-service-ssl-keystore-password=
http-service-ssl-keystore-type=
http-service-ssl-protocols=any
http-service-ssl-require-authentication=false
http-service-ssl-truststore=
http-service-ssl-truststore-password=
jmx-manager=false
jmx-manager-access-file=
jmx-manager-bind-address=
jmx-manager-hostname-for-clients=
jmx-manager-http-port=0
jmx-manager-password-file=
jmx-manager-port=1099
jmx-manager-ssl-ciphers=any
jmx-manager-ssl-enabled=false
jmx-manager-ssl-keystore=
jmx-manager-ssl-keystore-password=
jmx-manager-ssl-keystore-type=
jmx-manager-ssl-protocols=any
jmx-manager-ssl-require-authentication=true
jmx-manager-ssl-truststore=
jmx-manager-ssl-truststore-password=
jmx-manager-start=false
jmx-manager-update-rate=2000
load-cluster-configuration-from-dir=false
locator-wait-time=0
lock-memory=false
log-disk-space-limit=0
log-file=
log-file-size-limit=0
log-level=config
max-num-reconnect-tries=3
mcast-address=239.192.81.1
mcast-flow-control=1048576, 0.25, 5000
mcast-port=0
mcast-recv-buffer-size=1048576
mcast-send-buffer-size=65535
mcast-ttl=32
member-timeout=5000
membership-port-range=41000-61000
memcached-bind-address=
memcached-port=0
memcached-protocol=ASCII
off-heap-memory-size=
remote-locators=
remove-unresponsive-client=false
roles=
security-auth-token-enabled-components=
security-client-accessor=
security-client-accessor-pp=
security-client-auth-init=
security-client-authenticator=
security-client-dhalgo=
security-log-file=
security-log-level=config
security-manager=
security-peer-auth-init=
security-peer-authenticator=
security-peer-verifymember-timeout=1000
security-post-processor=
security-udp-dhalgo=
serializable-object-filter=!*
server-bind-address=
server-ssl-ciphers=any
server-ssl-enabled=false
server-ssl-keystore=
server-ssl-keystore-password=
server-ssl-keystore-type=
server-ssl-protocols=any
server-ssl-require-authentication=true
server-ssl-truststore=
server-ssl-truststore-password=
socket-buffer-size=32768
socket-lease-time=1800000
ssl-ciphers=any
ssl-client-protocols=
ssl-cluster-alias=
ssl-default-alias=
ssl-enabled-components=
ssl-endpoint-identification-enabled=false
ssl-gateway-alias=
ssl-jmx-alias=
ssl-keystore=
ssl-keystore-password=
ssl-keystore-type=
ssl-locator-alias=
ssl-parameter-extension=
ssl-protocols=any
ssl-require-authentication=true
ssl-server-alias=
ssl-server-protocols=
ssl-truststore=
ssl-truststore-password=
ssl-truststore-type=
ssl-use-default-context=false
ssl-web-alias=
ssl-web-require-authentication=false
start-dev-rest-api=false
start-locator=
statistic-archive-file=
statistic-sample-rate=1000
statistic-sampling-enabled=true
tcp-port=0
thread-monitor-enabled=true
thread-monitor-interval-ms=60000
thread-monitor-time-limit-ms=120000
udp-fragment-size=60000
udp-recv-buffer-size=1048576
udp-send-buffer-size=65535
use-cluster-configuration=true
use-udp-membership-messenger=false
user-command-packages=

describe offline-disk-store

Display information about an offline member’s disk store.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe offline-disk-store --name=value --disk-dirs=value(,value)* [--pdx=value] [--region=value]

Parameters, describe offline-disk-store:

Name	Description
‑‑name	Required. Name of the disk store to be described.
‑‑disk-dirs	Required. Directory that contains the disk store files.
‑‑pdx	If set (or set to true), display all the pdx types stored in the disk store.
‑‑region	Name and path of the region in the disk store to be described.

Example Commands:

describe offline-disk-store --name=DiskStore1\
 --disk-dirs=/home/username/gemfire/mydiskStore1Dir

describe offline-disk-store --name=DiskStore1 --disk-dirs=/DiskDir1  --pdx=true

Sample Output:

gfsh>describe offline-disk-store --name=DiskStore1 --disk-dirs=/DiskDir1 --pdx=true

Regions in the disk store:
  /PdxTypes: -lru=none -concurrencyLevel=16 -initialCapacity=16 -loadFactor=0.75 -compressor=none -statisticsEnabled=false
  /Region1: -lru=none -concurrencyLevel=16 -initialCapacity=16 -loadFactor=0.75 -compressor=none -statisticsEnabled=false
PDX Types:
  com.app.data.PositionPdx: id=1
    long avg20DaysVol;
    String bondRating;
    double convRatio;
    String country;
    double delta;
    long industry;
    long issuer;
    double mktValue;
    double qty;
    String secId; // identity
    String secIdIndexed;
    String secLinks;
    double sharesOutstanding;
    String underlyer;
    long volatility;
    int pid;
    int portfolioId;
  com.app.data.StockPdx: id=2
    int ID; // identity
    String pkid;
    Object position1;
    Object position2;
    Object positions;
    Object collectionHolderMap;
    String type;
    String status;
    String[] names;
    String description;
    long createTime;
    Object[] position3;
    Object aDay;
    Date date;
PDX Enums:
  com.app.data.StockPdx$Day.Monday

describe query

Display additional details about an executing query.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe query --query-id=value [--(member|members)=value(,value)*]

Parameters, describe query:

Name	Description
‑‑query-id	Required. ID of the query. To find a client ID, use the `list queries` command to display a list of executing queries and their IDs.
‑‑member or --members	Name or ID of the members for which the query will be displayed. If this is not specified then the queries from all members will be displayed.

Example Commands:

describe query --queryId=faf13b3b-0da1-4b75-885f-2dc1a010f080
describe query --queryId=faf13b3b-0da1-4b75-885f-2dc1a010f080 --members=server1,server3

Sample Output:

gfsh>describe query --queryId=faf13b3b-0da1-4b75-885f-2dc1a010f080

Query ID            : fee0909a-75b6-4fd5-8ccb-4f1b666c5d42
Query               : <TRACE> SELECT * FROM /PORTFOLIO p WHERE p.ID >= 0
Elapsed Time        : 00:00:00.153
Execution Count     : 2
Avg. Execution Time : 00:00:00.009
Indexes Used        : PORTFOLIO_IDX*
Members             : server-1, server-2
[Time format is hh:mm:ss.sss. Indexes marked with (*) were not found in use on all members.]

Elapsed Time shown is the maximum elapsed time in seconds from all members where the query is being executed, or for the members as specified by the --member or --members arguments.

Indexes Used is the union of the names of the indexes that have been used for this queries on all of the relevant members.

describe query-service

Print the information that describes the current configuration of the query service.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe query-service

Example Command:

describe query-service

Sample Output:

gfsh>describe query-service

Method Authorizer Class : org.apache.geode.cache.query.security.JavaBeanAccessorMethodAuthorizer

describe region

Display the attributes and key information of a region.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

describe region --name=value [--verbose]

Parameters, describe region:

Name	Description
‑‑name	Required. Name or path of the region to be described.
‑‑verbose	Optional. Displays additional properties of the region.

Output:

Output Field	Description
Name	Name of the region.
Data Policy	Specifies how the local cache handles data for a region. This setting controls behavior such as local data storage and region initialization. Possible Values: Empty: No data storage in the local cache. Normal: Data used locally is stored in the local cache. Partition: Data is partitioned across local and remote caches using the automatic data distribution behavior of partitioned regions. Replicate: The region is initialized with the data from other caches. Persistent-partition: Behaves the same as partition and also persists data to disk. Persistent-replicate: Behaves the same as replicate and also persists data to disk. Preloaded: Initializes like a replicated region. After initialization, behaves like a normal region.
Hosting Members	Members hosting the region and its entries.
disk-store-name	Name of the disk store the region is assigned to.
size	Number of entries in the region.
scope	Describes the policy for region distribution. distributed-no-ack distributed-ack global
Accessor Members	Members hosting the region but not its entries. These members are set with memory value set to zero and cannot store actual data.
concurrency-checks-enabled	Determines whether members perform checks to provide consistent handling for concurrent or out-of-order updates to distributed regions. For more information, see Consistency Checking by Region Type.
pool-name	Server pool used by the region.
enable-subscription-conflation	Whether or not the server conflates region's messages sent to the client. true: Server conflates region's messages sent to the client. false: No conflation.
entry-time-to-live.action	Action that should take place when an entry expires. Possible values: local-destroy destroy local-invalidate invalidate
gateway-sender-id	All gateway senders associated with the region.
region-time-to-live.action	Action that should take place when a region expires. Possible values: local-destroy destroy local-invalidate invalidate
region-idle-time.action	Action that should take place when a region remains idle until the set timeout. Possible values: local-destroy destroy local-invalidate invalidate
region-idle-time.timeout	Time, in seconds, that the region can remain in the cache without being accessed or updated. `Deactivated` indicates no expiration.
initial-capacity	The initial capacity (entries) of the region's underlying java.util.ConcurrentHashMap used for storing region entries
statistics-enabled	Whether or not the statistics are enabled. true: Region statistics are enabled. false: Region statistics are disabled and expiration cannot be enabled.
cache-loader	Fully-qualified class name of the region's cache loaders.
cache-listeners	Fully-qualified class name of the region's cache listeners.
concurrency-level	Maximum number of application threads that can concurrently access the region's entry.
entry-time-to-live.timeout	Time, in seconds, for which a region's entries can remain in the cache. `Deactivated` indicates no expiration.
index-maintenance-synchronous	Whether or not indexes are maintained synchronously with region modifications. true: Indexes are maintained synchronously with region modifications. false: Indexes are maintained asynchronously in a background thread.
entry-idle-time-custom-expiry	Fully-qualified class name for the action to perform when a region's entries idle time expires.
load-factor	The load factor, expressed as a percentage in decimal format, pertains to the region's `java.util.ConcurrentHashMap`, which stores region entries. It determines when the ConcurrentHashMap's capacity should be increased.
cloning-enabled	Whether or not cloning is enabled. Determines how value changes are made in the cache. true: Updates are applied to a clone of the value and then the clone is saved to the cache. false: Value is modified in place in the cache.
off-heap	Whether or not off-heap memory is used to store region values and queue entries. true: Off-heap memory used to store the region values and queue entries. false: Off-heap memory not used.
enable-async-conflation	Whether or not asynchronous messages for the region are conflated by the sending server. true: Asynchronous messages for the region are conflated by the sending server. false: No conflation.
is-lock-grantor	Whether or not the regions is a lock grantor. true: Region is a lock grantor. false: Region cannot grant lock.
entry-idle-time.timeout	Time, in seconds, that the region's entries can remain in the cache without being accessed or updated. `Deactivated` indicates no expiration.
region-time-to-live.timeout	Time, in seconds, before the region expires. `Deactivated` indicates no expiration.
ignore-jta	Whether or not the regions participates in JTA transactions. true: Region participates in JTA transactions. false: Region ignores JTA and operates outside of transactions.
entry-idle-time.action	Action to perform when the region's entries remain idle for the timeout duration. Possible values: local-destroy destroy local-invalidate invalidate
async-event-queue-id	Asynchronous event queue identifiers associated with the region.
cache-writer	Fully-qualified class name of the region's cache writer.
value-constraint	Allowed data type for region entry values.
key-constraint	Allowed data type for region entry keys.
disk-synchronous	Whether or not disk writes are synchronous. true: Disk writes are synchronous. false: Disk writes are asynchronous.
compressor	Fully-qualified class name of the Compressor to use when compressing region entry values.
object-sizer	Fully-qualified class name used to calculate the size of the region.
eviction-algorithm	Algorithm used to determine when to start evicting entries.
eviction-action	Action triggered by the `eviction-algorithm` decision.
eviction-maximum-value	If the `eviction-algorithm` is based on the number of entries, this value is the maximum number of entries. If the `eviction-algorithm` is based on memory usage, this value is the maximum allowed memory in MB. If the `eviction-algorithm` is based on the percentage of heap in use, this value is always zero.
redundant-copies	Number of secondary copies maintained in the region's data stores.
colocated with	Name of the region this is co-located with.
partition-resolver	Partition resolver used to customize the default hashing policy for distributing entries into buckets.
total-num-buckets	Total number of buckets in the region.
number of buckets with redundancy satisfied	Number of buckets in the region which have the same redundancy as this region was configured with.
partition-listeners	Partition listeners associated with the region.
number of buckets with redundancy not satisfied	Number of buckets in the region which have lower redundancy than this region was configured with.
startup-recovery-delay	Time, in milliseconds, to wait after the member joins and before recovering redundancy. `Deactivated` indicates no automatic recovery of redundancy after a new member comes online.
redundancy	Satisfied: All buckets have the configured redundancy. Not Satisfied: One or more buckets do not have redundancy equal to the configured value.
entry-time-to-live-custom-expiry	Fully-qualified class name for the action to perform when a region's entry time to live expires.
recovery-delay	Time, in milliseconds, that existing members will wait before satisfying redundancy after another member crashes. `Deactivated` indicates that redundancy will not be recovered after a failure.
local-max-memory	Maximum amount of memory, in megabytes, to be used by the region in this process. If not set, a default of 90% of available heap is used.
Fixed Partition	Fixed partition attributes associated with the region: Name Primary/Secondary Number of buckets
number of entries with values only on disk	Number of values in the region that have overflowed to disk and are no longer in memory.
total size of values only on disk	Total size of the values that have overflowed to disk.
number of entries with values in memory	Number of entries in the JVM memory.
total size of the region in memory	Size of the region in the JVM memory.

Example Commands:

describe region --name=region1
describe region --name=PR1 --verbose

Sample Output 1:

gfsh>describe region --name=Region1

..........................................................
Name : Region1
Data Policy : persistent replicate
Hosting Members : server-5
server-4
server-3
server-2

Non-Default Attributes Shared By Hosting Members

Type   | Name            | Value
------ | --------------- | --------------------
Region | data-policy     | PERSISTENT_REPLICATE
       | disk-store-name | DiskStore1
       | size            | 0
       | scope           | distributed-ack

...........................................................
Name             : Region1
Data Policy      : empty
Accessor Members : server-1

Non-Default Attributes Shared By Accessor Members

 Type  |    Name     | Value
------ | ----------- | ---------------
Region | data-policy | EMPTY
       | size        | 0
       | scope       | distributed-ack

Sample Output 2:

gfsh>describe region --name=PR1 –verbose

Name            : PR1
Size            : 0
Data Policy     : partition
Status          : Ready
Hosting Members : server-1
                  server-2

All Attributes Shared By Hosting Members

  Type    |                      Name                       | Value
--------- | ----------------------------------------------- | -----------------
Region    | concurrency-checks-enabled                      | true
          | pool-name                                       | 
          | enable-subscription-conflation                  | false
          | entry-time-to-live.action                       | INVALIDATE
          | gateway-sender-id                               | 
          | region-time-to-live.action                      | INVALIDATE
          | region-idle-time.action                         | INVALIDATE
          | disk-store-name                                 | 
          | region-idle-time.timeout                        | Deactivated
          | initial-capacity                                | 16
          | statistics-enabled                              | true
          | cache-loader                                    | 
          | cache-listeners                                 | 
          | concurrency-level                               | 4
          | entry-time-to-live.timeout                      | Deactivated
          | data-policy                                     | PARTITION
          | index-maintenance-synchronous                   | true
          | entry-idle-time-custom-expiry                   | TestCustomIdleExpiry
          | load-factor                                     | 0.75
          | cloning-enabled                                 | false
          | off-heap                                        | false
          | enable-async-conflation                         | true
          | is-lock-grantor                                 | false
          | entry-idle-time.timeout                         | Deactivated
          | region-time-to-live.timeout                     | Deactivated
          | ignore-jta                                      | false
          | entry-idle-time.action                          | INVALIDATE
          | async-event-queue-id                            | 
          | cache-writer                                    | 
          | value-constraint                                | 
          | key-constraint                                  | 
          | disk-synchronous                                | true
          | compressor                                      | 
Eviction  | object-sizer                                    | 
          | eviction-algorithm                              | lifo-entry-count
          | eviction-action                                 | local-destroy
          | eviction-maximum-value                          | 100
Partition | redundant-copies                                | 1
          | colocated with                                  | 
          | partition-resolver                              | 
          | total-num-buckets                               | 113
          | number of buckets with redundancy satisfied     | 0
          | partition-listeners                             | TestPartitionListener
          | number of buckets with redundancy not satisfied | 0
          | startup-recovery-delay                          | 0 ms
          | redundancy                                      | Satisfied

All Attributes Specific To The Hosting Members

 Member  |   Type    |               Name               | Value
-------- | --------- | -------------------------------- | --------------------
server-1 | Region    | entry-time-to-live-custom-expiry | 
         | Partition | recovery-delay                   | 2 ms
         |           | local-max-memory                 | 100 MB
         |           | Fixed Partition                  | Par1
         |           |                                  | Primary
         |           |                                  | 1
server-2 | Region    | entry-time-to-live-custom-expiry | TestCustomTTLExpiry
         | Partition | recovery-delay                   | 4 ms
         |           | local-max-memory                 | 150 MB
         |           | Fixed Partition                  | Par2
         |           |                                  | Secondary
         |           |                                  | 4

Region Entries Statistics Specific To The Hosting Members

 Member  |     Type      |                Name                 | Value
-------- | ------------- | ----------------------------------- | -------------
server-1 | Disk Overflow | number of entries only on disk      | Not Available
         |               | number of bytes overflowed to disk  | Not Available
         |               | number of entries in the cache      | 0
         |               | number of bytes stored in the cache | 0 bytes
server-2 | Disk Overflow | number of entries only on disk      | Not Available
         |               | number of bytes overflowed to disk  | Not Available
         |               | number of entries in the cache      | 0
         |               | number of bytes stored in the cache | 0 bytes