2015-11-13 09:30:40 +00:00
|
|
|
:orphan:
|
|
|
|
|
|
|
|
|
|
=========================================
|
|
|
|
|
rbd-nbd -- map rbd images to nbd device
|
|
|
|
|
=========================================
|
|
|
|
|
|
|
|
|
|
.. program:: rbd-nbd
|
|
|
|
|
|
|
|
|
|
Synopsis
|
|
|
|
|
========
|
|
|
|
|
|
2021-06-21 13:51:07 +00:00
|
|
|
| **rbd-nbd** [-c conf] [--read-only] [--device *nbd device*] [--nbds_max *limit*] [--max_part *limit*] [--exclusive] [--notrim] [--encryption-format *format*] [--encryption-passphrase-file *passphrase-file*] [--io-timeout *seconds*] [--reattach-timeout *seconds*] map *image-spec* | *snap-spec*
|
2020-10-08 11:47:07 +00:00
|
|
|
| **rbd-nbd** unmap *nbd device* | *image-spec* | *snap-spec*
|
2015-11-13 09:30:40 +00:00
|
|
|
| **rbd-nbd** list-mapped
|
2020-10-08 11:47:07 +00:00
|
|
|
| **rbd-nbd** attach --device *nbd device* *image-spec* | *snap-spec*
|
|
|
|
|
| **rbd-nbd** detach *nbd device* | *image-spec* | *snap-spec*
|
2015-11-13 09:30:40 +00:00
|
|
|
|
|
|
|
|
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
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
.. option:: -c ceph.conf
|
|
|
|
|
|
|
|
|
|
Use *ceph.conf* configuration file instead of the default
|
|
|
|
|
``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
|
|
|
|
|
|
2017-03-25 07:09:01 +00:00
|
|
|
.. option:: --read-only
|
|
|
|
|
|
2017-03-26 06:12:28 +00:00
|
|
|
Map read-only.
|
2017-03-25 07:09:01 +00:00
|
|
|
|
2015-11-13 09:30:40 +00:00
|
|
|
.. option:: --nbds_max *limit*
|
|
|
|
|
|
2020-12-21 08:44:50 +00:00
|
|
|
Override the parameter nbds_max of NBD kernel module when modprobe, used to
|
2015-11-13 09:30:40 +00:00
|
|
|
limit the count of nbd device.
|
|
|
|
|
|
2017-03-25 07:09:01 +00:00
|
|
|
.. option:: --max_part *limit*
|
|
|
|
|
|
2020-12-21 08:44:50 +00:00
|
|
|
Override for module param max_part.
|
2017-03-25 07:09:01 +00:00
|
|
|
|
|
|
|
|
.. option:: --exclusive
|
|
|
|
|
|
2017-03-26 06:12:28 +00:00
|
|
|
Forbid writes by other clients.
|
2017-03-25 07:09:01 +00:00
|
|
|
|
2021-06-21 13:51:07 +00:00
|
|
|
.. option:: --notrim
|
|
|
|
|
|
|
|
|
|
Turn off trim/discard.
|
|
|
|
|
|
2021-01-10 18:57:32 +00:00
|
|
|
.. option:: --encryption-format
|
|
|
|
|
|
|
|
|
|
Image encryption format.
|
|
|
|
|
Possible values: *luks1*, *luks2*
|
|
|
|
|
|
|
|
|
|
.. option:: --encryption-passphrase-file
|
|
|
|
|
|
|
|
|
|
Path of file containing a passphrase for unlocking image encryption.
|
|
|
|
|
|
2020-10-08 11:47:07 +00:00
|
|
|
.. option:: --io-timeout *seconds*
|
2018-09-27 12:11:05 +00:00
|
|
|
|
|
|
|
|
Override device timeout. Linux kernel will default to a 30 second request timeout.
|
|
|
|
|
Allow the user to optionally specify an alternate timeout.
|
|
|
|
|
|
2020-10-08 11:47:07 +00:00
|
|
|
.. option:: --reattach-timeout *seconds*
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2015-11-13 09:30:40 +00:00
|
|
|
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
|
2021-03-21 16:17:21 +00:00
|
|
|
the Ceph documentation at https://docs.ceph.com/ for more information.
|
2015-11-13 09:30:40 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
See also
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
:doc:`rbd <rbd>`\(8)
|
