Command Reference#

This section provides a complete reference for all NVDebug command options and flags.

Basic Command Structure#

nvdebug [OPTIONS]

Command Options#

Mandatory Options#

The following options are required unless specified in a configuration file:

Table 11 Mandatory Options#

Option

Short

Description

–ip

-i

BMC IP address

–user

-u

BMC username with administrative privileges

–password

-p

BMC administrator password

–platform

-t

Target platform type (arm64, x86_64, DGX, HGX-HMC, NVSwitch, PowerShelf)

–baseboard

-b

Target baseboard type (use quotes for names with spaces)

Additional BMC Credentials#

Table 12 BMC Credentials#

Option

Short

Description

–sshuser

-r

BMC SSH username

–sshpass

-w

BMC SSH password

–rfuser

-R

BMC Redfish username

–rfpass

-W

BMC Redfish password

Host Options#

Table 13 Host Options#

Option

Short

Description

–hostip

-I

Host IP address

–hostuser

-U

Host username with administrative privileges

–hostpass

-H

Host administrator password

Configuration Options#

Table 14 Configuration Options#

Option

Short

Description

–config

-C

Path to config file (default: ./config.yaml)

–dutconfig

-d

Path to DUT config file (default: ./dut_config.yaml)

–ansible_inventory

Path to ansible inventory file (generates dut_config.yaml)

–baseboard

-b

Target baseboard type

Collection Options#

Table 15 Collection Options#

Option

Short

Description

–common

-c

Collect only common logs

–cids

-S

Run specific log collectors by CID

–loggroup

-g

Run collectors by group (Redfish, IPMI, SSH, Host, HealthCheck)

–override_platform

-e

Override platform restrictions for collectors

–vendor_file

-j

Use vendor-defined JSON file for proprietary methods

–collector_file

-m

Use custom collector JSON file

Output Options#

Table 16 Output Options#

Option

Short

Description

–outdir

-o

Output directory for logs (default: /tmp)

–skipzip

-z

Skip zip creation

–skipzipsplit

-Z

Skip splitting zip archive at 200MB

–zipsplit_threshold

Set zip archive size threshold (default: 200MB)

Mode Options#

Table 17 Mode Options#

Option

Short

Description

–local

Run in local execution mode

–non-interactive

Run in non-interactive mode

Collection Level Options#

Table 18 Collection Levels#

Option

Short

Description

(no flag)

All necessary collectors (default)

-V

Verbose log collections

-VV

Verbose + optional collectors (may take hours)

Utility Options#

Table 19 Utility Options#

Option

Short

Description

–verbose

-v

Print detailed output and error messages

–help

-h

Show help information

–version

Display current version

–list

-l

Display supported log collectors

–default_collectors

-D

Display default log collectors for platform

–parse

Parse log dump and decode binary files

–fpga-parse

Parse individual FPGA file (requires –page)

–page

Page number for FPGA parsing

–preflight

Run preflight checks only

–resource_count

Number of resources for parallel collection

Network Options#

Table 20 Network Options#

Option

Short

Description

–port

-P

Port number for port forwarding (HGX-HMC only, default: 18888)

Command Examples#

Basic Collection:

# Simple collection
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64"

# With output directory
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" -o /path/to/output

# With verbose output
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" -v

Remote Mode:

# Remote collection Out-of-band only
nvdebug -i 192.168.1.100 -u admin -p password123

# Remote collection In-band only
nvdebug -I 192.168.1.50 -U host_user -H host_password

# Remote collection Out-of-band and In-band
nvdebug -i 192.168.1.100 -u admin -p password123 \
        -I 192.168.1.50 -U host_user -H host_password

# With additional credentials
nvdebug -i 192.168.1.100 -u admin -p password123 \
        -r ssh_user -w ssh_password -R redfish_user -W redfish_password

# With manual platform and baseboard configuration
nvdebug -i 192.168.1.100 -u admin -p password123 \
        -t "x86_64" -b "Hopper-HGX-8-GPU"

Local Mode:

# Local collection with BMC access
nvdebug -i 192.168.1.100 -u admin -p password123 --local

# Local collection without BMC access
nvdebug --local

Configuration File:

# Use configuration file
nvdebug -C config.yaml

# Use configuration with overrides
nvdebug -C config.yaml -i 192.168.1.100 -u admin -p password123

Custom Log Collection:

# Run specific collectors
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" -S R1 R2 R3

# Run collectors by group
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" -g Redfish IPMI

# Override platform restrictions
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" -S R1 R2 -e

Collection Levels:

# Default collection (all necessary collectors)
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64"

# Verbose collection
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" -V

# Comprehensive collection (may take hours)
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" -VV

Output Control:

# Skip zip creation
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" -z

# Skip zip splitting
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" -Z

# Custom zip split threshold
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" --zipsplit_threshold 500

Information Commands:

# Show help
nvdebug --help

# Show version
nvdebug --version

# List supported collectors
nvdebug -t "arm64" -l

# List collectors by group
nvdebug -t "arm64" -l Redfish

# Show default collectors for platform
nvdebug -t "arm64" -D

# Show default collectors for platform by group
nvdebug -t "arm64" -D Redfish

Parse and Decode:

# Parse existing log dump
nvdebug --parse /path/to/logs.zip

# Auto-parse collected logs
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" --parse

# Parse FPGA file
nvdebug --parse /path/to/logs.zip --fpga-parse --page 1

Preflight Checks:

# Run preflight checks only
nvdebug -i 192.168.1.100 -u admin -p password123 -t "arm64" --preflight

Parallel Collection:

# Use specific number of resources, defaults to n-1 (n is number of compute resources)
nvdebug -C cluster_config.yaml --resource_count 4