Scroll to navigation

RBD-NBD(8) Ceph RBD-NBD(8)

NAME

rbd-nbd - map rbd images to nbd device

SYNOPSIS

rbd-nbd [-c conf] [--read-only] [--device nbd device] [--nbds_max limit] [--max_part limit] [--exclusive] [--encryption-format format] [--encryption-passphrase-file passphrase-file] [--io-timeout seconds] [--reattach-timeout seconds] map image-spec | snap-spec
rbd-nbd unmap nbd device | image-spec | snap-spec
rbd-nbd list-mapped
rbd-nbd attach --device nbd device image-spec | snap-spec
rbd-nbd detach nbd device | image-spec | snap-spec

DESCRIPTION

rbd-nbd is a client for RADOS block device (rbd) images like rbd kernel module. It will map a rbd image to a nbd (Network Block Device) device, allowing access it as regular local block device.

OPTIONS

Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup.

Map read-only.

Override the parameter nbds_max of NBD kernel module when modprobe, used to limit the count of nbd device.

Override for module param max_part.

Forbid writes by other clients.

Image encryption format. Possible values: luks1, luks2

Path of file containing a passphrase for unlocking image encryption.

Override device timeout. Linux kernel will default to a 30 second request timeout. Allow the user to optionally specify an alternate timeout.

Specify timeout for the kernel to wait for a new rbd-nbd process is attached after the old process is detached. The default is 30 second.

IMAGE AND SNAP SPECS

image-spec is [pool-name]/image-name
snap-spec  is [pool-name]/image-name@snap-name

The default for pool-name is "rbd". If an image name contains a slash character ('/'), pool-name is required.

AVAILABILITY

rbd-nbd is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at http://ceph.com/docs for more information.

SEE ALSO

rbd(8)

COPYRIGHT

2010-2023, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)

February 16, 2023 dev