Collecting Network Diagnostic Data

Commvault software provides the CvDiagnostics function for collecting useful troubleshooting data for a Commvault instance. You should use CvDiagnostics when the client does not have network connectivity to the CommServe host and sendlog fails to run.

CvDiagnostics Output

The output from CvDiagnostics is a compressed archive file in 7-Zip format. It provides copies of the secure transport certificates, log files and other data for a Commvault instance on the computer you are logged on to. You can view the contents of the archive with any tool that supports the .7z archive file format. The log files in the archive can be opened and viewed using GxTail. Bear in mind that these files, even compressed, can be quite large, depending on factors such as how much activity has been logged on your CommServe host, and the data collection options you select.

Available Methods

The software provides two ways to collect this diagnostic data: through the Process Manager, and from the command line. Both methods save the results into a compressed archive file in .7z format, but the Process Manager method, while making it easier to collect the diagnostic data, does not provide some options that the command-line methods provide, such as omitting certificates and logs, and verifying connectivity.

Process Manager Procedure

1. Click Start and point to All Programs.

2. Click Commvault > Process Manager.

3. Click the Troubleshooting tab.

4. In the Collect Diagnostic Data area, for Output Folder, click the browse button, , then navigate to the directory where you want to save the diagnostic data archive file. There is no default location, so you cannot proceed without providing this.

5. Click Collect. A console window opens to show progress. Depending on your particular CommServe instance, collection of the data and production of the archive could take a few minutes.

6. Click OK to acknowledge and close the Success message.

Windows Command Line Procedure

1. Change to the base installation directory:

    
   cd software_installation_path\Base
       
   

2. Run the CvDiagnostics command:

    
   CvDiagnostics [-h] [-vm instance_name] [-nocertificates] [-nologs] [-r  remote_machine_list] -output output_directory
       
   

   Where:

   • (Optional) -h displays the command usage information.

   • (Optional) -vm specifies the local context (the instance name) of the CommCell program to run. If you don't specify this option, this is taken from the QiNetixVM file.

   • (Optional) -nocertificates omits the Certificates folder and its contents.

   • (Optional) -nologs omits the Log Files folder and all of its contents. Log files can be very large; use this option when you do not need log contents for troubleshooting.

   • (Optional) -r verifies connectivity between the computer on which the command is run and all the remote clients you specify in remote_machine_list. For remote_machine_list entries:

     • Use each client's fully-qualified domain name or its IP address.

     • (Optional) Add a port number in standard format (client:port). 8400 is used if you don't enter one.

     • Use commas to separate multiple clients, and insert no spaces.

   • -output specifies the folder into which the new diagnostic files archive will be placed. The name for the archive file is CvDiagnostics.7z.

UNIX Command Line Procedure

1. Change to the base installation directory:

    
   cd software_installation_path\Base/software
       
   

2. Run the CvDiagnostics command:

    
   CvDiagnostics [-h] -vm instance_name [-nocertificates] [-nologs] [-r  remote_machine_list] -output output_directory
       
   

   Where:

   • (Optional) -h displays the command usage information.

   • -vm specifies the local context (the instance name) of the CommCell program to run.

   • (Optional) -nocertificates omits the Certificates folder and its contents.

   • (Optional) -nologs omits the Log Files folder and all of its contents. Log files can be very large; use this option when you do not need log contents for troubleshooting.

   • (Optional) -r verifies connectivity between the computer on which the command is run and all the remote clients you specify in remote_machine_list. For remote_machine_list entries:

     • Use each client's fully-qualified domain name or its IP address.

     • (Optional) Add a port number in standard format (client:port). 8400 is used if you don't enter one.

     • Use commas to separate multiple clients, and insert no spaces.

   • -output specifies the folder into which the new diagnostic files archive will be placed. The name for the archive file is CvDiagnostics.7z.