14.3.4 status (checks the status of the cluster)

Organization of this subsection

(1) Description
(2) Rules
(3) Format
(4) Options and arguments
(5) Output example
(6) Return code
(7) Notes

(1) Description

This subcommand checks the status of the cluster.

To Page Top

(2) Rules

This subcommand can be executed regardless of the cluster's status.
This subcommand can be executed when the EADS servers are in the following status:
- Initializing
- Initialized
- Running
- Closing
- Closed
- Isolated
- Stopping

To Page Top

(3) Format

eztool status [-v]
              [-s]
              [-c display-item-name==status]
              [--format format-name]
              [--columns column-name[,column-name]...]
              [--filter filter-condition]
              [--match matching-condition]

To Page Top

(4) Options and arguments

(a) -v or --verbose

Specify this option if you want to display the details of the command execution results.

(b) -s or --single

Specify this option to check the status of only the EADS server on which the command is executed, not the status of the entire cluster.

(c) -c display-item-name==status or --count display-item-name==status

We do not recommend that you specify this option. This option might be deleted without notice.

Specify this option to verify that all EADS servers participating in the cluster have the same status.

The subcommand sets as the return code the number of EADS servers whose status exactly matches the specified status. Note that items for which a hyphen (-) is displayed because the information could not be acquired are not counted.

This option cannot be specified together with any of the following options:

-s option
--format option
--columns option
--filter option
--match option

Display item names

The following table lists and describes the display item names that can be specified:

Display item name	Description	Whether displayed
		-v or --verbose option
		Omitted	Specified
`ID`	EADS server ID	Y	Y
`IP_Address`	IP address of EADS server	Y	Y
`ServerName`	EADS server name (management directory name)	N	Y
`Port`^#1	EADS server's port number used for communication with EADS clients	Y	Y
`ServerPort`^#2	Port number used for creating redundant copies of data among the EADS servers	N	Y
`ManagePort`^#2	Port number used for checking the communication port that will be used by the command	N	Y
`Position`	EADS server position	Y	Y
`Cluster`	Cluster participation status	Y	Y
`State`	EADS server status	Y	Y
`Operation`	Name of the subcommand or option of the command that is currently executing	Y	Y
`Lock`	Lock status of the EADS server	N	Y
`KeyCount`	Total number of keys in the EADS server	N	Y
`UsedCache`^#2	Memory usage rate in the area for storing the value part of the memory caches or two-way caches (explicit heap) on the EADS server (`memory usage amount` divided by `total memory capacity`)	N	Y
`UsedMemoryRatio`^#3	Memory usage rate in the area for storing the value part of the memory caches or two-way caches (explicit heap) on the EADS server	N	Y
`UsedMemory`^#3	Memory usage amount in the area for storing the value part of the memory caches or two-way caches (explicit heap) on the EADS server (megabytes)	N	Y
`MaxMemory`^#3	Total memory capacity of the area for storing the value part of the memory caches or two-way caches on the EADS server (megabytes)	N	Y
`Version`	Version information	N	Y

Legend:

Y: Displayed

N: Not displayed

#1: If 0300 is specified in the eads.command.compat parameter in the command properties, the item name is ClientPort.
#2: This item can be specified only when 0300 is specified in the eads.command.compat parameter in the command properties.
#3: This item cannot be specified if 0300 is specified in the eads.command.compat parameter in the command properties.

Status

Specify a character string that can be displayed for the specified displayed item name.

The permitted characters are ASCII codes 0x20 through 0x7E.

You can specify a single-byte space by enclosing it in double quotation marks ("). Any single byte spaces before or after a display item name in the table or before or after the status are ignored.

Because a hyphen (-) is displayed for an item whose information cannot be obtained, specifying only a hyphen (-) will result in an error. If 0300 is specified in the eads.command.compat parameter in the command properties, an asterisk (*) is displayed for an item whose information cannot be obtained. In this case, specifying only an asterisk (*) results in an error.

(d) --format format-name

For details about this option, see 14.4.2 How to specify the display format.

(e) --columns column-name[,column-name]...

For details about this option, see 14.4.3 How to specify column filters.

(f) --filter filter-condition

For details about this option, see 14.4.4 How to specify row filters.

(g) --match matching-condition

For details about this option, see 14.4.5 How to specify a condition match.

To Page Top

(5) Output example

The following shows output examples of the eztool status command's execution results.

For details about the components of the displayed information, see 14.4.1 Components of the displayed information.

[Figure] If option -v or --verbose is omitted

[Figure]

[Figure] If option -v or --verbose is specified

[Figure]

The following tables list and describe the summary and content information that are displayed.

Table 14‒6: Summary information displayed by the eztool status command
No.	Summary name	Description	Whether displayed
			-v or --verbose option
			Omitted	Specified
1	`Cluster` `Health`	Cluster status One of the following is displayed: `AVAILABLE` The cluster is running normally. `PARTIALLY_AVAILABLE` The cluster is partially running. The cluster might not be accessible depending on the key. `NOT_AVAILABLE` The cluster is not running.	Y	Y
2	`TotalCount`	Number of EADS servers This item is not displayed if the `-s` or `--single` option is specified.	Y	Y
3	`OnlineCount`	Number of EADS servers that are participating in the cluster This item is not displayed if the `-s` or `--single` option is specified. This item is not counted if the cluster status is `NOT_AVAILABLE`.	Y	Y
4	`OfflineCount`	Number of EADS servers that are not participating in the cluster This item is not displayed if the `-s` or `--single` option is specified. This item is not counted if the cluster status is `NOT_AVAILABLE`.	Y	Y
5	`StandbyCount`	Number of EADS servers that are designated to participate in the cluster This item is not displayed if the `-s` or `--single` option is specified. This item is not counted if the cluster status is `NOT_AVAILABLE`.	Y	Y

Legend:: Y: Displayed

Table 14‒7: Content information displayed by the eztool status command
No.	Column name	Description	Whether displayed
			-v or --verbose option
			Omitted	Specified
1	`ID`	EADS server ID. If an EADS server to be added to the cluster has not participated in the cluster, a hyphen (`-`) is displayed as its EADS server ID.	Y	Y
2	`IP_Address`	IP address of EADS server	Y	Y
3	`ServerName`	EADS server name (management directory name)^{#1, #2}	N	Y
4	`Port`^#3	EADS server's port number used for communication with EADS clients	Y	Y
5	`ServerPort`^#4	Port number used for creating redundant copies of data among the EADS servers^#2	N	Y
6	`ManagePort`^#4	Port number used for checking the communication port that will be used by the command^#2	N	Y
7	`Position`	EADS server position The positions (hash values) are displayed in descending order. If an EADS server to be added to the cluster has not participated in the cluster, a hyphen (`-`) is displayed as its position.	Y	Y
8	`Cluster`	Cluster participation status.^#5 One of the following is displayed: `online` Participating in the cluster. `offline` Not participating in the cluster. `standby` Designated to participate in the cluster.	Y	Y
9	`State`	EADS server status.^{#1, #2}	Y	Y
10	`Operation`	Name of the subcommand or option of the command that is currently executing^{#1, #2} One of the following is displayed: `close` `open` `unlock` `createcache` `deletecache` `export` `import` `deleteesd` `resume` `importecf` `deleteecf` `compaction` `stop` `isolate` `recovery` `add` For `export`, `import`, `importecf`, and `stop`, the progress of the processing is also displayed. Example: `export(88%)` If the command is not executing, `none` is displayed.	Y	Y
11	`Lock`	Lock status of the EADS server.^#5 One of the following is displayed: `lock` Locked. `unlock` Not locked.	N	Y
12	`KeyCount`	Total number of keys in the EADS server.^{#1, #2} This value includes the number of keys copied for data redundancy purposes.	N	Y
13	`UsedCache`^#4	Memory usage rate in the area for storing the value part of the memory caches or two-way caches (explicit heap) on the EADS server (`memory usage amount` divided `total memory capacity`)^{#1, #2} The digits after the decimal point are truncated. The memory usage amount includes the values that were copied for data redundancy purposes.	N	Y
14	`UsedMemoryRatio`^#6	Memory usage rate in the area for storing the value part of the memory caches or two-way caches (explicit heap) on the EADS server^{#1, #2} Because the memory usage rate equals (`memory usage amount` `total memory capacity`) 100 (%), the digits after the decimal point are truncated. The memory usage amount includes the values that were copied for data redundancy purposes.	N	Y
15	`UsedMemory`^#6	Memory usage amount in the area for storing the value part of the memory caches or two-way caches (explicit heap) on the EADS server^{#1, #2} (megabytes) The digits after the decimal point are truncated. The memory usage amount includes the values that were copied for data redundancy purposes.	N	Y
16	`MaxMemory`^#6	Total memory capacity of the area for storing the value part of the memory caches or two-way caches on the EADS server^{#1, #2} (megabytes) The digits after the decimal point are truncated. The memory usage amount includes the values that were copied for data redundancy purposes.	N	Y
17	`Version`	Version information^{#1, #2} For 03-00, `03-00-00` is displayed.	N	Y

Legend:

Y: Displayed

N: Not displayed

#1

In the case of a connection failure, communication error, or communication timeout, a hyphen (-) is displayed. If 0300 is specified in the eads.command.compat parameter in the command properties, an asterisk (*) is displayed.

#2

If the EADS server's cluster participation status is standby, a hyphen (-) is displayed. If 0300 is specified in the eads.command.compat parameter in the command properties, an asterisk (*) is displayed.

#3

If 0300 is specified in the eads.command.compat parameter in the command properties, ClientPort is displayed as the column name.

#4

The column is displayed only when 0300 is specified in the eads.command.compat parameter in the command properties.

#5

If the cluster status is NOT_AVAILABLE, a hyphen (-) is displayed. If 0300 is specified in the eads.command.compat parameter in the command properties, an asterisk (*) is displayed.

#6

The column is not displayed if 0300 is specified in the eads.command.compat parameter in the command properties.

To Page Top

(6) Return code

The return code depends on whether any of the following options was specified:

-s or --single option
-c or --count option
--match option

If none of the -s, -c, and --match options was specified, the return codes listed in the following table are returned.

Table 14‒8: Return codes returned by the eztool status command (when none of the -s, -c, and --match options was specified)
No.	Return code		Description
No.	eads.command.compat parameter omitted in the command properties	0300 specified in the eads.command.compat parameter in the command properties	Description
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	`150`		The command failed during execution.
7	`200`		The command failed due to a timeout.

When the -s or --single option is specified:

The subcommand sets the EADS server's status as the return code.

If the --match option was also specified and the command's execution was successful, the results of the --match option take precedence.

Table 14‒9: Return codes returned by the eztool status command (when the -s or --single option was specified)
No.	Return code		Description
No.	eads.command.compat parameter omitted in the command properties	0300 specified in the eads.command.compat parameter in the command properties	Description
1	`0`	`0`	The EADS server is running (`running`).
2	`1`	`1`	The EADS server is being initialized (`initializing`).
3	`2`	`2`	The EADS server has been initialized (`initialized`).
4	`3`	`3`	The EADS server is closing (`closing`).
5	`4`	`4`	The EADS server is closed (`closed`).
6	`5`	`5`	The EADS server is stopping (`stopping`).
7	`10`	`10`	The EADS server is isolated (`isolated`).
8	`101`	`101`	Initialization of the command failed.
9	`110`	`110`	Connection establishment failed.
10	`111`	`111`	The command failed due to a communication timeout.
11	`120`	`101`	The command failed due to a syntax error.
12	`150`		The command failed during execution.
13	`200`		The command failed due to a timeout.

When the -c or --count option is specified:: The subcommand sets as the return code the number of EADS servers for which the specified item is in the specified status. If the command's execution failed, the return code is the same as when the -c or --count option was not specified.
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 was not specified.

To Page Top

(7) Notes

If the EADS server with the smallest EADS server ID is not running, no other EADS servers can participate in the cluster. If this command is executed on an EADS server that is not participating in the cluster, information about only the EADS server on which the command was executed is displayed even when several other EADS servers are running.
If this command is executed on an EADS server for which restoration processing is underway, information about other EADS servers is not displayed until the EADS server has been restored.
If this subcommand is executed on an EADS server that is engaged in scale-out processing, information about the other EADS servers is not displayed until this EADS server participates in the cluster.
If there are only isolated EADS servers, outdated information might be displayed because the cluster information has not been updated.
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.

To Page Top