jegn_log.bat (Windows only)
- Organization of this page
Function
This is a tool for collecting data in the event of a problem in JP1/IM - EG for NNMi. The data collected by this tool includes JP1/IM - EG for NNMi maintenance data, OS system information, and integrated trace logs.
This tool is a batch file. It cannot be customized by the user.
When you execute this tool, the data is classified into primary and secondary data categories and stored directly under the specified data storage folder.
Primary data is collected for purposes such as identifying an error and investigating the causes of a minor problem. It consists of the minimum amount of log information and settings files. Secondary data provides the detailed information needed for an in-depth investigation of an error. It consists of data such as the Windows event log, a crash dump, and the JP1/Base event database.
If necessary, use a program such as a compression tool to compress the collected data.
For details about the data that can be collected by this tool, see 10.3.1 Data to be collected (in Windows).
Format
jegn_log.bat -f data-storage-folder-name [-h logical-host-name] [-t] [-n] [-p] [-r] [-q]
Execution permission
Administrator permissions. If UAC is enabled, however, execute the command from the administrator console.
Storage directory
EG-for-NNMi-path\tools
Arguments
-f data-storage-folder-name
Specifies the name of the folder to which the collected data is to be output, expressed as an absolute path or a path relative to the location where the command is executed. If the path contains a space, enclose the entire path in double-quotation marks ("). This option is mandatory.
If a nonexistent folder is specified, a new folder is created with the specified name. If an existing folder is specified, the contents of that folder are deleted and then the specified folder is created. Do not specify the name of a folder that contains files that you do not want to delete.
-h logical-host-name
Specifies the name of the logical host when you are operating in a cluster system. The permitted length is from 1 to 255 characters (bytes). When this option is specified, the command collects data for the logical host as well as for the physical host. If this option is omitted, the command collects data for the physical host only. If you are not using a cluster system, there is no need to specify this option.
If this option is omitted when you are not operating in a cluster system, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. However, if you omit this option while you are operating in a cluster system, the logical host name specified in the JP1_HOSTNAME environment variable will not be assumed. Therefore, when you use a cluster system, you must specify the logical host name in this option.
-t
Specifies that the hosts and services files are not to be collected.
-n
Specifies that the maintenance data for JP1/Base is not to be collected.
-p
Specifies that the JP1/Base event database is not to be collected.
-r
Specifies that the command execution log files for JP1/Base are not to be collected.
-q
Specifies that there is no need to wait for a response confirming that data collection processing is to be resumed.
If the -q option is omitted, the system waits for a response when it displays a message asking whether the processing is to be resumed.
Notes
-
A huge amount of data can be collected by this tool. Before you execute this tool, you must estimate the amount of storage space that will be required and check the available space on your machine. For details about the amount of data that can be collected, see the Release Notes for JP1/IM - EG for NNMi.
-
Do not execute this tool more than once. If it is executed multiple times, the collected data might be overwritten or data collection might fail.
-
If a file to be collected cannot be found, the tool might display a message such as The file was not found; however, no action is necessary in such a case.
-
If you execute the data collection command in Windows, the prompt Refreshing System Information... appears, but do not click the Cancel button. If you click the Cancel button, part of the information cannot be collected.
Return values
0 |
Normal termination |
8 |
Abnormal termination |