LBLK-READ(1)

📦 version 0.7.5, in alpine 3.24, epel 9, fedora 43, fedora 44

💖 LBLK-READ(1) — the xNVMe glow-up 💖

okay bestie, gather round, because today we're reading data (and optionally metadata, we love an optional queen) and honestly? it's giving main character. this is lblk-read, part of the xNVMe family, and she's here to pull bytes off your device and put them wherever you tell her to. no cap.

✨ SYNOPSIS ✨

lblk read <uri> [<args>]

that's it. that's the whole vibe. <uri> is mandatory, the args are your little garnish. 🎀

🌸 DESCRIPTION 🌸

Read data and optionally metadata. literally what it says on the tin, and she does it flawlessly. 💅

👑 REQUIRED 👑 (yes you actually have to give her these, she's not asking twice)

  • <uri> — Device URI, bestie. like, the address of the thing you wanna read from. examples so you get the vibe: '/dev/nvme0n1', '0000:01:00.1', '10.9.8.1.8888', '\.PhysicalDrive1'. pick your fave, she supports them all 🫶
  • --slba 0xNUM — Start Logical Block Address. where the reading begins, the origin story, the opening scene. ✨
  • --nlb NUM — Number of LBAs. NOTE: this is a zero-based value, so don't come for her when your math is off, the manual literally told you. 😭

🦋 OPTIONAL 🦋 (the fun extras, the accessories to the outfit)

  • [ --nsid 0xNUM ] — Namespace Identifier for Command Construction. giving the command a lil address label. 🏷️
  • [ --data-output FILE ] — Path to data output-file. where the actual data lands. your data's new home. 🏡
  • [ --meta-output FILE ] — Path to meta output-file. same energy but for the metadata, because metadata deserves her own room too. 💜
  • [ --subnqn STRING ] — Subsystem NQN of the NVMe over Fabrics endpoint. e.g. 'nqn.2022-06.io.xnvme:ctrlnode1'. fabrics girlies rise 🌈
  • [ --hostnqn STRING ] — The host NQN to use when connecting to NVMe over Fabrics controllers. this is your name when you slide into the fabrics controller's DMs. 💌
  • [ --be STRING ] — xNVMe backend. the options are 'linux', 'spdk', 'fbsd', 'macos', 'posix', 'windows'. choose your fighter. 👑
  • [ --dev-nsid 0xNUM ] — Namespace Identifier for Device Handle. different nsid, different purpose, don't mix them up bestie. 🙈
  • [ --admin STRING ] — xNVMe admin. command-interface, e.g. 'nvme', 'block'. the admin is in charge, respect her. 💅
  • [ --mem STRING ] — xNVMe buffer/memory manager. she handles the memory so you don't have to. iconic. 🎀
  • [ --direct NUM ] — Bypass layers. yes literally, skip the middlemen, go straight to the source. main character doesn't wait in line. ⭐
  • [ --sync STRING ] — xNVMe sync. command-interface, e.g. 'nvme', 'block'. syncing up like a good group chat. 💖
  • [ --help ] — Show usage / help. the ultimate "girl help" but make it a flag. 🆘

🔥 SEE ALSO 🔥

Full documentation at: <https://xnvme.io/> — go, read, be obsessed. 📚

💀 AUTHOR 💀

Written by Simon A. F. Lund <simon.lund@samsung.com> on behalf of Samsung. slay, Simon. 👏

and that's the tea, bestie — this page came straight out of xNVMe, dated 09 September 2024, and it's LBLK-READ(1) forever and always. periodt. 💅✨

📦 where this page comes from