18.2.1 Explanation of the specification format and options

Organization of this subsection

(1) Specification format
(2) Purpose of executing the adbinfoget command and combination of options
(3) Explanation of options

(1) Specification format

adbinfoget {-g | -m | -o troubleshooting-information-files-output-directory}
           [-f core-file-name] [-l] [-r]

To Page Top

(2) Purpose of executing the adbinfoget command and combination of options

The following table shows the options to be specified depending on the purpose of executing the adbinfoget command.

For details about each option, see (3) Explanation of options.

Table 18‒1: Options to be specified in the adbinfoget command
No.	Purpose of executing the adbinfoget command		Option to be specified
1	Outputting troubleshooting information while the HABD server is running	Output information for troubleshooting-information file (detailed version) (and output core files and HADB dumps).	`-g`
2		Output information for the mail, light, and root versions of troubleshooting-information files (and output HADB dumps only).	`-g` and `-l`
3	Estimating the output size of the troubleshooting-information files	Estimate the output size of the light, detailed and root versions of the troubleshooting-information files.^#1	`-m` and `-r`
4		Estimate the output size of the light, detailed, and root versions of the troubleshooting-information files (when the `-f` option is specified for collecting the troubleshooting-information files).	`-m`, `-f`, and `-r`
5	Collecting troubleshooting-information files	Collect the mail, light, and detailed versions of the troubleshooting-information files (when the core files to be collected are not specified^#2).	`-o` and `-r`
6		Collect the mail, light, detailed, and root versions of the troubleshooting-information files (and collect the core file specified in the `-f` option).	`-o`, `-f`, and `-r`
7		Collect only the mail, light, and root versions of the troubleshooting-information files.	`-o`, `-l`, and `-r`

#1

If the adb_core_path operand in the server definition is not specified, a value that includes the size of the latest core file located under the $DBDIR/SPOOL directory is estimated.

If the adb_core_path operand in the server definition is specified, a value that includes the size of the latest error information (core file) located under the directory specified in the adb_core_path operand in the server definition is estimated.

#2

If the adb_core_path operand in the server definition is not specified, the latest core file located under the $DBDIR/SPOOL directory is collected.

If the adb_core_path operand in the server definition is specified, the latest core file located under the directory specified in the adb_core_path operand in the server definition is collected.

To Page Top

(3) Explanation of options

• -g

Specify this option when outputting troubleshooting information shown in the following table while the HABD server is running. The information to be output is determined depending on whether the -l option is specified with this option.

Table 18‒2: Troubleshooting information to be output
No.	Troubleshooting information to be output	If the -l option is not specified	If the -l option is specified	Output directory
1	Core files	Yes	No	`$DBDIR/SPOOL` directory, or the directory specified in the `adb_core_path` operand in the server definition
2	HADB dumps	Yes	Yes	`$ADBDIR/spool` directory

Legend:

Yes: Information is output.

No: Information is not output.

HADB server operation is paused while information is being output.

Note: You can specify this option only while the HADB server is running.

• -m

Specify this option when estimating the output size of a troubleshooting-information file. If you specify this option, the troubleshooting-information file is not collected.

Instead, the command estimates the sizes of the light and detailed versions of the troubleshooting-information files that will be output.

The mail version of the troubleshooting-information files is generated by extracting part of the light version of the troubleshooting-information files. Consequently, the estimated size of the mail version of the troubleshooting-information files is included in the estimated size of the light version of the troubleshooting-information files. Therefore, even when this option is specified, the command does not estimate the size of the mail version of the troubleshooting-information files alone.

• -o troubleshooting-information-files-output-directory

~<path name>((2 to 118 bytes))

Specifies the absolute path name of the directory to which the troubleshooting-information files are to be output.

Write and execution privileges must have been granted in advance to the HADB administrator for the directory specified in this option.

• -f core-file-name

~<path name>((2 to 510 bytes))

Normally, you will omit this option.

Specifies the absolute path of a core file in the following cases:

The adbstart was executed after the adbinit command was executed, but the HADB server's start processing failed.
The adbstart command was executed after the HADB server was replaced, but the HADB server's start processing failed.
You wish to collect as troubleshooting information a core file containing specific error information from among all the error information output when the HADB server terminated abnormally
The kernel.core_pattern kernel parameter is specified, but no error information (core file) was output under the $DBDIR/SPOOL directory or the directory specified in the server definition's adb_core_path operand.

For cases 1 and 2 above, specify the absolute path of the following error information (core file), as appropriate:

If the adb_core_path operand is omitted in the server definition

Error information (core file) under the $DBDIR/SPOOL directory
If the adb_core_path operand is specified in the server definition

Error information (core file) under the directory specified in the adb_core_path operand in the server definition

For case 4, specify the absolute path of the error information (core file) under the directory specified in the kernel.core_pattern kernel parameter.

If this option is omitted, one of the following core files containing error information is collected as troubleshooting information:

If the adb_core_path operand is omitted in the server definition

The core file under the $DBDIR/SPOOL directory that contains the most recent error information
If the adb_core_path operand is specified in the server definition

The core file under the directory specified in the adb_core_path operand in the server definition that contains the most recent error information

• -l

Specify this option in the following cases:

When outputting troubleshooting information (with the -g option specified together)

If core files need not be output, specify this option. If you specify this option together with the -g option, a core file is not output (only HADB dumps are output).

Because a core file is very large, the mail, light, and root versions of a troubleshooting-information file do not include a core file. Therefore, if you know that the detailed version of troubleshooting information will not be collected, specify this option together with the -g option. For details about troubleshooting information that is output when the -g option is specified, see Table 18‒2: Troubleshooting information to be output.

If you omit this option and specify the -g option, core files and HADB dumps are output.
When collecting troubleshooting-information files (without the -g option specified)

Specifies that only the mail and light versions of the troubleshooting-information files are to be collected. You specify this option when the detailed version of the troubleshooting-information files is too large to collect.

When this option is omitted, the command collects the mail, light, and detailed versions of the troubleshooting-information files.

Because a core file is very large, the mail, light, and root versions do not include a core file. Therefore, if the -l option is specified together with the -f option, the core file specified in the -f option will not be collected.

• -r

Specify this option in any of the following cases:

You need to estimate the size of the root version of troubleshooting information that will be output, in addition to the light and detailed versions of troubleshooting information that will be output.
You need to acquire the root version of the troubleshooting-information files in addition to the mail, light, and detailed versions of troubleshooting information.
You need to collect the root version of the troubleshooting-information files in addition to the mail and light versions of troubleshooting information.

When you execute the adbinfoget command with this option specified, the OS's su command is executed by the adbinfoget command. It then collects the root version of the troubleshooting-information files by executing OS commands that require root privileges, and by referencing system files that require root privileges. Therefore, when you execute the adbinfoget command with this option specified, enter a superuser password when requested.

If execution of the OS's su command fails, the output size of all troubleshooting-information files (the detailed, light, mail, and root versions) is not estimated. In addition, none of the troubleshooting-information files is collected.

To Page Top