USAGE:(1)

🌸 NAME 🌸

usage: — the ROCm Deployment Health Check tool, bestie. This is the rdhc manual, section 1, and it's here to tell you literally everything about running the deployment health check. 🩺✨

---

💅 DESCRIPTION 💅

okay so first things first, here's how you actually run this thing:

usage: ./rdhc.py [options]

It's the ROCm Deployment Health Check Tool. It pokes at your ROCm install and tells you what's up. 🫶

✨ options: ✨

• -h, --help — shows this help message and dips. that's it, that's the whole flag.
• --quick — runs the quick tests only. this is the default vibe, so you're already doing it. 💅
• --all — the full default test suite PLUS it compiles and executes a simple program for each component. the glow-up version of the test run. 🔥
• -v, --verbose — turns on verbose output. you want the tea? here's all the tea. 🍵
• -s, --silent — silent mode. errors only. if nothing's wrong, you hear nothing at all. iconic, honestly. 🤫
• -j, --json FILE — exports results to a JSON file. take your data home with you.
• -d, --dir DIR — the directory path for temporary files. and listen: it must not already exist. it gets created with mode 0700. default is an autogenerated secure temp directory in /tmp (and no, it does not get autocleaned). want to reuse a directory? remove it first: rm -rf <dir>.
• --cleanup — removes the auto-generated temp directory after the tests finish. ⚠️ this only applies when -d is not specified.
• --rocm-install-prefix DIR — your ROCm installation prefix. if you set it, it overrides ROCM_PATH; otherwise ROCM_PATH or /opt/rocm gets used.
• --skip-multinode-readiness — skips the multinode/RDMA readiness check. use this on nodes with no InfiniBand or RDMA stack. 🦋
• --skip-atomic-operations — skips the PCIe atomic operations check. use it in containers or whenever lspci can't read capabilities.
• --skip-optional-cluster-checks — skips multinode readiness AND atomic operations. it's literally the same as passing both --skip-* flags above at once. two birds, one flag. 👑
• --kernel-params-warnings-only — for the kernel parameter checks (numa, iommu, pci realloc, etc.), this treats failures as warnings (is_error=false) instead of counting them as errors. soft launch instead of a whole scandal. 🙈

---

Peep the README at @<ROCM_INSTALL_PATH>/share/rdhc/README.md for more.

🌈 Usage examples 🌈

# Run quick test (default tests only)
./rdhc.py

# Run all tests including compile and execute the rocm-example program for each component
./rdhc.py --all

# Run all tests with verbose output
./rdhc.py --all -v

# Enable verbose output
./rdhc.py -v

# Run in silent mode (only errors shown)
./rdhc.py -s

# Export results to a specific JSON file
./rdhc.py --all --json rdhc-results.json

# Specify a directory for temp files (directory must not exist)
./rdhc.py --all -d /home/user/rdhc-dir/

# Auto-generate temp directory and clean it up after tests
./rdhc.py --all --cleanup

# Use a custom ROCm install prefix
./rdhc.py --rocm-install-prefix /usr/local/rocm

# Skip optional checks (e.g. single-node, containers without full PCI/RDMA)
./rdhc.py --skip-optional-cluster-checks
# (or: --skip-multinode-readiness --skip-atomic-operations)

# Kernel cmdline/sysctl checks: failures as warnings only (no FAIL on mismatch)
./rdhc.py --kernel-params-warnings-only

---

NOTE: some checks need root privileges — like lspci -vvv for the atomic operations check. run as root when you need to, or use --skip-atomic-operations if you're running unprivileged. no cap, some tests just want the crown. 👑

NOTE for Ubuntu 24.04 (Python 3.12) users: because of the enhanced security policies, you must use a virtual environment:

# Create and activate virtual environment (one-time setup)
python3 -m venv ~/rdhc-venv
source ~/rdhc-venv/bin/activate
pip3 install -r requirements.txt

# Run the tool
./rdhc.py
./rdhc.py --all

---

and if you try something spicy that doesn't exist, the tool will simply say:

rdhc: error: unrecognized arguments: --version

not the tool reading you to filth, just the tool being honest. 💀

---

okay that's the whole page, mwah 💖 this was rdhc's manual, USAGE:(1), dated September 2026 — love her, she ate, periodt. 🎀🦋💜