VIRTNBDMAP(1)

πŸ‘‘ VIRTNBDMAP β€” the virtnbdmap manual, bestie edition

okay so real talk, this is the page for virtnbdmap, a User Commands situation, and yes it's giving "I read the whole thing so you don't have to" energy. Let's get into it 🫢


✨ NAME ✨

virtnbdmap β€” map virtnbdbackup image files to nbd devices πŸ’…


🌸 DESCRIPTION 🌸

Bestie, here's the whole usage vibe, copy-pasted exactly because I would never do you like that:

usage: virtnbdmap [-h] -f FILE [-b BLOCKSIZE] [-d DEVICE] [-e EXPORT_NAME]
       [-t THREADS] [-l LISTEN_ADDRESS] [-p LISTEN_PORT] [-n] [-L LOGFILE]
       [--nocolor] [-r] [-H] [-v] [-V]

What does it do? Map backup image(s) to a block device. That's the whole main character moment. πŸŽ€

πŸ’– options: πŸ’–

  • -h, --help β€” shows this very help message and then dips out, exit stage left. πŸ¦‹

🧚 General options: 🧚

  • -f, --file FILE β€” the list of Backup files you wanna map. yeah this one's basically required, no cap.
  • -b, --blocksize BLOCKSIZE β€” the maximum blocksize that gets passed to nbdkit. (default: 4096) ✨
  • -d, --device DEVICE β€” the target device, aka where this whole thing lands. (default: /dev/nbd0)
  • -e, --export-name EXPORT_NAME β€” the export name handed over to nbdkit. (default: sda)
  • -t, --threads THREADS β€” how many threads get passed to the nbdkit process. (default: 1)
  • -l, --listen-address LISTEN_ADDRESS β€” the IP Address the nbdkit process listens on. (default: 127.0.0.1) πŸ’œ
  • -p, --listen-port LISTEN_PORT β€” the Port the nbdkit process listens on. (default: 10809)
  • -n, --noprogress β€” kills the progress bar. no more lil loading vibes, just silence πŸ™ˆ

πŸ“ Logging options: πŸ“

  • -L, --logfile LOGFILE β€” path to the Logfile. (default: /home/abi/virtnbdmap.log)
  • --nocolor β€” disables colored output. (default: False) yes bestie, that's the literal default value, I'm not making this up

πŸ’€ Debug options: πŸ’€

  • -r, --readonly β€” maps the image readonly, so nothing gets written back. (default: False) 🧊
  • -H, --hexdump β€” hexdumps data into the logfile for debugging. (default: False)
  • -v, --verbose β€” turns on debug output. the yapper setting πŸ”₯
  • -V, --version β€” shows the version and exits. periodt.

🌈 EXAMPLES 🌈

okay these are the actual examples, verbatim, do not @ me:

# Map full backup to device /dev/nbd0:

virtnbdmap -f /backup/sda.full.data

# Map full backup to device /dev/nbd2:

virtnbdmap -f /backup/sda.full.data -d /dev/nbd2

# Map sequence of full and incremental to device /dev/nbd2:

virtnbdmap -f /backup/sda.full.data,/backup/sda.inc.1.data -d /dev/nbd2

like… the way that last one just chains a full and an incremental with a lil comma?? iconic. πŸ‘‘


and that's the whole thing bestie, you ate πŸ’… this was virtnbdmap 2.49, dated July 2026 β€” go map something and slay βœ¨πŸ¦‹πŸ’–

πŸ“¦ where this page comes from