1.7.5 hcmds64getlogs (collecting log information)

Description

This command collects log information recorded during JP1/AO operation to output the information to the archive file.

Syntax

hcmds64getlogs
     /dir output-folder-path
     [/types Automation]
     [/arc archive-file-name]
    [/logtypes {log | db | csv}]

Arguments

/dir output-folder-path

This option specifies the path to the folder in which the archive file is output. A folder on the local disk drive can only be specified.

You must specify the absolute or relative path to an empty folder for output-folder-path. If the specified folder path does not exist, then that folder is newly created.

The maximum length of the path name is 100 characters. The system grants write permission to the folder specified by this option.

/types Automation

This option specifies Automation as the name of the product whose log information is to be collected. If the JP1/AO server OS is Windows, this option is not case sensitive. If the JP1/AO server OS is Linux, the option is case sensitive. If this option is omitted, the command has an effect on JP1/AO and all the installed Hitachi Command Suite products. Note that, in this case, it might take longer to collect log information.

/arc archive-file-name

This option specifies the name of the archive file created as a result of execution of the data collection tool for Common Component. If this option is not specified, the archive file is named HiCommand_log.

The archive file is output under the folder specified in the /dir option.

The possible characters for the archive file name are printable ASCII characters (ranged from 0x20 to 0x7E in the ASCII code) except for some of the special characters (\, /, :, ,, ;, *, ?, ", <, >, |, $, %, &, ', and `). The extension is not necessary.

/logtypes {log | db | csv}

This option specifies the type of a log file for Common Component that you want to collect. The following table lists the relationship between the log file type and the log files that can be collected.

Table 1‒15: Log file types and log files that can be collected

Log file type	Log file that can be collected (Windows)	Log file that can be collected (Linux)
log	archive-file-name-specified-in-the-arc-option.jar archive-file-name-specified-in-the-arc-option.hdb.jar	archive-file-name-specified-in-the-arc-option_64.jar archive-file-name-specified-in-the-arc-option_64.hdb.jar
db	archive-file-name-specified-in-the-arc-option.db.jar	archive-file-name-specified-in-the-arc-option_64.db.jar
csv	archive-file-name-specified-in-the-arc-option.csv.jar	archive-file-name-specified-in-the-arc-option_64.csv.jar

If this option is omitted, the system collects all the log files for Common Component. Because of this, we recommend that you execute the command without this option.

You can specify multiple log file types by entering them separated by half-width space characters such as logtypes log db csv. If you use the /types and logtypes options at the same time, you must specify log for the logtypes option.

Output format

The table below shows the list of data collected by the command.

Note that the file content and output format are not disclosed.

#1:

The Windows-folder is defaulted to C:\WINDOWS.

#2:

The Program-Files-folder is defaulted to C:\Program Files.

Located in

In Windows:

Common-Component-installation-folder\bin

In Linux:

/opt/HiCommand/Base64/bin

Execute permission

Execute the command as a user with Administrator or root permissions.

Remarks

• Do not interrupt this command while it is running.

• If the hcmds64getlogs command is interrupted, this command has terminated before this command completed due to insufficient free space in the folder specified in the dir option. In this case, make sure that the folder has enough free space, and then execute this command again.

• Do not execute more than one hcmdsgetlogs command at the same time.

• When JP1/AO is running in a cluster configuration, execute this command on both the active host and standby host.

  You can execute this command even if the JP1/AO server is not running. Therefore, even if an error occurs in a cluster configuration, you can collect log information without switching nodes. However, if the database is not running, you cannot obtain the database information.

• If the same option is specified more than once, only the first option is effective.

Return code

The following table lists the return codes from the command.

Example

The following example shows how to use the command to collect, in Windows, log information in the specified folder (C:\Users\folder01):

hcmds64getlogs /dir "C:\Users\folder01" /types Automation /arc AO_log