update source to Ceph Pacific 16.2.2

[ceph.git] / ceph / doc / man / 8 / rbd-nbd.rst

diff --git a/ceph/doc/man/8/rbd-nbd.rst b/ceph/doc/man/8/rbd-nbd.rst
index df278a70d8ba968dd43d4f2ff6a5200268d8a589..8fcc5799de84ec1686a5d19898c61e7c4017518c 100644 (file)
--- a/ceph/doc/man/8/rbd-nbd.rst
+++ b/ceph/doc/man/8/rbd-nbd.rst
@@ -9,9 +9,11 @@
 Synopsis
 ========
 
-| **rbd-nbd** [-c conf] [--read-only] [--device *nbd device*] [--nbds_max *limit*] [--max_part *limit*] [--exclusive] [--timeout *seconds*] map *image-spec* | *snap-spec*
-| **rbd-nbd** unmap *nbd device*
+| **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
 ===========
@@ -34,22 +36,37 @@ Options
 
 .. option:: --nbds_max *limit*
 
-   Override the parameter of NBD kernel module when modprobe, used to
+   Override the parameter nbds_max of NBD kernel module when modprobe, used to
    limit the count of nbd device.
 
 .. option:: --max_part *limit*
 
-    Override for module param nbds_max.
+    Override for module param max_part.
 
 .. option:: --exclusive
 
    Forbid writes by other clients.
 
-.. option:: --timeout *seconds*
+.. option:: --encryption-format
+
+   Image encryption format.
+   Possible values: *luks1*, *luks2*
+
+.. option:: --encryption-passphrase-file
+
+   Path of file containing a passphrase for unlocking image encryption.
+
+.. option:: --io-timeout *seconds*
 
    Override device timeout. Linux kernel will default to a 30 second request timeout.
    Allow the user to optionally specify an alternate timeout.
 
+.. 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.
+
 Image and snap specs
 ====================