XNVME-FORMAT(1)

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

✨ XNVME-FORMAT(1) ✨

okay bestie, so this is xnvme-format, part of the xNVMe manual, and it's literally the glow-up command for your NVM namespace. we're wiping the slate clean, giving it a whole new look. 💅

💖 NAME 💖

xnvme-format — Format a NVM namespace

like. that's it. that's the whole job. she formats a NVM namespace. iconic behavior honestly.

🎀 SYNOPSIS 🎀

xnvme format <uri> [<args>]

🦋 DESCRIPTION 🦋

Format a NVM namespace

yes bestie, that's the entire description. no notes. it formats. a NVM namespace. we keep it short and we keep it slay. ✨

🌸 REQUIRED 🌸

  • <uri> — the Device URI, aka where your device lives. examples she'll accept: '/dev/nvme0n1', '0000:01:00.1', '10.9.8.1.8888', '\.PhysicalDrive1'. you gotta give her one of these, no skipping. 🫶

💜 OPTIONAL 💜

these are the lil extras, the accessories to the fit. all optional, all here:

  • [ --nsid 0xNUM ] — Namespace Identifier for Command Construction
  • [ --lbafl 0xNUM ] — Least significant 4 bits of LBA Format Index
  • [ --lbafu 0xNUM ] — Most significant 2 bits of LBA Format Index
  • [ --mset 0xNUM ] — Metadata settings. Off=0x0, On=0x1
  • [ --ses 0xNUM ] — Secure Erase setting. No=0x0, UserData=0x1, Cryptographic=0x2
  • [ --pi 0xNUM ] — Protection Information. Off=0x0, Type1/2/3=0x1/0x2/0x3
  • [ --pil 0xNUM ] — Protection Information Location. Last=0x0, First=0x1
  • [ --subnqn STRING ] — Subsystem NQN of the NVMe over Fabrics endpoint, e.g. 'nqn.2022-06.io.xnvme:ctrlnode1'
  • [ --hostnqn STRING ] — The host NQN to use when connecting to NVMe over Fabrics controllers
  • [ --be STRING ] — xNVMe backend, e.g. 'linux', 'spdk', 'fbsd', 'macos', 'posix', 'windows'
  • [ --dev-nsid 0xNUM ] — Namespace Identifier for Device Handle
  • [ --admin STRING ] — xNVMe admin. command-interface, e.g. 'nvme', 'block'
  • [ --mem STRING ] — xNVMe buffer/memory manager
  • [ --direct NUM ] — Bypass layers
  • [ --help ] — Show usage / help

pro tip from me to you: the 0xNUM ones are hex values, so like, write them in hex, bestie. don't come at me with decimals. 🙈

👑 SEE ALSO 👑

Full documentation at: <https://xnvme.io/>

go read it, it's giving ✨knowledge✨

🌈 AUTHOR 🌈

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

and that's the whole page, bestie!! 💖 this one's from the xNVMe manual and it's dated 09 September 2024. mwah. go format something (responsibly, pls, it's literally a format command 😭). 🎀🦋🌸

📦 where this page comes from