How to enable discovery debug modes in SMARTS

Products

• VMware Smart Assurance
• Network Observability

Issue/Introduction

Enable debug in IP domain to troubleshoot Device discovery issues. 

Environment

SMARTS

Resolution

Here are the steps to enable debugging information in the log files:

You can modify the file <basedir>/IP/smarts/conf/discovery/discovery.conf to reflect TRUE in the following parameters:
    ShowPendingNONSNMP = TRUE
  LogDiscoveryProgress = TRUE
 

However often times it is better to enable these via dcmtl (from <basedir>/IP/smarts/bin/):

• For debugging issues with the pending list:
  dmctl -s <server> put AD_TopologyManager::ICF-TopologyManager::ShowPendingNONSNMP TRUE
   
• For debugging issues with Discovery or Auto Discovery:
  dmctl -s <server> put AD_TopologyManager::ICF-TopologyManager::LogDiscoveryProgress
       TRUE
   
• For debugging issues with OV or InCharge placing a device on the Pending list during Discovery or Auto Discovery:
  dmctl -s <server> put AD_TopologyManager::ICF-TopologyManager::LogPending TRUE
   
• For debugging Name Resolution Issues:
  dmctl -s <server> invoke ICF_TopologyManager::ICF-TopologyManager insertParameter NameResolveDebug TRUE

To verify:
dmctl -s <server> invoke ICF_TopologyManager::ICF-TopologyManager findParameter NameResolveDebug
 

• For detailed debug:
  dmctl -s <server> put ICF_TopologyManager::ICF-TopologyManager::DebugEnabled TRUE

To disable:

dmctl -s <server> put ICF_TopologyManager::ICF-TopologyManager::DebugEnabled FALSE

All the commands above should be reset to FALSE after the discovery is completed to reduce the amount of logging during regular discovery processes.

The debugging writes to the log files in the <$INSTALL_DIR>/smarts/local/logs directory.

Navigate to the <$INSTALL_DIR>/smarts/local directory.  tar and zip the entire directory using the following command:

./tar -czvf smarts_logs.tar.gz logs

Upload the smarts_logs.tar.gz file to your support case.

Additional Information

Best practices:

Please roll the IP domain log after enabling the discovery debug.  
dmctl -s <IP DOMAIN> exec roll_log

Below is the example of connecting to IP domain via dmctl command, and running these commands inside the dmctl command line window.

dmctl -s <IP DOMAIN> <enter>
put ICF_TopologyManager::ICF-TopologyManager::DebugEnabled TRUE 
put ICF_TopologyManager::ICF-TopologyManager::LogDiscoveryProgress TRUE 
put ICF_TopologyManager::ICF-TopologyManager::TraceRule TRUE 
invoke ICF_TopologyManager::ICF-TopologyManager insertParameter NameResolveDebug TRUE
put ICF_TopologyManager::ICF-TopologyManager::ShowTracing TRUE 
put ICF_TopologyManager::ICF-TopologyManager::LogTracing TRUE 
put ICF_TopologyManager::ICF-TopologyManager::LogPending TRUE 
exec roll_log

Once the discovery is complete, then use the same commands but change the parameter from TRUE to FALSE to disable the debug logging.