NVME-OCP-HARDWARE-COMPONENT-LOG(1)

📦 version 3.2, in arch rolling

💖 NVME-OCP-HARDWARE-COMPONENT-LOG(1) 💖

okay bestie, welcome to the nvme-ocp-hardware-component-log page — yes, that's the manual name AND the command, we're doing both, slay ✨

🌸 NAME 🌸

nvme-ocp-hardware-component-log — retrieve hardware component log 🎀

✨ SYNOPSIS ✨

nvme [<global-options>] ocp hardware-component-log <device>
                        [--comp-id=<num> | -i <num>]
                        [--list | -l]

🦋 DESCRIPTION 🦋

Retrieve hardware component log. That's the whole vibe, honestly. 💅

The <device> parameter is mandatory — it's your NVMe character device (ex: /dev/nvme0). No device, no log, no exceptions, iykyk 🫶

This will only work on OCP compliant devices supporting this feature. Results for any other device are undefined — and not "undefined but probably fine" undefined, like actually undefined 😭 so pls don't.

On success it returns 0, error code otherwise. That's the deal. ⭐

🌈 OPTIONS 🌈

  • -i <num>, --comp-id=<num> — component identifier 💜 — here's the whole menu of component IDs, no cap:
    • 0x0000 — Reserved
    • 0x0001 | asic — Controller ASIC component
    • 0x0002 | nand — NAND Component
    • 0x0003 | dram — DRAM Component
    • 0x0004 | pmic — PMIC Component
    • 0x0005 | pcb — PCB Component
    • 0x0006 | cap — capacitor component
    • 0x0007 | reg — registor component
    • 0x0008 | case — case component
    • 0x0009 | sn — Device Serial Number
    • 0x000A | country — Country of Origin
    • 0x000B | hw-rev — Global Device Hardware Revision
    • 0x000C-0x7FFF — Reserved
    • 0x8000 | vendor — Vendor Unique Component
    • 0x8001-0xFFFF — Vendor Unique Component
  • -l, --list — list component descriptions 🍓 (the "just show me what's on the menu" flag, obsessed)

👑 GLOBAL OPTIONS 👑

The following options are defined at the top-level nvme command and are available to this subcommand — so they're like, the main character energy options that trickle down to us 🧚

  • --dry-run — Print the command that would be executed, but do not actually execute it. Manifesting the command without committing, honestly iconic 🦋
  • --no-ioctl-probing — Disable probing for 64-bit IOCTL support.
  • --no-retries — Disable retry logic on transient errors. One shot, one opportunity 💀
  • -o <fmt>, --output-format=<fmt> — Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time. Pick ONE, bestie, we're not doing a whole fit change mid-run 🙈
  • --output-format-version=<version> — Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names. Other versions are rejected — the door is closed, fr fr 🚪
  • --quiet — Suppress informational messages. Errors are still reported, and --quiet cancels any --verbose for the library log level. It's giving "don't talk to me unless it's an emergency" 😭
  • --set-options=<key=value>[,<key=value>...] — Set libnvme library options for this invocation. Supported keys are force-4k, mi-probe-enabled, test-base-dir and test-sysfs-dir. Look at all those little knobs 💅
  • --timeout=<ms> — Set the timeout for the command in milliseconds. infinite or -1 waits without a time limit (0xffffffff). Commitment issues? Valid. Literally supported. ⏳
  • -v, --verbose — Increase the level of detail in the output. May be specified multiple times to further increase verbosity. Stack it, layer it, spritz it like perfume 🌸

These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file. (Flag > file, always, no discussion 👑)

⭐ EXAMPLES ⭐

  • Has the program issue a ocp hardware-component-log
# nvme ocp hardware-component-log /dev/nvme0
  • Has the program issue a ocp hardware-component-log with asic component list
# nvme ocp hardware-component-log /dev/nvme0 -i asic -l

💖 NVME 💖

Part of the nvme-user suite. 🫶

okay that's the whole page, go forth and log those hardware components bestie 💜✨ this was NVME-OCP-HARDWARE() — athorized by the nvme-user suite, and dated the day you opened this, mwah 🎀🔥

📦 where this page comes from