14.3.8 listgroup (displays a list of group names)

(1) Description

This subcommand displays a list of the group hierarchy names of the groups in the highest hierarchy that are stored in a cache.

To Page Top

(2) Rules

• You can execute this subcommand when the EADS server is running.

• This subcommand executes in descending order of the EADS server positions (Position).

• This subcommand can be executed if the number of groups at the highest hierarchy in the target range does not exceed 1,000, based on a check performed prior to execution of the subcommand.

To Page Top

(3) Format

eztool listgroup [-s] [-v] [-f maximum-number-of-groups-during-forced-execution]
                 cache-name
                 [--format format-name]
                 [--columns column-name[,column-name]...]
                 [--filter filter-condition]
                 [--match matching-condition]

To Page Top

(4) Options and arguments

To Page Top

(5) Output example

The following shows output examples of the eztool listgroup 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.

Table 14‒19: Summary information displayed by the eztool listgroup command

No.	Summary name	Description	Whether displayed
			-v or --verbose option
			Omitted	Specified
1	GroupCount	Number of groups in the highest hierarchy that are stored on EADS servers	Y	Y

Legend:

Y: Displayed

Table 14‒20: Content information displayed by the eztool listgroup command

No.	Column name	Description	Whether displayed
			-v or --verbose option
			Omitted	Specified
1	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	Y	Y
2	Position	Location (hash value) of an EADS server#	Y	Y
3	ID	EADS server ID#	Y	Y
4	GroupName	Group hierarchy name in the highest hierarchy	Y	Y
5	HashValue	Location (hash value) of a group in the highest hierarchy	N	Y
6	KeyCount	Number of keys belonging to the groups in the highest hierarchy	N	Y

Legend:

Y: Displayed

N: Not displayed

Notes:

The execution results are displayed according to the following priorities:

1. The results are displayed in descending order of the Position values.

2. The rows with the same Position value are displayed in natural order of the GroupName values. If the -v or --verbose option is specified, the rows with the same Position value are displayed in descending order of the HashValue 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.

To Page Top

(6) Return code

The following table lists the return codes that this subcommand returns.

Table 14‒21: Return codes returned by the eztool listgroup command

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	120		The command failed due to a syntax error.
4	150		The command failed during execution.
5	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.

To Page Top

(7) Notes

• This subcommand enables you to check a list of group hierarchy names in the highest hierarchy without having to create an application program. However, if the number of groups in the highest hierarchy in the target range exceeds 1,000, you need to create an application program.

• If group hierarchy names in the highest hierarchy are added while this subcommand is executing, the following occurs, depending on the area where the group hierarchy names are stored:

  • If the group hierarchy names are stored in an area for which group names have already been acquired

    The added group hierarchy names are not displayed in the list.

  • If the group hierarchy names are stored in an area for which group names have not been acquired

    The added group hierarchy names are displayed in the list.

  Note that the number of group hierarchy names in the highest hierarchy is checked before the list of group names is actually acquired. If a large number of keys that include new group names are added after that check, the group names that exceed the maximum value are included in the display.

• 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 the target range contains a large number of group names, the amount of resources required for processing increases.

• The number of keys that do not belong to a group cannot be checked.

• If EADS servers are added to or restored in the cluster while this subcommand is executing, the added or restored EADS servers are not included as processing targets. As a result, some group names might not be displayed. If this occurs, re-execute the subcommand.

To Page Top