How to enable debug logging on a NetApp NDMP device

Article: 100031332
Last Published: 2015-10-15
Ratings: 0 0
Product(s): Backup Exec

Problem

How to enable debug logging on a NetApp NDMP device. 

Solution


1. Log into the NDMP device via telnet. Use command < telnet device_name\ip address 10000 >. If telnet is not possible then use NetApp ONTAP CLI and continue with the below steps.

2.  For OnTap 8.0 and below do the following. For 8.1 and newer skip to number 3.

 From the prompt enter  ndmpd debug n

Note: n specifies debug level from 0 - 70; default value is 0
 
  • Level 0 : Turns off debugging
     
  • Level 10 : Displays NDMP connection info
     
  • Level 30 : Level 10 + displays actual NDMP messages and NDMP errors
     
  • Level 50 : Level 30 + displays environment variables and NDMP exceptions
     
  • Level 70 : Level 50 + displays SCSI Command descriptor blocks (CDBs)

  3.  From the prompt enter the following commands

  • NETAPPFILER>options ndmpd.debug.enable on
  • NETAPPFILER>options ndmpd.debug.filter n

n specifies the NDMPD modules for debug logging that is enabled. It can take five values : all, none, normal, backend and filter.

  • all: turns on debug logging for all modules.
  • none: disables debug logging for all modules. It is equivalent to ndmpd.debug.enable option being set to off.
  • normal : is a shortcut option that enables debug logging for all modules except verbose and io_loop.
  • backend: is a shortcut option that enables debug logging for all modules except verbose, io_loop, ndmps and ndmpd.
  • filter: is a combination of one or more modules for which debug logs needs to be enabled.
     

Note:

8.0 or older NDMP session debug log files are stored in the "/etc/log" directory. 8.1 and newer NDMP session debug log files are stored in the /etc/log/mlog/ndmpd.log 

  • The file name is ndmplog.yyyymmdd format
  • Wireshark (  https://www.wireshark.org/ ) is another good tool for debugging as it captures NDMP request/replies and SCSI CDBs sent/received over the wire
  • Remember to set the logging level back to 0 when finished troubleshooting

Using the Backup Exec Debug Monitor (SGMon) for troubleshooting NDMP

The Backup Exec Debug Monitor, or SGMon, is a diagnostic tool that captures debug output from Backup Exec and saves it in one debug log as <server name>SGMon.log. SGMon debug logs can help you troubleshoot backup issues. Furthermore, debug logs can help Veritas Technical Support diagnose and correct issues.
SGMon captures debug data from the selected items when SGMon is open and running or when it is scheduled to run.  In Tools | Settings for SGMon, console settings and more specific debug settings can be configured.  By default, the logs are saved to  \Program Files\veritas\Backup Exec\logs\

To open the Backup Exec Debug Monitor Console - SGMon:

In the current version of Backup Exec (BE)
Click the white BE button on the top left of the console > click Technical Support > Collect debug output to run SGMON. (Check figure below)

Once the SGMON Debugger is open, click the Capture icon (third icon from the left in the Ribbon Bar) choose Custom and select  Job Engine, Agent for Windows, Agent Browser; Backup Exec Server; Device & Media. Verify that Capture to File is selected in the Ribbon Bar (Check figure below)
 
 
In order to troubleshoot the problem with the NDMP device on the SGMON window, It is required to run the SGMON Debugger in verbose mode.  To do so, click on the Settings (Sprocket) icon (last icon on the right in the Ribbon Bar). Select Device and Media from the debug settings menu on the left, and check Enable Verbose Logging. (Check figure Below)

  


Note: After collecting the log, follow the verbose instructions above to uncheck Enable Verbose Logging, Leaving this option select will decrease backup performance and continue to write to the debug log after closing the SGMON Debugger. 
 
The debug file is found *:\Program Files\Veritas\Backup Exec\Logs.  The file name is Servername-sgmon.log.  This file will need to be uploaded to the case on the customer portal on the web or sent in via email to the case.

 

 

 

Was this content helpful?