14.3.22 listfunc (displays which user functions are executable)

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 displays which user functions are executable.

To Page Top

(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

To Page Top

(3) Format

eztool listfunc [-v] [user-function-name]
                [--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) user-function-name

Specify the name of a user function whose executability you want to display.

Specify this option if you want to display information about only the specified user function.

A user function name can consist of alphanumeric characters (0 to 9, A to Z, and a to z), underscores (_), periods (.), and dollar signs ($).

There is no limit to the number of characters.

(c) --format format-name

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

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

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

(e) --filter filter-condition

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

(f) --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 listfunc command's execution results.

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

(a) If option -v or --verbose is omitted

[Figure]

The following tables list and describe the summary and content information that are displayed when the -v or --verbose option is omitted.

Table 14‒41: Summary information displayed by the eztool listfunc command (-v or --verbose option omitted)
No.	Summary name	Description
1	`FunctionCount`	Total number of user functions This information is not displayed when a user function name is specified.

Table 14‒42: Content information displayed by the eztool listfunc command (-v or --verbose option omitted)
No.	Column name	Description
1	`FunctionName`	User function name When a user function name is specified, only the specified user function name is displayed. Displayed in natural order.
2	`Enable`	Number of EADS servers that can execute the user function
3	`Disable`	Number of EADS servers that cannot execute the user function

(b) If option -v or --verbose is specified

[Figure]

The following tables list and describe the summary and content information that are displayed when the -v or --verbose option is specified.

Table 14‒43: Summary information displayed by the eztool listfunc command (-v or --verbose option specified)
No.	Summary name	Description
1	`FunctionCount`	Total number of user functions This information is not displayed when a user function name is specified.

Table 14‒44: Content information displayed by the eztool listfunc command (-v or --verbose option specified)
No.	Column name	Description
1	`Server`	EADS server's IP address and the port number used to communicate with the EADS client. This information is displayed in the following format: `IP-address:port-number`
2	`FunctionName`	User function name When a user function name is specified, only the specified user function name is displayed.
3	`Status`	Whether the user function can be executed One of the following is displayed: `enable` Can be executed. `disable` Cannot be executed. If the specified user function does not exist, `none` is displayed.

Notes:

The execution results are displayed according to the following priorities:

Displayed in natural order of the Server values.
Rows with the same Server value are displayed in natural order of the FunctionName values.

To Page Top

(6) Return code

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

Table 14‒45: Return codes returned by the eztool listfunc command
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	`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.

To Page Top

(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.

To Page Top