Library Version 12.1.3.3

Appendix E. Diagnostics Utility
Prev     Next

Appendix E. Diagnostics Utility

In order to catch configuration errors early, you can use this tool when troubleshooting your KVStore. Also, you can use this tool to package important information and files to send them to Oracle Support, for example.

The usage for the utility is: 

>java -jar KVHOME/lib/kvstore.jar diagnostics {setup | collect} [args]

Setting up the tool

You should first run the diagnostics setup command in order to setup the tool. This command generates the configuration file sn-target-list with the Storage Node target list, which contains the IP/hostname, registry ports, and root directory of SNAs in the remote machines.

The usage of this command is: 

diagnostics setup {-add | 
-list |
-delete |
-clear} [args]

where:

  • -add

    Adds the specified information of each SNA to the sn-target-list. The usage is: 

    setup -add -store <store name>
-sn <SN name>
-host <host>
-rootdir <kvroot directory>
[-user <user>]
[-configdir <directory of configuration>]

    In the sn-target-list, the SNA information has the following format: 

    <store name>|<sn name>|<username@host>|<root directory>

    For example: 

    mystore|sn3|lroot@localhost|/scratch/tests/kvroot

    Note

    You can also create and edit the sn-target-list manually in your preferred text editor to add or delete any SNA information.

  • -list

    Lists and tests the SNAs information of the sn-target-list. The usage is: 

    setup -list [-configdir <configuration file directory>]

    This command checks if:

    • The host name is reachable or not.

    • The root directory exists or not.

  • -delete

    Specified to delete the information of the specified SNA from the sn-target-list.

    The usage of this command is: 

    diagnostics setup -delete
[-store <store name>]
[-sn <SN name>]
[-host <host>]
[-rootdir kvroot directory>]
[-user <user>]
[-configdir <configuration file directory>]

  • -clear

    Specified to clear all the SNA information in the sn-target-list.

    The usage of this command is: 

    diagnostics setup -clear [-configdir <configuration file directory>]

  • -configdir

    Optionally specified to change the default directory where the sn-target-list file is saved. If the flag is not specified, the default directory is the working directory.

Prev     Next
Enabling Trim  Home  Packaging information and files