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.

Table 9‒7: Troubleshooting information (primary materials)
No.	Troubleshooting information	Description
1	OS's event log	Event logs for the system, applications, and security
2	Machine's host names	`OS-installation-directory\system32\drivers\etc\hosts`
3	Machine's services and ports	`OS-installation-directory\system32\drivers\etc\services`
4	List of processes	Execution results of t`asklist` `/V`
5	Machine's system information	Execution results of `systeminfo`
6	Bind status	Execution results of `netstat` `-ao`
7	NIC implementation status	Execution results of `ipconfig` `/all`
8	List of services that are running	Execution results of `net` `start`
9	List of environment variables	Execution results of `set`
10	Various settings files	Files in the directories under the Navigation Platform installation directory are collected. The following are the target files: Files under the `conf` directory Files under the `sysconf` directory Files under the `setup\conf` directory `ucnpbaseversion.properties` file under the `lib` directory `ucnpsdkversion.properties` file under the `lib` directory Files directly under the `pluginSDK` directory `cosminexus.xml` file under the `pluginSDK\plugin\plugin-name\dd\META-INF` directory `build.xml` file under the `pluginSDK\plugin\plugin-name` directory `ioaction.xml` file under the `pluginSDK\plugin\plugin-name\WEB-INF\conf` directory Files under the `Navigation-Platform-installation-directory\PP\uCPF\conf` directory Files under the `Navigation-Platform-installation-directory\PP\DB\CONF` directory Files under the `Navigation-Platform-installation-directory\PP\DB\plugin\_phdxml\conf` directory Files under the `Navigation-Platform-installation-directory\PP\DB\plugin\_phjxml\conf` directory `PSBVRSMNG.INI` file under `Navigation-Platform-installation-directory\PP\uCPSB` Files under the `Navigation-Platform-installation-directory\PP\OpenSearch\opensearch\config` directory Files under the `Navigation-Platform-installation-directory\PP\OpenSearch\opensearch-dashboards\config` directory Files under the `Navigation-Platform-installation-directory\PP\OpenSearch\opensearch-dashboards\data` directory
11	Various log files	Files in the directories under the Navigation Platform installation directory are collected. The target files are as follows: Files under the `logs` directory Files under the `Navigation-Platform-installation-directory\PP\uCPF\log` directory^# `PATCHLOG.TXT` file under `Navigation-Platform-installation-directory\PP\DB` `install.log` file under `Navigation-Platform-installation-directory\PP\uCPSB` `SPKMANAGE.LOG` file under `Navigation-Platform-installation-directory\PP\uCPSB` Files under the `Navigation-Platform-installation-directory\PP\OpenSearch\opensearch\logs` directory Files under the `Navigation-Platform-installation-directory\PP\OpenSearch\opensearch-dashboards\logs` directory
12	Navigation Platform status	Files under `Navigation-Platform-installation-directory\spool`
13	Model name and version information of Navigation Platform	`Version.txt` file under `Navigation-Platform-installation-directory`
14	License type and expiration date of Navigation Platform	`ProductInfo.txt` file under `Navigation-Platform-installation-directory`

#: 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.

Table 9‒8: Troubleshooting information (secondary materials)
No.	Troubleshooting information	Description
1	List of registry entries	Execution results of `reg` `query` `HKEY_LOCAL_MACHINE\SOFTWARE\HITACHI` `/s`. This command also collects a list of the dashboard server's registry entries. The following shows the contents to be collected: Execution results of `reg` `query` `HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Apache` `Software` `Foundation` `/s`
2	Various settings files	Various settings file information under `Navigation-Platform-installation-directory\PP\uCPSB`
3	Various log files	Files in the directories under the Navigation Platform installation directory are collected. The target files are as follows: Files under the `Navigation-Platform-installation-directory\PP\DB\SPOOL` directory Files under the `Navigation-Platform-installation-directory\PP\DB\plugin\_phdxml\spool` directory Files under the `Navigation-Platform-installation-directory\PP\DB\plugin\_phdxml\tmp` directory Files under the `Navigation-Platform-installation-directory\PP\DB\plugin\_phjxml\spool` directory Files under the `Navigation-Platform-installation-directory\PP\DB\plugin\_phjxml\tmp` directory

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

To Page Top