virtnbdmap(1)

map virtnbdbackup image files to nbd devices

Section 1 virtnbdbackup bookworm source

Description

VIRTNBDMAP

NAME

virtnbdmap - map virtnbdbackup image files to nbd devices

DESCRIPTION

usage: virtnbdmap [-h] -f FILE [-b BLOCKSIZE] [-d DEVICE] [-e EXPORT_NAME]

[-t THREADS] [-l LISTEN_ADDRESS] [-p LISTEN_PORT] [-n] [-L LOGFILE] [-r] [-v] [-V]

Map backup image(s) to block device

optional arguments:

-h, --help

show this help message and exit

General options:

-f FILE, --file FILE

List of Backup files to map

-b BLOCKSIZE, --blocksize BLOCKSIZE

Maximum blocksize passed to nbdkit. (default: 4096)

-d DEVICE, --device DEVICE

Target device. (default: /dev/nbd0)

-e EXPORT_NAME, --export-name EXPORT_NAME

Export name passed to nbdkit. (default: sda)

-t THREADS, --threads THREADS

Amount of threads passed to nbdkit process. (default: 1)

-l LISTEN_ADDRESS, --listen-address LISTEN_ADDRESS

IP Address for nbdkit process to listen on. (default: 127.0.0.1)

-p LISTEN_PORT, --listen-port LISTEN_PORT

Port for nbdkit process to listen on. (default: 10809)

-n, --noprogress

Disable progress bar

Logging options:

-L LOGFILE, --logfile LOGFILE

Path to Logfile (default: /home/abi/virtnbdmap.log)

Debug options:

-r, --readonly

Map image readonly (default: False)

-v, --verbose

Enable debug output

-V, --version

Show version and exit

EXAMPLES

# 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