9.16 npsnapshotlog command (collect troubleshooting information)
Description
This command collects as a ZIP file the information needed for troubleshooting (such as log files and environment setting files). Note that this command does not collect information that is not mentioned here.
Troubleshooting information is classified into primary materials and secondary materials. The primary materials and the secondary materials are output to separate files.
- Primary materials file
-
npsnapshotlog_yyyyMMddhhmmssSSS_1.zip
- Secondary materials file
-
npsnapshotlog_yyyyMMddhhmmssSSS_2.zip
The following table lists and describes the troubleshooting information that is collected by this command by default as the primary materials.
- #
-
This is the default directory. The actual directory might be different depending on the value of the ucnp.setup.server.portal.trace.dir property specified in the user setup property file (ucnp_setup_user.properties).
The following table lists and describes the troubleshooting information that is collected by this command by default as the secondary materials.
Format
npsnapshotlogΔdirectory-to-which-troubleshooting-information-is-output
You can specify for the directory an absolute path or a relative path. We recommend that you specify a path with a length of 200 characters or less so that the path will not become too long.
Use backslashes (\) for the delimiters. If a path contains a single-byte space, enclose the entire path in double quotation marks ("). In addition to these symbols, the only other symbols permitted in directory paths are single-byte colons (:) and single-byte periods (.) that indicate relative paths.
Notes:
-
The directory to which troubleshooting information is to be output must satisfy the following conditions:
-
There is at least 500 MB of free space.
-
The directory is not a network drive.
If you have increased from their default values the maximum size and number of output files for various log files that are collected as troubleshooting information, a free space of more than 500 MB might be required.
-
-
If you are using support services, you need to collect the troubleshooting information explained in Table 9-7 and Table 9-8 to investigate the cause of the error. This troubleshooting information will not be used for any purpose other than determining the causes of errors.
Return value
Return value |
Description |
---|---|
0 |
Collection of troubleshooting information was successful, or the command terminated normally with a warning-level error. |
1 |
Collection of troubleshooting information failed. |
2 |
A lock error occurred on the command. |
9 |
An execution permission error occurred. |
- Note:
-
The return value is undefined if the command is terminated by a cause beyond the command's control (such as when the command is terminated forcibly by pressing the Ctrl key and the C key at the same time).
Example
This example assumes that the troubleshooting information output directory is C:\work\npsnapshotlog:
> Navigation-Platform-installation-directory\bin\npsnapshotlog C:\work\npsnapshotlog