14.3.5 listconf (displays a list of most recent parameters)
- Organization of this subsection
(1) Description
This subcommand displays a list of parameters that begin with eads. and are specified in the EADS server's system properties. For any parameter that has been set for version 03-60 or earlier, the new parameter name is displayed.
(2) Rules
-
This subcommand can be executed on an EADS server that is in any of the following statuses, regardless of the cluster's status:
-
Initializing
-
Initialized
-
Running
-
Closing
-
Closed
-
Isolated
-
Stopping
-
(3) Format
eztool listconf [-v] [-s] [--file property-file-type] [--non_default] [--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) -s or --single
Specify this option to check the parameters in the property file for only the EADS server on which the command is executed, not for the entire cluster.
(c) --file property-file-type
Specify this option to check only those parameters that are specified in a specific property file.
You can specify any of the following types of property files:
-
server: Server property file
-
cluster: Cluster property file
-
shared: Shared property file
If this option is omitted, the parameters that are specified in all of the following property files are displayed:
-
Server property file
-
Cluster property file
-
Shared property file
(d) --non_default
This option displays for the EADS servers only the parameters whose settings are not the default values. Parameters for which there is no default value are not subject to this option.
(e) --format format-name
For details about this option, see 14.4.2 How to specify the display format.
(f) --columns column-name[,column-name]...
For details about this option, see 14.4.3 How to specify column filters.
(g) --filter filter-condition
For details about this option, see 14.4.4 How to specify row filters.
(h) --match matching-condition
For details about this option, see 14.4.5 How to specify a condition match.
(5) Output example
The following shows output examples of the eztool listconf 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 |
ParameterCount |
Number of parameters. |
Y |
Y |
2 |
NonDefaultCount |
Number of EADS server parameters whose settings are not the default value |
Y |
Y |
- Legend:
-
Y: Displayed
No. |
Column name |
Description |
Whether displayed |
|
---|---|---|---|---|
-v or --verbose option |
||||
Omitted |
Specified |
|||
1 |
Parameter |
Parameter name. Displayed in natural order. |
Y |
Y |
2 |
DefaultValue |
Parameter's default value. Nothing is displayed for a parameter that does not have a default value. If the default value varies from one EADS server to another, UNMATCH is displayed. |
Y |
Y |
3 |
MinValue |
Minimum value of the parameter (numeric value). Nothing is displayed for a parameter in which a nonnumeric value can be specified. If the minimum value varies from one EADS server to another, UNMATCH is displayed. |
N |
Y |
4 |
MaxValue |
Maximum value of the parameter (numeric value). Nothing is displayed for a parameter in which a nonnumeric value can be specified. If the maximum value varies from one EADS server to another, UNMATCH is displayed. |
N |
Y |
5 |
MinLength |
Minimum length for a character string in the parameter. Nothing is displayed for a parameter that does not have a minimum length. If the minimum length varies from one EADS server to another, UNMATCH is displayed. |
N |
Y |
6 |
MaxLength |
Maximum length for a character string in the parameter. Nothing is displayed for a parameter that does not have a maximum length. If the maximum length varies from one EADS server to another, UNMATCH is displayed. |
N |
Y |
7 |
ServerID:EADS-server-ID |
Parameter's setting on each EADS server. Information is displayed for all EADS servers for which information was acquired, in ascending order of the EADS server IDs. If the -s or --single option is specified, information about only the EADS server on which the command was executed is displayed. If an EADS server ID is undetermined because an EADS server to be added to the cluster has not participated in the cluster, a hyphen (-) is displayed for EADS-server-ID. |
Y |
Y |
- Legend:
-
Y: Displayed
N: Not displayed
(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.
-
The values set in system properties are the verified values, not the specified values themselves. When parameter values are used as functions, different values might be used for some parameters.