This topic describes the list command in gfsh, the VMware Tanzu GemFire command-line interface.
Use this command to list existing Tanzu GemFire resources such as deployed applications, disk-stores, functions, members, servers, and regions.
-
Display a list of async event queues for all members.
-
Display a list of connected clients.
-
Display a list of JARs that were deployed to members using the deploy command.
-
List all available disk stores across the Tanzu GemFire cluster
-
List durable client CQs associated with the specified durable client id.
-
Display a list of registered functions. The default is to display functions for all members.
-
Display the gateway senders and receivers for a member or members.
-
Display the list of indexes created for all members.
-
List all JNDI bindings, active and configured.
-
Display all or a subset of members.
-
Display regions of a member or members. If no parameter is specified, all regions in the cluster are listed.
list async-event-queues
Display a list of async event queues for all members.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list async-event-queues
Example Commands:
list async-event-queues
list clients
Display a list of connected clients and the servers to which they connect.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list clients
Example Commands:
list clients
Sample Output:
gfsh>list clients
ClientList
Client Name / ID | Server Name / ID
------------------------------------ | -----------------------------------------------------
192.0.2.0(4987:loner):58922:7b3398cf | member=server2,port=53508; member=server1,port=56806
192.0.2.0(5065:loner):39906:a6f598cf | member=server2,port=53508; member=server1,port=56806
list deployed
Display a list of JARs that were deployed to members using the deploy command.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list deployed [--groups=value(,value)*]
Parameters, list deployed:
| Name | Description |
|---|---|
| ‑‑groups | Groups of members for which deployed JARs will be displayed. If not specified, JARs for all members are displayed. |
Example Commands:
list deployed
list deployed --groups=Group2
Sample Output:
gfsh> list deployed --groups=Group2
Member | Deployed JAR | JAR Location
--------- | -------------------- | ---------------------------------------------------
datanode1 | group1_functions.jar | /usr/local/gemfire/deploy/vf.gf#group1_functions.jar#1
datanode2 | group1_functions.jar | /usr/local/gemfire/deploy/vf.gf#group1_functions.jar#1
Error Messages:
No JAR Files Found
list disk-stores
List all available disk stores across the Tanzu GemFire cluster.
The command also lists the configured disk directories and any Regions, Cache Servers, Gateways, PDX Serialization and Async Event Queues using Disk Stores to either overflow and/or persist information to disk. Use the describe disk-store command to see the details for a particular Disk Store.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list disk-stores
Example Commands:
list disk-stores
Sample Output:
gfsh> list disk-stores
Member Name | Member Id | Disk Store Name | Disk Store ID
-------------- | ------------------------------------------| --------------- | ------------------------------------
consumerServer | 192.0.2.0(consumerServer:13825)<v5>:3545 | consumerData | 4029af26-fd82-4997-bd6c-33382cdbb5e9
consumerServer | 192.0.2.0(consumerServer:13825)<v5>:3545 | observerData | 7e0316ad-963c-49b0-9b01-8f59b8d9e29e
producerServer | 192.0.2.0(producerServer:13826)<v3>:53764 | producerData | 4670e4eb-1c50-4465-b418-08ede3d5dbed
Error Messages:
No Disk Stores Found
list durable-cqs
List durable client CQs associated with the specified durable client id.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list durable-cqs --durable-client-id=value
[--members=value(,value)*] [--groups=value(,value)*]
Parameters, list durable-cqs:
| Name | Description |
|---|---|
| ‑‑durable-client-id | Required. The ID used to identify the durable client. |
| ‑‑members | Name or Id of the members for which the durable client is registered and durable CQs will be displayed. |
| ‑‑groups | Groups of members for which the durable client is registered and durable CQs will be displayed. |
Example Commands:
list durable-cqs --durable-client-id=client1
Sample Output:
gfsh>list durable-cqs --durable-client-id=client1
member | durable-cq-name
------- | ---------------
server3 | cq3
| cq1
| cq2
server4 | cq3
| cq1
Error Messages:
Unable to list durable-cqs for durable-client-id : "client1" due to following reasons.
No client found with client-id : client1
Occurred on members
1.server4
2.server1
3.server3
list functions
Display a list of registered functions. The default is to display functions for all members.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list functions [--matches=value] [--groups=value(,value)*]
[--members=value(,value)*]
Parameters, list functions:
| Name | Description |
|---|---|
| ‑‑matches | Pattern that the function ID must match in order to be included. Uses Java pattern matching rules, not UNIX. For example, to match any character any number of times use “.*” rather than “*”. |
| ‑‑groups | Groups of members for which functions will be displayed. Use a comma separated list for multiple groups. |
| ‑‑members | Name or ID of the members for which functions will be displayed. Use a comma separated list for multiple members. |
Example Commands:
list functions
list functions --matches=reconcile.*
Sample Output:
gfsh> list functions
Member | Function
--------- | --------------------------
camelot | loadDataFromExternalSource
camelot | reconcileWeeklyExpenses
excalibur | loadDataFromExternalSource
excalibur | reconcileDailyExpenses
Example of list functions with a “matches” filter:
gfsh> list functions --matches=reconcile.*
Member | Function
--------- | -----------------------
camelot | reconcileWeeklyExpenses
excalibur | reconcileDailyExpenses
Error Messages:
No Functions Found
list gateways
Display the gateway senders and receivers for a member or members.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list gateways [--members=value(,value)*] [--groups=value(,value)*] [--senders-only | --receivers-only]
Parameters, list gateways:
| Name | Description |
|---|---|
| ‑‑members | Members whose gateways senders and receiver display. |
| ‑‑groups | Groups of members for which Gateway Senders and Receivers will be displayed. Use a comma separated list for multiple groups. |
| ‑‑senders‑only | List only gateway senders. This parameter cannot be used together with --receivers-only. |
| ‑‑receivers‑only | List only gateway receivers. This parameter cannot be used together with --senders-only. |
Example Commands:
list gateways
list gateways --senders-only
list gateways --receivers-only
Sample Output:
gfsh>list gateways
GatewaySender Section
GatewaySender Id | Member | Remote Cluster Id | Type | Status | Queued Events | Receiver Location
---------------- | --------------------------- | ----------------- | -------- | ------- | ------------- | -----------------
ln | mymac(ny-1:88641)<v2>:33491 | 2 | Parallel | Running | 0 | mymac:5037
ln | mymac(ny-2:88705)<v3>:29329 | 2 | Parallel | Running | 0 | mymac:5064
ln | mymac(ny-3:88715)<v4>:36808 | 2 | Parallel | Running | 0 | mymac:5132
ln | mymac(ny-4:88724)<v5>:52993 | 2 | Parallel | Running | 0 | mymac:5324
GatewayReceiver Section
Member | Port | Sender Count | Senders Connected
--------------------------- | ---- | ------------ | -----------------------------------------------------------------------------------------------------------------------
mymac(ny-1:88641)<v2>:33491 | 5057 | 9 |["mymac(ln-1:88651)<v2>:48277","mymac(ln-4:88681)<v5>:42784","mymac(ln-3:88672)<v4>:43675","mymac(ln-2:88662)<v3>:12796"]
mymac(ny-2:88705)<v3>:29329 | 5082 | 4 |["mymac(ln-1:88651)<v2>:48277","mymac(ln-4:88681)<v5>:42784","mymac(ln-3:88672)<v4>:43675"]
mymac(ny-3:88715)<v4>:36808 | 5371 | 4 |["mymac(ln-1:88651)<v2>:48277","mymac(ln-4:88681)<v5>:42784","mymac(ln-3:88672)<v4>:43675"]
mymac(ny-4:88724)<v5>:52993 | 5247 | 3 |["mymac(ln-1:88651)<v2>:48277","mymac(ln-4:88681)<v5>:42784","mymac(ln-3:88672)<v4>:43675"]
list indexes
Display the list of indexes created for all members.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list indexes [--with-stats(=value)?]
Parameters, list indexes:
| Name | Description | Default Value |
|---|---|---|
| ‑‑with-stats | Specifies whether statistics should also be displayed. | false |
Example Commands:
list indexes
list indexes --with-stats
Sample Output:
gfsh>list indexes
Member Name | Member ID | Region Path | Name | Type | Indexed Expression | From Clause
-------------- | ----------------------------------------- | ----------- | -------- | ----- | ------------------ | -----------
consumerServer | 192.0.2.0(consumerServer:13873):6317 | /consumers | cidIdx | KEY | id | /consumers
consumerServer | 192.0.2.0(consumerServer:13873):6317 | /consumers | cnameIdx | RANGE | name | /consumers
producerServer | 192.0.2.0(producerServer:13874):19198 | /producers | pidIdx | RANGE | id | /producers
Example of ‘list indexes’ with stats printed:
gfsh>list indexes --with-stats
Member Name | Member ID | Region Path | Name | Type | Indexed Expression | From Clause | Uses | Updates | Update Time | Keys | Values
------------ | --------- | ----------- | -------- | ----- | ------------------ | ----------- | ---- | ------- | ----------- | ---- | ------
cs... | 192... | /consumers | cidIdx | KEY | id | /consumers | 2512 | 0 | 0 | 5020 | 5020
cs... | 192... | /consumers | cnameIdx | RANGE | name | /consumers | 0 | 5020 | 421224000 | 0 | 5020
ps... | 192... | /producers | pidIdx | RANGE | id | /producers | 0 | 5031 | 497872000 | 5031 | 5031
Error Messages:
No Indexes Found
list jndi-binding
List all JNDI bindings, active and configured. An active binding is one that is bound to the server’s JNDI context and is also listed in the cluster configuration. A configured binding is one that is listed in the cluster configuration, but may not be active on the servers.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list jndi-binding
Sample Output:
gfsh>list jndi-binding
Configured JNDI bindings:
Group Name | JNDI Name | JDBC Driver Class
---------- | --------- | ------------------------------------
cluster | jndi1 | org.apache.derby.jdbc.EmbeddedDriver
Active JNDI bindings found on each member:
Member | JNDI Name | JDBC Driver Class
--------------- | ----------------------- | ----------------------------------------------------
land-gifted-gun | java:UserTransaction | org.apache.geode.internal.jta.UserTransactionImpl
land-gifted-gun | java:TransactionManager | org.apache.geode.internal.jta.TransactionManagerImpl
list members
Display all or a subset of members.
Within the output, the membership coordinator is listed. <vN> identifies which view the member currently has; N will be zero or a positive integer. <ec> indicates which members are eligible to be a membership coordinator.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list members [--group=value]
Parameters, list members:
| Name | Description |
|---|---|
| ‑‑group | Group name for which members will be displayed. |
Example Commands:
list members
list members --group=Group1
Sample Output:
gfsh>list members
Name | Id
------------ | -------------------------------------
Coordinator: | 192.0.2.0(locator1:216:locator)<ec><v6>:33368
locator1 | 192.0.2.0(locator1:216:locator)<ec><v6>:33368
server1 | 192.0.2.0(server1:888)<v7>:10839
server2 | 192.0.2.0(server2:3260)<v8>:16721
list regions
Display regions of a member or members. If no parameter is specified, all regions in the cluster are listed.
Syntax:
list regions [--groups=value(,value)*] [--members=value(,value)*]
Parameters, list regions:
| Name | Description |
|---|---|
| ‑‑groups | Groups of members for which regions will be displayed. |
| ‑‑members | Name or ID of the members for which regions will be displayed. |
Example Commands:
list regions
list regions --groups=G1
list regions --members=member1
Sample Output:
gfsh>list regions
List of regions
---------------
region1
region2
