1 Skip test on FreeBSD as it generates different output there.
3 $ test "$(uname)" = "FreeBSD" && exit 80 || true
6 usage: rbd <command> ...
8 Command-line interface for managing Ceph RBD images.
12 bench Simple benchmark.
13 children Display children of snapshot.
14 clone Clone a snapshot into a COW child image.
15 copy (cp) Copy src image to dest.
16 create Create an empty image.
17 diff Print extents that differ since a previous
18 snap, or image creation.
19 disk-usage (du) Show disk usage stats for pool, image or
21 export Export image to file.
22 export-diff Export incremental diff to file.
23 feature disable Disable the specified image feature.
24 feature enable Enable the specified image feature.
25 flatten Fill clone with parent data (make it
27 image-meta get Image metadata get the value associated with
29 image-meta list Image metadata list keys with values.
30 image-meta remove Image metadata remove the key and value
32 image-meta set Image metadata set key with value.
33 import Import image from file.
34 import-diff Import an incremental diff.
35 info Show information about image size, striping,
37 journal client disconnect Flag image journal client as disconnected.
38 journal export Export image journal.
39 journal import Import image journal.
40 journal info Show information about image journal.
41 journal inspect Inspect image journal for structural errors.
42 journal reset Reset image journal.
43 journal status Show status of image journal.
44 list (ls) List rbd images.
45 lock add Take a lock on an image.
46 lock list (lock ls) Show locks held on an image.
47 lock remove (lock rm) Release a lock on an image.
48 map Map image to a block device using the kernel.
49 merge-diff Merge two diff exports together.
50 mirror image demote Demote an image to non-primary for RBD
52 mirror image disable Disable RBD mirroring for an image.
53 mirror image enable Enable RBD mirroring for an image.
54 mirror image promote Promote an image to primary for RBD mirroring.
55 mirror image resync Force resync to primary image for RBD mirroring.
56 mirror image status Show RDB mirroring status for an image.
57 mirror pool demote Demote all primary images in the pool.
58 mirror pool disable Disable RBD mirroring by default within a pool.
59 mirror pool enable Enable RBD mirroring by default within a pool.
60 mirror pool info Show information about the pool mirroring
62 mirror pool peer add Add a mirroring peer to a pool.
63 mirror pool peer remove Remove a mirroring peer from a pool.
64 mirror pool peer set Update mirroring peer settings.
65 mirror pool promote Promote all non-primary images in the pool.
66 mirror pool status Show status for all mirrored images in the pool.
67 nbd list (nbd ls) List the nbd devices already used.
68 nbd map Map image to a nbd device.
69 nbd unmap Unmap a nbd device.
70 object-map check Verify the object map is correct.
71 object-map rebuild Rebuild an invalid object map.
72 pool init Initialize pool for use by RBD.
73 remove (rm) Delete an image.
74 rename (mv) Rename image within pool.
75 resize Resize (expand or shrink) image.
76 showmapped Show the rbd images mapped by the kernel.
77 snap create (snap add) Create a snapshot.
78 snap limit clear Remove snapshot limit.
79 snap limit set Limit the number of snapshots.
80 snap list (snap ls) Dump list of image snapshots.
81 snap protect Prevent a snapshot from being deleted.
82 snap purge Delete all snapshots.
83 snap remove (snap rm) Delete a snapshot.
84 snap rename Rename a snapshot.
85 snap rollback (snap revert) Rollback image to snapshot.
86 snap unprotect Allow a snapshot to be deleted.
87 status Show the status of this image.
88 trash list (trash ls) List trash images.
89 trash move (trash mv) Move an image to the trash.
90 trash remove (trash rm) Remove an image from trash.
91 trash restore Restore an image from trash.
92 unmap Unmap a rbd device that was used by the kernel.
93 watch Watch events on image.
96 -c [ --conf ] arg path to cluster configuration
97 --cluster arg cluster name
98 --id arg client id (without 'client.' prefix)
99 --user arg client id (without 'client.' prefix)
100 -n [ --name ] arg client name
101 -m [ --mon_host ] arg monitor host
102 --secret arg path to secret key (deprecated)
103 -K [ --keyfile ] arg path to secret key
104 -k [ --keyring ] arg path to keyring
106 See 'rbd help <command>' for help on a specific command.
107 $ rbd help | grep '^ [a-z]' | sed 's/^ \([a-z -]*[a-z]\).*/\1/g' | while read -r line; do echo rbd help $line ; rbd help $line; done
109 usage: rbd bench [--pool <pool>] [--image <image>] [--io-size <io-size>]
110 [--io-threads <io-threads>] [--io-total <io-total>]
111 [--io-pattern <io-pattern>] --io-type <io-type>
117 <image-spec> image specification
118 (example: [<pool-name>/]<image-name>)
121 -p [ --pool ] arg pool name
122 --image arg image name
123 --io-size arg IO size (in B/K/M/G/T) [default: 4K]
124 --io-threads arg ios in flight [default: 16]
125 --io-total arg total size for IO (in B/K/M/G/T) [default: 1G]
126 --io-pattern arg IO pattern (rand or seq) [default: seq]
127 --io-type arg IO type (read or write)
130 usage: rbd children [--pool <pool>] [--image <image>] [--snap <snap>]
131 [--format <format>] [--pretty-format]
134 Display children of snapshot.
137 <snap-spec> snapshot specification
138 (example: [<pool-name>/]<image-name>@<snapshot-name>)
141 -p [ --pool ] arg pool name
142 --image arg image name
143 --snap arg snapshot name
144 --format arg output format (plain, json, or xml) [default: plain]
145 --pretty-format pretty formatting (json and xml)
148 usage: rbd clone [--pool <pool>] [--image <image>] [--snap <snap>]
149 [--dest-pool <dest-pool>] [--dest <dest>] [--order <order>]
150 [--object-size <object-size>]
151 [--image-feature <image-feature>] [--image-shared]
152 [--stripe-unit <stripe-unit>] [--stripe-count <stripe-count>]
153 [--data-pool <data-pool>]
154 [--journal-splay-width <journal-splay-width>]
155 [--journal-object-size <journal-object-size>]
156 [--journal-pool <journal-pool>]
157 <source-snap-spec> <dest-image-spec>
159 Clone a snapshot into a COW child image.
162 <source-snap-spec> source snapshot specification
164 [<pool-name>/]<image-name>@<snapshot-name>)
165 <dest-image-spec> destination image specification
166 (example: [<pool-name>/]<image-name>)
169 -p [ --pool ] arg source pool name
170 --image arg source image name
171 --snap arg source snapshot name
172 --dest-pool arg destination pool name
173 --dest arg destination image name
174 --order arg object order [12 <= order <= 25]
175 --object-size arg object size in B/K/M [4K <= object size <= 32M]
176 --image-feature arg image features
177 [layering(+), striping, exclusive-lock(+*),
178 object-map(+*), fast-diff(+*), deep-flatten(+-),
179 journaling(*), data-pool]
180 --image-shared shared image
181 --stripe-unit arg stripe unit in B/K/M
182 --stripe-count arg stripe count
183 --data-pool arg data pool
184 --journal-splay-width arg number of active journal objects
185 --journal-object-size arg size of journal objects
186 --journal-pool arg pool for journal objects
189 (*) supports enabling/disabling on existing images
190 (-) supports disabling-only on existing images
191 (+) enabled by default for new images if features not specified
194 usage: rbd copy [--pool <pool>] [--image <image>] [--snap <snap>]
195 [--dest-pool <dest-pool>] [--dest <dest>] [--order <order>]
196 [--object-size <object-size>]
197 [--image-feature <image-feature>] [--image-shared]
198 [--stripe-unit <stripe-unit>] [--stripe-count <stripe-count>]
199 [--data-pool <data-pool>]
200 [--journal-splay-width <journal-splay-width>]
201 [--journal-object-size <journal-object-size>]
202 [--journal-pool <journal-pool>] [--sparse-size <sparse-size>]
204 <source-image-or-snap-spec> <dest-image-spec>
206 Copy src image to dest.
209 <source-image-or-snap-spec> source image or snapshot specification
211 [<pool-name>/]<image-name>[@<snap-name>])
212 <dest-image-spec> destination image specification
213 (example: [<pool-name>/]<image-name>)
216 -p [ --pool ] arg source pool name
217 --image arg source image name
218 --snap arg source snapshot name
219 --dest-pool arg destination pool name
220 --dest arg destination image name
221 --order arg object order [12 <= order <= 25]
222 --object-size arg object size in B/K/M [4K <= object size <= 32M]
223 --image-feature arg image features
224 [layering(+), striping, exclusive-lock(+*),
225 object-map(+*), fast-diff(+*), deep-flatten(+-),
226 journaling(*), data-pool]
227 --image-shared shared image
228 --stripe-unit arg stripe unit in B/K/M
229 --stripe-count arg stripe count
230 --data-pool arg data pool
231 --journal-splay-width arg number of active journal objects
232 --journal-object-size arg size of journal objects
233 --journal-pool arg pool for journal objects
234 --sparse-size arg sparse size in B/K/M [default: 4K]
235 --no-progress disable progress output
238 (*) supports enabling/disabling on existing images
239 (-) supports disabling-only on existing images
240 (+) enabled by default for new images if features not specified
243 usage: rbd create [--pool <pool>] [--image <image>]
244 [--image-format <image-format>] [--new-format]
245 [--order <order>] [--object-size <object-size>]
246 [--image-feature <image-feature>] [--image-shared]
247 [--stripe-unit <stripe-unit>]
248 [--stripe-count <stripe-count>] [--data-pool <data-pool>]
249 [--journal-splay-width <journal-splay-width>]
250 [--journal-object-size <journal-object-size>]
251 [--journal-pool <journal-pool>] --size <size>
254 Create an empty image.
257 <image-spec> image specification
258 (example: [<pool-name>/]<image-name>)
261 -p [ --pool ] arg pool name
262 --image arg image name
263 --image-format arg image format [1 (deprecated) or 2]
264 --new-format use image format 2
266 --order arg object order [12 <= order <= 25]
267 --object-size arg object size in B/K/M [4K <= object size <= 32M]
268 --image-feature arg image features
269 [layering(+), striping, exclusive-lock(+*),
270 object-map(+*), fast-diff(+*), deep-flatten(+-),
271 journaling(*), data-pool]
272 --image-shared shared image
273 --stripe-unit arg stripe unit in B/K/M
274 --stripe-count arg stripe count
275 --data-pool arg data pool
276 --journal-splay-width arg number of active journal objects
277 --journal-object-size arg size of journal objects
278 --journal-pool arg pool for journal objects
279 -s [ --size ] arg image size (in M/G/T) [default: M]
282 (*) supports enabling/disabling on existing images
283 (-) supports disabling-only on existing images
284 (+) enabled by default for new images if features not specified
287 usage: rbd diff [--pool <pool>] [--image <image>] [--snap <snap>]
288 [--from-snap <from-snap>] [--whole-object] [--format <format>]
292 Print extents that differ since a previous snap, or image creation.
295 <image-or-snap-spec> image or snapshot specification
296 (example: [<pool-name>/]<image-name>[@<snap-name>])
299 -p [ --pool ] arg pool name
300 --image arg image name
301 --snap arg snapshot name
302 --from-snap arg snapshot starting point
303 --whole-object compare whole object
304 --format arg output format (plain, json, or xml) [default: plain]
305 --pretty-format pretty formatting (json and xml)
308 usage: rbd disk-usage [--pool <pool>] [--image <image>] [--snap <snap>]
309 [--format <format>] [--pretty-format]
310 [--from-snap <from-snap>]
313 Show disk usage stats for pool, image or snapshot
316 <image-or-snap-spec> image or snapshot specification
317 (example: [<pool-name>/]<image-name>[@<snap-name>])
320 -p [ --pool ] arg pool name
321 --image arg image name
322 --snap arg snapshot name
323 --format arg output format (plain, json, or xml) [default: plain]
324 --pretty-format pretty formatting (json and xml)
325 --from-snap arg snapshot starting point
328 usage: rbd export [--pool <pool>] [--image <image>] [--snap <snap>]
329 [--path <path>] [--no-progress]
330 [--export-format <export-format>]
331 <source-image-or-snap-spec> <path-name>
333 Export image to file.
336 <source-image-or-snap-spec> source image or snapshot specification
338 [<pool-name>/]<image-name>[@<snap-name>])
339 <path-name> export file (or '-' for stdout)
342 -p [ --pool ] arg source pool name
343 --image arg source image name
344 --snap arg source snapshot name
345 --path arg export file (or '-' for stdout)
346 --no-progress disable progress output
347 --export-format arg format of image file
350 usage: rbd export-diff [--pool <pool>] [--image <image>] [--snap <snap>]
351 [--path <path>] [--from-snap <from-snap>]
352 [--whole-object] [--no-progress]
353 <source-image-or-snap-spec> <path-name>
355 Export incremental diff to file.
358 <source-image-or-snap-spec> source image or snapshot specification
360 [<pool-name>/]<image-name>[@<snap-name>])
361 <path-name> export file (or '-' for stdout)
364 -p [ --pool ] arg source pool name
365 --image arg source image name
366 --snap arg source snapshot name
367 --path arg export file (or '-' for stdout)
368 --from-snap arg snapshot starting point
369 --whole-object compare whole object
370 --no-progress disable progress output
372 rbd help feature disable
373 usage: rbd feature disable [--pool <pool>] [--image <image>]
374 <image-spec> <features> [<features> ...]
376 Disable the specified image feature.
379 <image-spec> image specification
380 (example: [<pool-name>/]<image-name>)
381 <features> image features
382 [layering, striping, exclusive-lock, object-map,
383 fast-diff, deep-flatten, journaling, data-pool]
386 -p [ --pool ] arg pool name
387 --image arg image name
389 rbd help feature enable
390 usage: rbd feature enable [--pool <pool>] [--image <image>]
391 [--journal-splay-width <journal-splay-width>]
392 [--journal-object-size <journal-object-size>]
393 [--journal-pool <journal-pool>]
394 <image-spec> <features> [<features> ...]
396 Enable the specified image feature.
399 <image-spec> image specification
400 (example: [<pool-name>/]<image-name>)
401 <features> image features
402 [layering, striping, exclusive-lock, object-map,
403 fast-diff, deep-flatten, journaling, data-pool]
406 -p [ --pool ] arg pool name
407 --image arg image name
408 --journal-splay-width arg number of active journal objects
409 --journal-object-size arg size of journal objects
410 --journal-pool arg pool for journal objects
413 usage: rbd flatten [--pool <pool>] [--image <image>] [--no-progress]
416 Fill clone with parent data (make it independent).
419 <image-spec> image specification
420 (example: [<pool-name>/]<image-name>)
423 -p [ --pool ] arg pool name
424 --image arg image name
425 --no-progress disable progress output
427 rbd help image-meta get
428 usage: rbd image-meta get [--pool <pool>] [--image <image>]
431 Image metadata get the value associated with the key.
434 <image-spec> image specification
435 (example: [<pool-name>/]<image-name>)
439 -p [ --pool ] arg pool name
440 --image arg image name
442 rbd help image-meta list
443 usage: rbd image-meta list [--pool <pool>] [--image <image>]
444 [--format <format>] [--pretty-format]
447 Image metadata list keys with values.
450 <image-spec> image specification
451 (example: [<pool-name>/]<image-name>)
454 -p [ --pool ] arg pool name
455 --image arg image name
456 --format arg output format (plain, json, or xml) [default: plain]
457 --pretty-format pretty formatting (json and xml)
459 rbd help image-meta remove
460 usage: rbd image-meta remove [--pool <pool>] [--image <image>]
463 Image metadata remove the key and value associated.
466 <image-spec> image specification
467 (example: [<pool-name>/]<image-name>)
471 -p [ --pool ] arg pool name
472 --image arg image name
474 rbd help image-meta set
475 usage: rbd image-meta set [--pool <pool>] [--image <image>]
476 <image-spec> <key> <value>
478 Image metadata set key with value.
481 <image-spec> image specification
482 (example: [<pool-name>/]<image-name>)
484 <value> image meta value
487 -p [ --pool ] arg pool name
488 --image arg image name
491 usage: rbd import [--path <path>] [--dest-pool <dest-pool>] [--dest <dest>]
492 [--image-format <image-format>] [--new-format]
493 [--order <order>] [--object-size <object-size>]
494 [--image-feature <image-feature>] [--image-shared]
495 [--stripe-unit <stripe-unit>]
496 [--stripe-count <stripe-count>] [--data-pool <data-pool>]
497 [--journal-splay-width <journal-splay-width>]
498 [--journal-object-size <journal-object-size>]
499 [--journal-pool <journal-pool>]
500 [--sparse-size <sparse-size>] [--no-progress]
501 [--export-format <export-format>] [--pool <pool>]
503 <path-name> <dest-image-spec>
505 Import image from file.
508 <path-name> import file (or '-' for stdin)
509 <dest-image-spec> destination image specification
510 (example: [<pool-name>/]<image-name>)
513 --path arg import file (or '-' for stdin)
514 --dest-pool arg destination pool name
515 --dest arg destination image name
516 --image-format arg image format [1 (deprecated) or 2]
517 --new-format use image format 2
519 --order arg object order [12 <= order <= 25]
520 --object-size arg object size in B/K/M [4K <= object size <= 32M]
521 --image-feature arg image features
522 [layering(+), striping, exclusive-lock(+*),
523 object-map(+*), fast-diff(+*), deep-flatten(+-),
524 journaling(*), data-pool]
525 --image-shared shared image
526 --stripe-unit arg stripe unit in B/K/M
527 --stripe-count arg stripe count
528 --data-pool arg data pool
529 --journal-splay-width arg number of active journal objects
530 --journal-object-size arg size of journal objects
531 --journal-pool arg pool for journal objects
532 --sparse-size arg sparse size in B/K/M [default: 4K]
533 --no-progress disable progress output
534 --export-format arg format of image file
535 -p [ --pool ] arg pool name (deprecated)
536 --image arg image name (deprecated)
539 (*) supports enabling/disabling on existing images
540 (-) supports disabling-only on existing images
541 (+) enabled by default for new images if features not specified
544 usage: rbd import-diff [--path <path>] [--pool <pool>] [--image <image>]
545 [--sparse-size <sparse-size>] [--no-progress]
546 <path-name> <image-spec>
548 Import an incremental diff.
551 <path-name> import file (or '-' for stdin)
552 <image-spec> image specification
553 (example: [<pool-name>/]<image-name>)
556 --path arg import file (or '-' for stdin)
557 -p [ --pool ] arg pool name
558 --image arg image name
559 --sparse-size arg sparse size in B/K/M [default: 4K]
560 --no-progress disable progress output
563 usage: rbd info [--pool <pool>] [--image <image>] [--snap <snap>]
564 [--image-id <image-id>] [--format <format>] [--pretty-format]
567 Show information about image size, striping, etc.
570 <image-or-snap-spec> image or snapshot specification
571 (example: [<pool-name>/]<image-name>[@<snap-name>])
574 -p [ --pool ] arg pool name
575 --image arg image name
576 --snap arg snapshot name
577 --image-id arg image id
578 --format arg output format (plain, json, or xml) [default: plain]
579 --pretty-format pretty formatting (json and xml)
581 rbd help journal client disconnect
582 usage: rbd journal client disconnect [--pool <pool>] [--image <image>]
583 [--journal <journal>]
584 [--client-id <client-id>]
587 Flag image journal client as disconnected.
590 <journal-spec> journal specification
591 (example: [<pool-name>/]<journal-name>)
594 -p [ --pool ] arg pool name
595 --image arg image name
596 --journal arg journal name
597 --client-id arg client ID (or leave unspecified to disconnect all)
599 rbd help journal export
600 usage: rbd journal export [--pool <pool>] [--image <image>]
601 [--journal <journal>] [--path <path>] [--verbose]
603 <source-journal-spec> <path-name>
605 Export image journal.
608 <source-journal-spec> source journal specification
609 (example: [<pool-name>/]<journal-name>)
610 <path-name> export file (or '-' for stdout)
613 -p [ --pool ] arg source pool name
614 --image arg source image name
615 --journal arg source journal name
616 --path arg export file (or '-' for stdout)
618 --no-error continue after error
620 rbd help journal import
621 usage: rbd journal import [--path <path>] [--dest-pool <dest-pool>]
622 [--dest <dest>] [--dest-journal <dest-journal>]
623 [--verbose] [--no-error]
624 <path-name> <dest-journal-spec>
626 Import image journal.
629 <path-name> import file (or '-' for stdin)
630 <dest-journal-spec> destination journal specification
631 (example: [<pool-name>/]<journal-name>)
634 --path arg import file (or '-' for stdin)
635 --dest-pool arg destination pool name
636 --dest arg destination image name
637 --dest-journal arg destination journal name
639 --no-error continue after error
641 rbd help journal info
642 usage: rbd journal info [--pool <pool>] [--image <image>]
643 [--journal <journal>] [--format <format>]
647 Show information about image journal.
650 <journal-spec> journal specification
651 (example: [<pool-name>/]<journal-name>)
654 -p [ --pool ] arg pool name
655 --image arg image name
656 --journal arg journal name
657 --format arg output format (plain, json, or xml) [default: plain]
658 --pretty-format pretty formatting (json and xml)
660 rbd help journal inspect
661 usage: rbd journal inspect [--pool <pool>] [--image <image>]
662 [--journal <journal>] [--verbose]
665 Inspect image journal for structural errors.
668 <journal-spec> journal specification
669 (example: [<pool-name>/]<journal-name>)
672 -p [ --pool ] arg pool name
673 --image arg image name
674 --journal arg journal name
677 rbd help journal reset
678 usage: rbd journal reset [--pool <pool>] [--image <image>]
679 [--journal <journal>]
685 <journal-spec> journal specification
686 (example: [<pool-name>/]<journal-name>)
689 -p [ --pool ] arg pool name
690 --image arg image name
691 --journal arg journal name
693 rbd help journal status
694 usage: rbd journal status [--pool <pool>] [--image <image>]
695 [--journal <journal>] [--format <format>]
699 Show status of image journal.
702 <journal-spec> journal specification
703 (example: [<pool-name>/]<journal-name>)
706 -p [ --pool ] arg pool name
707 --image arg image name
708 --journal arg journal name
709 --format arg output format (plain, json, or xml) [default: plain]
710 --pretty-format pretty formatting (json and xml)
713 usage: rbd list [--long] [--pool <pool>] [--format <format>] [--pretty-format]
719 <pool-name> pool name
722 -l [ --long ] long listing format
723 -p [ --pool ] arg pool name
724 --format arg output format (plain, json, or xml) [default: plain]
725 --pretty-format pretty formatting (json and xml)
728 usage: rbd lock add [--pool <pool>] [--image <image>] [--shared <shared>]
729 <image-spec> <lock-id>
731 Take a lock on an image.
734 <image-spec> image specification
735 (example: [<pool-name>/]<image-name>)
736 <lock-id> unique lock id
739 -p [ --pool ] arg pool name
740 --image arg image name
741 --shared arg shared lock tag
744 usage: rbd lock list [--pool <pool>] [--image <image>] [--format <format>]
748 Show locks held on an image.
751 <image-spec> image specification
752 (example: [<pool-name>/]<image-name>)
755 -p [ --pool ] arg pool name
756 --image arg image name
757 --format arg output format (plain, json, or xml) [default: plain]
758 --pretty-format pretty formatting (json and xml)
761 usage: rbd lock remove [--pool <pool>] [--image <image>]
762 <image-spec> <lock-id> <locker>
764 Release a lock on an image.
767 <image-spec> image specification
768 (example: [<pool-name>/]<image-name>)
769 <lock-id> unique lock id
770 <locker> locker client
773 -p [ --pool ] arg pool name
774 --image arg image name
777 usage: rbd map [--pool <pool>] [--image <image>] [--snap <snap>]
778 [--options <options>] [--read-only] [--exclusive]
781 Map image to a block device using the kernel.
784 <image-or-snap-spec> image or snapshot specification
785 (example: [<pool-name>/]<image-name>[@<snap-name>])
788 -p [ --pool ] arg pool name
789 --image arg image name
790 --snap arg snapshot name
791 -o [ --options ] arg map options
792 --read-only map read-only
793 --exclusive disable automatic exclusive lock transitions
796 usage: rbd merge-diff [--path <path>] [--no-progress]
797 <diff1-path> <diff2-path> <path-name>
799 Merge two diff exports together.
802 <diff1-path> path to first diff (or '-' for stdin)
803 <diff2-path> path to second diff
804 <path-name> path to merged diff (or '-' for stdout)
807 --path arg path to merged diff (or '-' for stdout)
808 --no-progress disable progress output
810 rbd help mirror image demote
811 usage: rbd mirror image demote [--pool <pool>] [--image <image>]
814 Demote an image to non-primary for RBD mirroring.
817 <image-spec> image specification
818 (example: [<pool-name>/]<image-name>)
821 -p [ --pool ] arg pool name
822 --image arg image name
824 rbd help mirror image disable
825 usage: rbd mirror image disable [--force] [--pool <pool>] [--image <image>]
828 Disable RBD mirroring for an image.
831 <image-spec> image specification
832 (example: [<pool-name>/]<image-name>)
835 --force disable even if not primary
836 -p [ --pool ] arg pool name
837 --image arg image name
839 rbd help mirror image enable
840 usage: rbd mirror image enable [--pool <pool>] [--image <image>]
843 Enable RBD mirroring for an image.
846 <image-spec> image specification
847 (example: [<pool-name>/]<image-name>)
850 -p [ --pool ] arg pool name
851 --image arg image name
853 rbd help mirror image promote
854 usage: rbd mirror image promote [--force] [--pool <pool>] [--image <image>]
857 Promote an image to primary for RBD mirroring.
860 <image-spec> image specification
861 (example: [<pool-name>/]<image-name>)
864 --force promote even if not cleanly demoted by remote cluster
865 -p [ --pool ] arg pool name
866 --image arg image name
868 rbd help mirror image resync
869 usage: rbd mirror image resync [--pool <pool>] [--image <image>]
872 Force resync to primary image for RBD mirroring.
875 <image-spec> image specification
876 (example: [<pool-name>/]<image-name>)
879 -p [ --pool ] arg pool name
880 --image arg image name
882 rbd help mirror image status
883 usage: rbd mirror image status [--pool <pool>] [--image <image>]
884 [--format <format>] [--pretty-format]
887 Show RDB mirroring status for an image.
890 <image-spec> image specification
891 (example: [<pool-name>/]<image-name>)
894 -p [ --pool ] arg pool name
895 --image arg image name
896 --format arg output format (plain, json, or xml) [default: plain]
897 --pretty-format pretty formatting (json and xml)
899 rbd help mirror pool demote
900 usage: rbd mirror pool demote [--pool <pool>]
903 Demote all primary images in the pool.
906 <pool-name> pool name
909 -p [ --pool ] arg pool name
911 rbd help mirror pool disable
912 usage: rbd mirror pool disable [--pool <pool>]
915 Disable RBD mirroring by default within a pool.
918 <pool-name> pool name
921 -p [ --pool ] arg pool name
923 rbd help mirror pool enable
924 usage: rbd mirror pool enable [--pool <pool>]
927 Enable RBD mirroring by default within a pool.
930 <pool-name> pool name
931 <mode> mirror mode [image or pool]
934 -p [ --pool ] arg pool name
936 rbd help mirror pool info
937 usage: rbd mirror pool info [--pool <pool>] [--format <format>]
941 Show information about the pool mirroring configuration.
944 <pool-name> pool name
947 -p [ --pool ] arg pool name
948 --format arg output format (plain, json, or xml) [default: plain]
949 --pretty-format pretty formatting (json and xml)
951 rbd help mirror pool peer add
952 usage: rbd mirror pool peer add [--pool <pool>]
953 [--remote-client-name <remote-client-name>]
954 [--remote-cluster <remote-cluster>]
955 <pool-name> <remote-cluster-spec>
957 Add a mirroring peer to a pool.
960 <pool-name> pool name
961 <remote-cluster-spec> remote cluster spec
962 (example: [<client name>@]<cluster name>
965 -p [ --pool ] arg pool name
966 --remote-client-name arg remote client name
967 --remote-cluster arg remote cluster name
969 rbd help mirror pool peer remove
970 usage: rbd mirror pool peer remove [--pool <pool>]
973 Remove a mirroring peer from a pool.
976 <pool-name> pool name
980 -p [ --pool ] arg pool name
982 rbd help mirror pool peer set
983 usage: rbd mirror pool peer set [--pool <pool>]
984 <pool-name> <uuid> <key> <value>
986 Update mirroring peer settings.
989 <pool-name> pool name
991 <key> peer parameter [client or cluster]
992 <value> new client or cluster name
995 -p [ --pool ] arg pool name
997 rbd help mirror pool promote
998 usage: rbd mirror pool promote [--force] [--pool <pool>]
1001 Promote all non-primary images in the pool.
1003 Positional arguments
1004 <pool-name> pool name
1007 --force promote even if not cleanly demoted by remote cluster
1008 -p [ --pool ] arg pool name
1010 rbd help mirror pool status
1011 usage: rbd mirror pool status [--pool <pool>] [--format <format>]
1012 [--pretty-format] [--verbose]
1015 Show status for all mirrored images in the pool.
1017 Positional arguments
1018 <pool-name> pool name
1021 -p [ --pool ] arg pool name
1022 --format arg output format (plain, json, or xml) [default: plain]
1023 --pretty-format pretty formatting (json and xml)
1024 --verbose be verbose
1029 List the nbd devices already used.
1032 usage: rbd nbd map [--pool <pool>] [--image <image>] [--snap <snap>]
1033 [--read-only] [--exclusive] [--device <device>]
1034 [--nbds_max <nbds_max>] [--max_part <max_part>]
1035 <image-or-snap-spec>
1037 Map image to a nbd device.
1039 Positional arguments
1040 <image-or-snap-spec> image or snapshot specification
1041 (example: [<pool-name>/]<image-name>[@<snap-name>])
1044 -p [ --pool ] arg pool name
1045 --image arg image name
1046 --snap arg snapshot name
1047 --read-only map read-only
1048 --exclusive forbid writes by other clients
1049 --device arg specify nbd device
1050 --nbds_max arg override module param nbds_max
1051 --max_part arg override module param max_part
1054 usage: rbd nbd unmap
1059 Positional arguments
1060 <device-spec> specify nbd device
1062 rbd help object-map check
1063 usage: rbd object-map check [--pool <pool>] [--image <image>] [--snap <snap>]
1065 <image-or-snap-spec>
1067 Verify the object map is correct.
1069 Positional arguments
1070 <image-or-snap-spec> image or snapshot specification
1071 (example: [<pool-name>/]<image-name>[@<snap-name>])
1074 -p [ --pool ] arg pool name
1075 --image arg image name
1076 --snap arg snapshot name
1077 --no-progress disable progress output
1079 rbd help object-map rebuild
1080 usage: rbd object-map rebuild [--pool <pool>] [--image <image>]
1081 [--snap <snap>] [--no-progress]
1082 <image-or-snap-spec>
1084 Rebuild an invalid object map.
1086 Positional arguments
1087 <image-or-snap-spec> image or snapshot specification
1088 (example: [<pool-name>/]<image-name>[@<snap-name>])
1091 -p [ --pool ] arg pool name
1092 --image arg image name
1093 --snap arg snapshot name
1094 --no-progress disable progress output
1097 usage: rbd pool init [--pool <pool>] [--force]
1100 Initialize pool for use by RBD.
1102 Positional arguments
1103 <pool-name> pool name
1106 -p [ --pool ] arg pool name
1107 --force force initialize pool for RBD use if registered by
1111 usage: rbd remove [--pool <pool>] [--image <image>] [--no-progress]
1116 Positional arguments
1117 <image-spec> image specification
1118 (example: [<pool-name>/]<image-name>)
1121 -p [ --pool ] arg pool name
1122 --image arg image name
1123 --no-progress disable progress output
1126 usage: rbd rename [--pool <pool>] [--image <image>] [--dest-pool <dest-pool>]
1128 <source-image-spec> <dest-image-spec>
1130 Rename image within pool.
1132 Positional arguments
1133 <source-image-spec> source image specification
1134 (example: [<pool-name>/]<image-name>)
1135 <dest-image-spec> destination image specification
1136 (example: [<pool-name>/]<image-name>)
1139 -p [ --pool ] arg source pool name
1140 --image arg source image name
1141 --dest-pool arg destination pool name
1142 --dest arg destination image name
1145 usage: rbd resize [--pool <pool>] [--image <image>] --size <size>
1146 [--allow-shrink] [--no-progress]
1149 Resize (expand or shrink) image.
1151 Positional arguments
1152 <image-spec> image specification
1153 (example: [<pool-name>/]<image-name>)
1156 -p [ --pool ] arg pool name
1157 --image arg image name
1158 -s [ --size ] arg image size (in M/G/T) [default: M]
1159 --allow-shrink permit shrinking
1160 --no-progress disable progress output
1163 usage: rbd showmapped [--format <format>] [--pretty-format]
1165 Show the rbd images mapped by the kernel.
1168 --format arg output format (plain, json, or xml) [default: plain]
1169 --pretty-format pretty formatting (json and xml)
1171 rbd help snap create
1172 usage: rbd snap create [--pool <pool>] [--image <image>] [--snap <snap>]
1177 Positional arguments
1178 <snap-spec> snapshot specification
1179 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1182 -p [ --pool ] arg pool name
1183 --image arg image name
1184 --snap arg snapshot name
1186 rbd help snap limit clear
1187 usage: rbd snap limit clear [--pool <pool>] [--image <image>]
1190 Remove snapshot limit.
1192 Positional arguments
1193 <image-spec> image specification
1194 (example: [<pool-name>/]<image-name>)
1197 -p [ --pool ] arg pool name
1198 --image arg image name
1200 rbd help snap limit set
1201 usage: rbd snap limit set [--pool <pool>] [--image <image>] [--limit <limit>]
1204 Limit the number of snapshots.
1206 Positional arguments
1207 <image-spec> image specification
1208 (example: [<pool-name>/]<image-name>)
1211 -p [ --pool ] arg pool name
1212 --image arg image name
1213 --limit arg maximum allowed snapshot count
1216 usage: rbd snap list [--pool <pool>] [--image <image>] [--image-id <image-id>]
1217 [--format <format>] [--pretty-format]
1220 Dump list of image snapshots.
1222 Positional arguments
1223 <image-spec> image specification
1224 (example: [<pool-name>/]<image-name>)
1227 -p [ --pool ] arg pool name
1228 --image arg image name
1229 --image-id arg image id
1230 --format arg output format (plain, json, or xml) [default: plain]
1231 --pretty-format pretty formatting (json and xml)
1233 rbd help snap protect
1234 usage: rbd snap protect [--pool <pool>] [--image <image>] [--snap <snap>]
1237 Prevent a snapshot from being deleted.
1239 Positional arguments
1240 <snap-spec> snapshot specification
1241 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1244 -p [ --pool ] arg pool name
1245 --image arg image name
1246 --snap arg snapshot name
1249 usage: rbd snap purge [--pool <pool>] [--image <image>]
1250 [--image-id <image-id>] [--no-progress]
1253 Delete all snapshots.
1255 Positional arguments
1256 <image-spec> image specification
1257 (example: [<pool-name>/]<image-name>)
1260 -p [ --pool ] arg pool name
1261 --image arg image name
1262 --image-id arg image id
1263 --no-progress disable progress output
1265 rbd help snap remove
1266 usage: rbd snap remove [--pool <pool>] [--image <image>] [--snap <snap>]
1267 [--no-progress] [--image-id <image-id>] [--force]
1272 Positional arguments
1273 <snap-spec> snapshot specification
1274 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1277 -p [ --pool ] arg pool name
1278 --image arg image name
1279 --snap arg snapshot name
1280 --no-progress disable progress output
1281 --image-id arg image id
1282 --force flatten children and unprotect snapshot if needed.
1284 rbd help snap rename
1285 usage: rbd snap rename [--pool <pool>] [--image <image>] [--snap <snap>]
1286 [--dest-pool <dest-pool>] [--dest <dest>]
1287 [--dest-snap <dest-snap>]
1288 <source-snap-spec> <dest-snap-spec>
1292 Positional arguments
1293 <source-snap-spec> source snapshot specification
1294 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1295 <dest-snap-spec> destination snapshot specification
1296 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1299 -p [ --pool ] arg source pool name
1300 --image arg source image name
1301 --snap arg source snapshot name
1302 --dest-pool arg destination pool name
1303 --dest arg destination image name
1304 --dest-snap arg destination snapshot name
1306 rbd help snap rollback
1307 usage: rbd snap rollback [--pool <pool>] [--image <image>] [--snap <snap>]
1311 Rollback image to snapshot.
1313 Positional arguments
1314 <snap-spec> snapshot specification
1315 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1318 -p [ --pool ] arg pool name
1319 --image arg image name
1320 --snap arg snapshot name
1321 --no-progress disable progress output
1323 rbd help snap unprotect
1324 usage: rbd snap unprotect [--pool <pool>] [--image <image>] [--snap <snap>]
1325 [--image-id <image-id>]
1328 Allow a snapshot to be deleted.
1330 Positional arguments
1331 <snap-spec> snapshot specification
1332 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1335 -p [ --pool ] arg pool name
1336 --image arg image name
1337 --snap arg snapshot name
1338 --image-id arg image id
1341 usage: rbd status [--pool <pool>] [--image <image>] [--format <format>]
1345 Show the status of this image.
1347 Positional arguments
1348 <image-spec> image specification
1349 (example: [<pool-name>/]<image-name>)
1352 -p [ --pool ] arg pool name
1353 --image arg image name
1354 --format arg output format (plain, json, or xml) [default: plain]
1355 --pretty-format pretty formatting (json and xml)
1358 usage: rbd trash list [--pool <pool>] [--all] [--long] [--format <format>]
1364 Positional arguments
1365 <pool-name> pool name
1368 -p [ --pool ] arg pool name
1369 -a [ --all ] list images from all sources
1370 -l [ --long ] long listing format
1371 --format arg output format (plain, json, or xml) [default: plain]
1372 --pretty-format pretty formatting (json and xml)
1375 usage: rbd trash move [--pool <pool>] [--image <image>] [--delay <delay>]
1378 Move an image to the trash.
1380 Positional arguments
1381 <image-spec> image specification
1382 (example: [<pool-name>/]<image-name>)
1385 -p [ --pool ] arg pool name
1386 --image arg image name
1387 --delay arg time delay in seconds until effectively remove the image
1389 rbd help trash remove
1390 usage: rbd trash remove [--pool <pool>] [--image-id <image-id>]
1391 [--no-progress] [--force]
1394 Remove an image from trash.
1396 Positional arguments
1398 (example: [<pool-name>/]<image-id>)
1401 -p [ --pool ] arg pool name
1402 --image-id arg image id
1403 --no-progress disable progress output
1404 --force force remove of non-expired delayed images
1406 rbd help trash restore
1407 usage: rbd trash restore [--pool <pool>] [--image-id <image-id>]
1411 Restore an image from trash.
1413 Positional arguments
1415 (example: [<pool-name>/]<image-id>)
1418 -p [ --pool ] arg pool name
1419 --image-id arg image id
1420 --image arg image name
1423 usage: rbd unmap [--pool <pool>] [--image <image>] [--snap <snap>]
1424 [--options <options>]
1425 <image-or-snap-or-device-spec>
1427 Unmap a rbd device that was used by the kernel.
1429 Positional arguments
1430 <image-or-snap-or-device-spec> image, snapshot, or device specification
1431 [<pool-name>/]<image-name>[@<snapshot-name>]
1435 -p [ --pool ] arg pool name
1436 --image arg image name
1437 --snap arg snapshot name
1438 -o [ --options ] arg unmap options
1441 usage: rbd watch [--pool <pool>] [--image <image>]
1444 Watch events on image.
1446 Positional arguments
1447 <image-spec> image specification
1448 (example: [<pool-name>/]<image-name>)
1451 -p [ --pool ] arg pool name
1452 --image arg image name