nvdebug User Guide

Welcome to the documentation for nvdebug. This guide provides everything you need to understand and use the tool effectively.

Contents

Documentation Contents

• Overview
  • Supported Products
  • Terminology
• Document History
• System Requirements and Known Limitations
  • Client Host
  • Server Host
  • NVSwitch Tray Host
  • Baseboard Management Controller
  • Known Limitations
  • Supported Architectures
  • System Performance Considerations
• The nvdebug Command-Line Interface
  • Modes of Operation
  • Options
• Config Files
  • dut_config.yaml
  • config.yaml
  • Platform and Baseboard Type
• Override Tags
• Log Archiving
• Passwordless SSH
  • Additional Considerations
• The Parse Option
• Configuration Guide
  • NVDebug Runtime Configuration File (config.yaml)
  • DUT Configuration File (dut_config.yaml)
• Support Log Collectors
  • arm64
  • x86_64
  • DGX
  • HGX-HMC
  • NVSwitch
  • PowerShelf
• Running Specific Collector Groups and Collectors
  • Redfish Collectors
  • Run Specific Firmware Inventory Collector
• Configuration Considerations
  • Running nvdebug in IPv6 Networks
• Log Collection Guide
  • Understanding Log Collection Groups
  • Collection Levels
  • Collection Strategies
  • Best Practices
  • Log Analysis Guidelines
• NVDebug Runtime Examples
  • Grace Hopper Single Node Example
  • NVIDIA HGX H100/B200 8-GPU Example
  • DGX-H100 Example
  • GB200 NVL Full Rack Example
• The OOB Collector Shell Script
  • Prerequisites
  • HMC Communication
  • Log Levels
  • Log Collection Categories
• Tool Execution Summary
• Troubleshooting Guide
  • Common Issues and Solutions
  • Diagnostic Commands
  • Debug Mode
  • Support Information
• Appendix
  • Appendix A: Use Cases, IPMI, SSH APIs, and SSH Commands
  • Appendix B: The JSON Files
  • Appendix C: Estimated Output Size
• Notice

Getting Started

• Overview: Learn about the tool’s features and benefits.

• Installation: Follow the steps in the system_requirements section.

• Usage: Dive into the nvdebug_cli and oob_collector_shell_script guides for step-by-step usage instructions.

Additional Resources

• Appendix: Find detailed information and advanced topics.

• Notice: Important legal or compliance information.