list
List existing Geode resources such as deployed applications, disk-stores, functions, members, servers, and regions.
-
Display a list of async event queues for all members.
-
Displays 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 Geode 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.
-
Displays the gateway senders and receivers for a member or members.
-
Display the list of indexes created for all members.
-
List Lucene indexes created for all members.
-
Display all or a subset of members.
-
Display regions of a member or members. If no parameter is specified, all regions in the Geode distributed system 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
Displays a list of connected clients.
Displays a list of connected clients and the servers they are connected to.
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 [--group=value(,value)*]
Parameters, list deployed:
| Name | Description |
|---|---|
| ‑‑group | Group(s) of members for which deployed JARs will be displayed. If not specified, JARs for all members are displayed. |
Example Commands:
list deployed
list deployed --group=Group2
Sample Output:
gfsh> list deployed --group=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 Geode 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:
gfsh> list disk-stores
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 [--member=value] [--group=value]
Parameters, list durable-cqs:
| Name | Description |
|---|---|
| \-\-durable-client-id | Required. The ID used to identify the durable client. |
| \-\-member | Name or Id of the member for which the durable client is registered and durable CQs will be displayed. |
| \-\-group | Group 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:
gfsh>list durable-cqs --durable-client-id=client1
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] [--group=value(,value)*]
[--member=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 ".*" instead of "*". |
| \-\-group | Group(s) of members for which functions will be displayed. Use a comma separated list for multiple groups. |
| ‑‑member | Name or ID of the member(s) for which functions will be displayed. Use a comma separated list for multiple members. |
Example Commands:
gfsh> list functions
gfsh> list functions --matches=reconcile.*
Sample Output:
list functions
Member | Function
--------- | --------------------------
camelot | loadDataFromExternalSource
camelot | reconcileWeeklyExpenses
excalibur | loadDataFromExternalSource
excalibur | reconcileDailyExpenses
Example of 'list function' with a "matches" filter:
gfsh> list functions --matches=reconcile.*
Member | Function
--------- | -----------------------
camelot | reconcileWeeklyExpenses
excalibur | reconcileDailyExpenses
Example of 'list functions' when no functions are found in Geode :
gfsh> list functions
No Functions Found.
list gateways
Displays 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 [--group=value(,value)*]
Parameters, list gateways:
| Name | Description |
|---|---|
| ‑‑member | Member(s) whose gateways senders and receiver display. |
| \-\-group | Group(s) of members for which Gateway Senders and Receivers will be displayed. Use a comma separated list for multiple groups. |
Example Commands:
list gateways
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:
Example of output when no indexes are found in Geode:
gfsh> list indexes
No Indexes Found
list lucene indexes
Display the list of Lucene indexes created for all members. The optional --with-stats qualifier shows activity on the indexes.
See also create lucene index, describe lucene index, destroy lucene index and search lucene.
Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.
Syntax:
list lucene indexes [--with-stats(=value)]
Parameters, list lucene indexes:
| Name | Description | Default Value |
|---|---|---|
| \-\-with-stats | Specifies whether statistics should also be displayed. | false if not specified, true if specified |
Example Commands:
list lucene indexes
Sample Output:
gfsh>list lucene indexes --with-stats
Index Name | Region Path | Indexed Fields | Field Analy.. | Status | Query Executions | Updates | Commits | Documents
testIndex | /testRegion | [__REGION_VALUE_FIELD] | {__REGION_V.. | Defined | NA | NA | NA | NA
gfsh>list lucene indexes
Index Name | Region Path | Indexed Fields | Field Analy.. | Status
analyzerIndex | /Person | [revenue, address, name, email] | {revenue=St.. | Initialized
customerIndex | /Customer | [symbol, revenue, SSN, name, email, address, __REGION_VALUE_FIELD] | {} | Initialized
pageIndex | /Page | [id, title, content] | {} | Initialized
personIndex | /Person | [name, email, address, revenue] | {} | Initialized
list members
Display all or a subset of members.
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
server1 | GemFireStymon(server1:888)<v7>:10839
server2 | GemFireStymon(server2:3260)<v8>:16721
locator1 | localhost(locator1:216:locator):33368
list regions
Display regions of a member or members. If no parameter is specified, all regions in the Geode distributed system are listed.
Syntax:
list regions [--group=value] [--member=value]
Parameters, list regions:
| Name | Description |
|---|---|
| \-\-group | Group of members for which regions will be displayed. |
| \-\-member | Name or ID of the member of the member for which regions will be displayed. |
Example Commands:
list regions
list regions --group=G1
list regions --member=member1
Sample Output:
gfsh>list regions
List of regions
region1
region2