.\" Man page generated from reStructuredText.
.
.TH "RBD-NBD" "8" "Jun 11, 2021" "dev" "Ceph"
.SH NAME
rbd-nbd \- map rbd images to nbd device
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBrbd\-nbd\fP [\-c conf] [\-\-read\-only] [\-\-device \fInbd device\fP] [\-\-nbds_max \fIlimit\fP] [\-\-max_part \fIlimit\fP] [\-\-exclusive] [\-\-timeout \fIseconds\fP] map \fIimage\-spec\fP | \fIsnap\-spec\fP
\fBrbd\-nbd\fP unmap \fInbd device\fP
\fBrbd\-nbd\fP list\-mapped
.fi
.sp
.SH DESCRIPTION
.sp
\fBrbd\-nbd\fP 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.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-c ceph.conf
Use \fIceph.conf\fP configuration file instead of the default
\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-read\-only
Map read\-only.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-nbds_max *limit*
Override the parameter of NBD kernel module when modprobe, used to
limit the count of nbd device.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max_part *limit*
Override for module param nbds_max.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-exclusive
Forbid writes by other clients.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-timeout *seconds*
Override device timeout. Linux kernel will default to a 30 second request timeout.
Allow the user to optionally specify an alternate timeout.
.UNINDENT
.SH IMAGE AND SNAP SPECS
.nf
\fIimage\-spec\fP is [\fIpool\-name\fP]/\fIimage\-name\fP
\fIsnap\-spec\fP  is [\fIpool\-name\fP]/\fIimage\-name\fP@\fIsnap\-name\fP
.fi
.sp
.sp
The default for \fIpool\-name\fP is "rbd".  If an image name contains a slash
character (\(aq/\(aq), \fIpool\-name\fP is required.
.SH AVAILABILITY
.sp
\fBrbd\-nbd\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
rbd(8)
.SH COPYRIGHT
2010-2021, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
.\" Generated by docutils manpage writer.
.