14.3.6 listcache (displays a list of caches)
- Organization of this subsection
(1) Description
This subcommand displays a list of caches.
(2) Rules
-
This subcommand can be executed only when the status of the cluster is one of the following:
-
Cluster available (AVAILABLE)
-
Cluster partially available (PARTIALLY_AVAILABLE)
-
-
The target of this subcommand is the EADS servers whose cluster participation status is online. This subcommand cannot be executed if the cluster contains any EADS server whose cluster participation status is standby. You can determine the cluster participation status with the eztool status command.
-
This subcommand can be executed when the target EADS servers are in the following status:
-
Initialized
-
Running
-
Closing
-
Closed
-
(3) Format
eztool listcache [-v] [--format format-name] [--columns column-name[,column-name]...] [--filter filter-condition] [--match matching-condition]
(4) Options and arguments
(a) -v or --verbose
Specify this option if you want to display the details of the command's execution results.
(b) --format format-name
For details about this option, see 14.4.2 How to specify the display format.
(c) --columns column-name[,column-name]...
For details about this option, see 14.4.3 How to specify column filters.
(d) --filter filter-condition
For details about this option, see 14.4.4 How to specify row filters.
(e) --match matching-condition
For details about this option, see 14.4.5 How to specify a condition match.
(5) Output example
The following shows an output example of the eztool listcache command's execution results.
For details about the components of the displayed information, see 14.4.1 Components of the displayed information.
If option -v or --verbose is omitted
If option -v or --verbose is specified
The following tables list and describe the summary and content information that are displayed.
No. |
Summary name |
Description |
Whether displayed |
|
---|---|---|---|---|
-v or --verbose option |
||||
Omitted |
Specified |
|||
1 |
CacheCount |
Current and maximum numbers of caches |
Y |
Y |
- Legend:
-
Y: Displayed
No. |
Column name |
Description |
Whether displayed |
|
---|---|---|---|---|
-v or --verbose option |
||||
Omitted |
Specified |
|||
1 |
CacheName |
Cache name# |
Y |
Y |
2 |
CacheType |
Cache type# One of the following is displayed:
|
Y |
Y |
3 |
TotalMasterKeyCount |
Total number of keys in each cache.# This value does not include the number of keys copied for data redundancy purposes. |
Y |
Y |
4 |
Server |
EADS server's IP address and port number used to communicate with the EADS clients. This information is displayed in the following format: IP address:port number Nothing is displayed for an isolated EADS server or if the EADS server has not started. |
N |
Y |
5 |
MasterKeyCount |
Number of keys in each cache on each EADS server. This value does not include the number of keys copied for data redundancy purposes. Nothing is displayed for an isolated EADS server or if the EADS server has not started. |
N |
Y |
- Legend:
-
Y: Displayed
N: Not displayed
- Notes:
-
The execution results are displayed according to the following priorities:
-
Displayed in natural order of the CacheName values.
-
If the -v or --verbose option is specified, the rows for the same CacheName value are displayed in natural order of the Server values.
-
- #
-
If the execution results contain multiple cells with the same value consecutively, only the first such cell is displayed and the other cells are omitted.
(6) Return code
The following table lists the return codes that this subcommand returns.
No. |
Return code |
Description |
|
---|---|---|---|
eads.command.compat parameter omitted in the command properties |
0300 specified in the eads.command.compat parameter in the command properties |
||
1 |
0 |
0 |
Command execution was successful. |
2 |
101 |
101 |
Initialization of the command failed. |
3 |
110 |
Connection establishment failed. |
|
4 |
111 |
The command failed due to a communication timeout. |
|
5 |
120 |
The command failed due to a syntax error. |
|
6 |
130 |
The command failed because it could not be executed. |
|
7 |
150 |
The command failed during execution. |
|
8 |
200 |
The command failed due to a timeout. |
- When the --match option is specified:
-
If the condition was satisfied, the subcommand returns 0; otherwise, the subcommand returns 1. If the command's execution failed, the return code is the same as when the --match option is not specified.
(7) Notes
-
If the command times out during output processing, the output results might not be complete. The command might time out even if output processing is complete. If this happens, increase the command's timeout value, and then re-execute the command.
-
If this subcommand is executed while scale-out processing is underway, a smaller number of keys might be displayed temporarily.