]> git.proxmox.com Git - ceph.git/blob - ceph/src/test/cli/rbd/help.t
projects / ceph.git / blob
? search:


7c38ae6025505964dcf163d31365448033dd5183
[ceph.git] / ceph / src / test / cli / rbd / help.t
1 $ rbd --help
2 usage: rbd <command> ...
3
4 Command-line interface for managing Ceph RBD images.
5
6 Positional arguments:
7 <command>
8 bench Simple benchmark.
9 children Display children of snapshot.
10 clone Clone a snapshot into a COW child image.
11 copy (cp) Copy src image to dest.
12 create Create an empty image.
13 diff Print extents that differ since a previous
14 snap, or image creation.
15 disk-usage (du) Show disk usage stats for pool, image or
16 snapshot
17 export Export image to file.
18 export-diff Export incremental diff to file.
19 feature disable Disable the specified image feature.
20 feature enable Enable the specified image feature.
21 flatten Fill clone with parent data (make it
22 independent).
23 group create Create a consistency group.
24 group image add Add an image to a consistency group.
25 group image list List images in a consistency group.
26 group image remove Remove an image from a consistency group.
27 group list (group ls) List rbd consistency groups.
28 group remove (group rm) Delete a consistency group.
29 image-meta get Image metadata get the value associated with
30 the key.
31 image-meta list Image metadata list keys with values.
32 image-meta remove Image metadata remove the key and value
33 associated.
34 image-meta set Image metadata set key with value.
35 import Import image from file.
36 import-diff Import an incremental diff.
37 info Show information about image size, striping,
38 etc.
39 journal client disconnect Flag image journal client as disconnected.
40 journal export Export image journal.
41 journal import Import image journal.
42 journal info Show information about image journal.
43 journal inspect Inspect image journal for structural errors.
44 journal reset Reset image journal.
45 journal status Show status of image journal.
46 list (ls) List rbd images.
47 lock add Take a lock on an image.
48 lock list (lock ls) Show locks held on an image.
49 lock remove (lock rm) Release a lock on an image.
50 map Map image to a block device using the kernel.
51 merge-diff Merge two diff exports together.
52 mirror image demote Demote an image to non-primary for RBD
53 mirroring.
54 mirror image disable Disable RBD mirroring for an image.
55 mirror image enable Enable RBD mirroring for an image.
56 mirror image promote Promote an image to primary for RBD mirroring.
57 mirror image resync Force resync to primary image for RBD mirroring.
58 mirror image status Show RDB mirroring status for an image.
59 mirror pool demote Demote all primary images in the pool.
60 mirror pool disable Disable RBD mirroring by default within a pool.
61 mirror pool enable Enable RBD mirroring by default within a pool.
62 mirror pool info Show information about the pool mirroring
63 configuration.
64 mirror pool peer add Add a mirroring peer to a pool.
65 mirror pool peer remove Remove a mirroring peer from a pool.
66 mirror pool peer set Update mirroring peer settings.
67 mirror pool promote Promote all non-primary images in the pool.
68 mirror pool status Show status for all mirrored images in the pool.
69 nbd list (nbd ls) List the nbd devices already used.
70 nbd map Map image to a nbd device.
71 nbd unmap Unmap a nbd device.
72 object-map check Verify the object map is correct.
73 object-map rebuild Rebuild an invalid object map.
74 pool init Initialize pool for use by RBD.
75 remove (rm) Delete an image.
76 rename (mv) Rename image within pool.
77 resize Resize (expand or shrink) image.
78 showmapped Show the rbd images mapped by the kernel.
79 snap create (snap add) Create a snapshot.
80 snap limit clear Remove snapshot limit.
81 snap limit set Limit the number of snapshots.
82 snap list (snap ls) Dump list of image snapshots.
83 snap protect Prevent a snapshot from being deleted.
84 snap purge Delete all snapshots.
85 snap remove (snap rm) Delete a snapshot.
86 snap rename Rename a snapshot.
87 snap rollback (snap revert) Rollback image to snapshot.
88 snap unprotect Allow a snapshot to be deleted.
89 status Show the status of this image.
90 trash list (trash ls) List trash images.
91 trash move (trash mv) Move an image to the trash.
92 trash remove (trash rm) Remove an image from trash.
93 trash restore Restore an image from trash.
94 unmap Unmap a rbd device that was used by the kernel.
95 watch Watch events on image.
96
97 Optional arguments:
98 -c [ --conf ] arg path to cluster configuration
99 --cluster arg cluster name
100 --id arg client id (without 'client.' prefix)
101 --user arg client id (without 'client.' prefix)
102 -n [ --name ] arg client name
103 -m [ --mon_host ] arg monitor host
104 --secret arg path to secret key (deprecated)
105 -K [ --keyfile ] arg path to secret key
106 -k [ --keyring ] arg path to keyring
107
108 See 'rbd help <command>' for help on a specific command.
109 $ 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
110 rbd help bench
111 usage: rbd bench [--pool <pool>] [--image <image>] [--io-size <io-size>]
112 [--io-threads <io-threads>] [--io-total <io-total>]
113 [--io-pattern <io-pattern>] --io-type <io-type>
114 <image-spec>
115
116 Simple benchmark.
117
118 Positional arguments
119 <image-spec> image specification
120 (example: [<pool-name>/]<image-name>)
121
122 Optional arguments
123 -p [ --pool ] arg pool name
124 --image arg image name
125 --io-size arg IO size (in B/K/M/G/T) [default: 4K]
126 --io-threads arg ios in flight [default: 16]
127 --io-total arg total size for IO (in B/K/M/G/T) [default: 1G]
128 --io-pattern arg IO pattern (rand or seq) [default: seq]
129 --io-type arg IO type (read or write)
130
131 rbd help children
132 usage: rbd children [--pool <pool>] [--image <image>] [--snap <snap>]
133 [--format <format>] [--pretty-format]
134 <snap-spec>
135
136 Display children of snapshot.
137
138 Positional arguments
139 <snap-spec> snapshot specification
140 (example: [<pool-name>/]<image-name>@<snapshot-name>)
141
142 Optional arguments
143 -p [ --pool ] arg pool name
144 --image arg image name
145 --snap arg snapshot name
146 --format arg output format [plain, json, or xml]
147 --pretty-format pretty formatting (json and xml)
148
149 rbd help clone
150 usage: rbd clone [--pool <pool>] [--image <image>] [--snap <snap>]
151 [--dest-pool <dest-pool>] [--dest <dest>] [--order <order>]
152 [--object-size <object-size>]
153 [--image-feature <image-feature>] [--image-shared]
154 [--stripe-unit <stripe-unit>] [--stripe-count <stripe-count>]
155 [--data-pool <data-pool>]
156 [--journal-splay-width <journal-splay-width>]
157 [--journal-object-size <journal-object-size>]
158 [--journal-pool <journal-pool>]
159 <source-snap-spec> <dest-image-spec>
160
161 Clone a snapshot into a COW child image.
162
163 Positional arguments
164 <source-snap-spec> source snapshot specification
165 (example:
166 [<pool-name>/]<image-name>@<snapshot-name>)
167 <dest-image-spec> destination image specification
168 (example: [<pool-name>/]<image-name>)
169
170 Optional arguments
171 -p [ --pool ] arg source pool name
172 --image arg source image name
173 --snap arg source snapshot name
174 --dest-pool arg destination pool name
175 --dest arg destination image name
176 --order arg object order [12 <= order <= 25]
177 --object-size arg object size in B/K/M [4K <= object size <= 32M]
178 --image-feature arg image features
179 [layering(+), striping, exclusive-lock(+*),
180 object-map(+*), fast-diff(+*), deep-flatten(+-),
181 journaling(*), data-pool]
182 --image-shared shared image
183 --stripe-unit arg stripe unit in B/K/M
184 --stripe-count arg stripe count
185 --data-pool arg data pool
186 --journal-splay-width arg number of active journal objects
187 --journal-object-size arg size of journal objects
188 --journal-pool arg pool for journal objects
189
190 Image Features:
191 (*) supports enabling/disabling on existing images
192 (-) supports disabling-only on existing images
193 (+) enabled by default for new images if features not specified
194
195 rbd help copy
196 usage: rbd copy [--pool <pool>] [--image <image>] [--snap <snap>]
197 [--dest-pool <dest-pool>] [--dest <dest>] [--order <order>]
198 [--object-size <object-size>]
199 [--image-feature <image-feature>] [--image-shared]
200 [--stripe-unit <stripe-unit>] [--stripe-count <stripe-count>]
201 [--data-pool <data-pool>]
202 [--journal-splay-width <journal-splay-width>]
203 [--journal-object-size <journal-object-size>]
204 [--journal-pool <journal-pool>] [--sparse-size <sparse-size>]
205 [--no-progress]
206 <source-image-or-snap-spec> <dest-image-spec>
207
208 Copy src image to dest.
209
210 Positional arguments
211 <source-image-or-snap-spec> source image or snapshot specification
212 (example:
213 [<pool-name>/]<image-name>[@<snap-name>])
214 <dest-image-spec> destination image specification
215 (example: [<pool-name>/]<image-name>)
216
217 Optional arguments
218 -p [ --pool ] arg source pool name
219 --image arg source image name
220 --snap arg source snapshot name
221 --dest-pool arg destination pool name
222 --dest arg destination image name
223 --order arg object order [12 <= order <= 25]
224 --object-size arg object size in B/K/M [4K <= object size <= 32M]
225 --image-feature arg image features
226 [layering(+), striping, exclusive-lock(+*),
227 object-map(+*), fast-diff(+*), deep-flatten(+-),
228 journaling(*), data-pool]
229 --image-shared shared image
230 --stripe-unit arg stripe unit in B/K/M
231 --stripe-count arg stripe count
232 --data-pool arg data pool
233 --journal-splay-width arg number of active journal objects
234 --journal-object-size arg size of journal objects
235 --journal-pool arg pool for journal objects
236 --sparse-size arg sparse size in B/K/M [default: 4K]
237 --no-progress disable progress output
238
239 Image Features:
240 (*) supports enabling/disabling on existing images
241 (-) supports disabling-only on existing images
242 (+) enabled by default for new images if features not specified
243
244 rbd help create
245 usage: rbd create [--pool <pool>] [--image <image>]
246 [--image-format <image-format>] [--new-format]
247 [--order <order>] [--object-size <object-size>]
248 [--image-feature <image-feature>] [--image-shared]
249 [--stripe-unit <stripe-unit>]
250 [--stripe-count <stripe-count>] [--data-pool <data-pool>]
251 [--journal-splay-width <journal-splay-width>]
252 [--journal-object-size <journal-object-size>]
253 [--journal-pool <journal-pool>] --size <size>
254 <image-spec>
255
256 Create an empty image.
257
258 Positional arguments
259 <image-spec> image specification
260 (example: [<pool-name>/]<image-name>)
261
262 Optional arguments
263 -p [ --pool ] arg pool name
264 --image arg image name
265 --image-format arg image format [1 (deprecated) or 2]
266 --new-format use image format 2
267 (deprecated)
268 --order arg object order [12 <= order <= 25]
269 --object-size arg object size in B/K/M [4K <= object size <= 32M]
270 --image-feature arg image features
271 [layering(+), striping, exclusive-lock(+*),
272 object-map(+*), fast-diff(+*), deep-flatten(+-),
273 journaling(*), data-pool]
274 --image-shared shared image
275 --stripe-unit arg stripe unit in B/K/M
276 --stripe-count arg stripe count
277 --data-pool arg data pool
278 --journal-splay-width arg number of active journal objects
279 --journal-object-size arg size of journal objects
280 --journal-pool arg pool for journal objects
281 -s [ --size ] arg image size (in M/G/T) [default: M]
282
283 Image Features:
284 (*) supports enabling/disabling on existing images
285 (-) supports disabling-only on existing images
286 (+) enabled by default for new images if features not specified
287
288 rbd help diff
289 usage: rbd diff [--pool <pool>] [--image <image>] [--snap <snap>]
290 [--from-snap <from-snap>] [--whole-object] [--format <format>]
291 [--pretty-format]
292 <image-or-snap-spec>
293
294 Print extents that differ since a previous snap, or image creation.
295
296 Positional arguments
297 <image-or-snap-spec> image or snapshot specification
298 (example: [<pool-name>/]<image-name>[@<snap-name>])
299
300 Optional arguments
301 -p [ --pool ] arg pool name
302 --image arg image name
303 --snap arg snapshot name
304 --from-snap arg snapshot starting point
305 --whole-object compare whole object
306 --format arg output format [plain, json, or xml]
307 --pretty-format pretty formatting (json and xml)
308
309 rbd help disk-usage
310 usage: rbd disk-usage [--pool <pool>] [--image <image>] [--snap <snap>]
311 [--format <format>] [--pretty-format]
312 [--from-snap <from-snap>]
313 <image-or-snap-spec>
314
315 Show disk usage stats for pool, image or snapshot
316
317 Positional arguments
318 <image-or-snap-spec> image or snapshot specification
319 (example: [<pool-name>/]<image-name>[@<snap-name>])
320
321 Optional arguments
322 -p [ --pool ] arg pool name
323 --image arg image name
324 --snap arg snapshot name
325 --format arg output format [plain, json, or xml]
326 --pretty-format pretty formatting (json and xml)
327 --from-snap arg snapshot starting point
328
329 rbd help export
330 usage: rbd export [--pool <pool>] [--image <image>] [--snap <snap>]
331 [--path <path>] [--no-progress]
332 [--export-format <export-format>]
333 <source-image-or-snap-spec> <path-name>
334
335 Export image to file.
336
337 Positional arguments
338 <source-image-or-snap-spec> source image or snapshot specification
339 (example:
340 [<pool-name>/]<image-name>[@<snap-name>])
341 <path-name> export file (or '-' for stdout)
342
343 Optional arguments
344 -p [ --pool ] arg source pool name
345 --image arg source image name
346 --snap arg source snapshot name
347 --path arg export file (or '-' for stdout)
348 --no-progress disable progress output
349 --export-format arg format of image file
350
351 rbd help export-diff
352 usage: rbd export-diff [--pool <pool>] [--image <image>] [--snap <snap>]
353 [--path <path>] [--from-snap <from-snap>]
354 [--whole-object] [--no-progress]
355 <source-image-or-snap-spec> <path-name>
356
357 Export incremental diff to file.
358
359 Positional arguments
360 <source-image-or-snap-spec> source image or snapshot specification
361 (example:
362 [<pool-name>/]<image-name>[@<snap-name>])
363 <path-name> export file (or '-' for stdout)
364
365 Optional arguments
366 -p [ --pool ] arg source pool name
367 --image arg source image name
368 --snap arg source snapshot name
369 --path arg export file (or '-' for stdout)
370 --from-snap arg snapshot starting point
371 --whole-object compare whole object
372 --no-progress disable progress output
373
374 rbd help feature disable
375 usage: rbd feature disable [--pool <pool>] [--image <image>]
376 <image-spec> <features> [<features> ...]
377
378 Disable the specified image feature.
379
380 Positional arguments
381 <image-spec> image specification
382 (example: [<pool-name>/]<image-name>)
383 <features> image features
384 [layering, striping, exclusive-lock, object-map,
385 fast-diff, deep-flatten, journaling, data-pool]
386
387 Optional arguments
388 -p [ --pool ] arg pool name
389 --image arg image name
390
391 rbd help feature enable
392 usage: rbd feature enable [--pool <pool>] [--image <image>]
393 [--journal-splay-width <journal-splay-width>]
394 [--journal-object-size <journal-object-size>]
395 [--journal-pool <journal-pool>]
396 <image-spec> <features> [<features> ...]
397
398 Enable the specified image feature.
399
400 Positional arguments
401 <image-spec> image specification
402 (example: [<pool-name>/]<image-name>)
403 <features> image features
404 [layering, striping, exclusive-lock, object-map,
405 fast-diff, deep-flatten, journaling, data-pool]
406
407 Optional arguments
408 -p [ --pool ] arg pool name
409 --image arg image name
410 --journal-splay-width arg number of active journal objects
411 --journal-object-size arg size of journal objects
412 --journal-pool arg pool for journal objects
413
414 rbd help flatten
415 usage: rbd flatten [--pool <pool>] [--image <image>] [--no-progress]
416 <image-spec>
417
418 Fill clone with parent data (make it independent).
419
420 Positional arguments
421 <image-spec> image specification
422 (example: [<pool-name>/]<image-name>)
423
424 Optional arguments
425 -p [ --pool ] arg pool name
426 --image arg image name
427 --no-progress disable progress output
428
429 rbd help group create
430 usage: rbd group create [--pool <pool>] [--group <group>]
431 <group-spec>
432
433 Create a consistency group.
434
435 Positional arguments
436 <group-spec> group specification
437 (example: [<pool-name>/]<group-name>)
438
439 Optional arguments
440 -p [ --pool ] arg pool name
441 --group arg group name
442
443 rbd help group image add
444 usage: rbd group image add [--group-pool <group-pool>] [--group <group>]
445 [--image-pool <image-pool>] [--image <image>]
446 [--pool <pool>]
447 <group-spec> <image-spec>
448
449 Add an image to a consistency group.
450
451 Positional arguments
452 <group-spec> group specification
453 (example: [<pool-name>/]<group-name>)
454 <image-spec> image specification
455 (example: [<pool-name>/]<image-name>)
456
457 Optional arguments
458 --group-pool arg group pool name
459 --group arg group name
460 --image-pool arg image pool name
461 --image arg image name
462 -p [ --pool ] arg pool name unless overridden
463
464 rbd help group image list
465 usage: rbd group image list [--format <format>] [--pretty-format]
466 [--pool <pool>] [--group <group>]
467 <group-spec>
468
469 List images in a consistency group.
470
471 Positional arguments
472 <group-spec> group specification
473 (example: [<pool-name>/]<group-name>)
474
475 Optional arguments
476 --format arg output format [plain, json, or xml]
477 --pretty-format pretty formatting (json and xml)
478 -p [ --pool ] arg pool name
479 --group arg group name
480
481 rbd help group image remove
482 usage: rbd group image remove [--group-pool <group-pool>] [--group <group>]
483 [--image-pool <image-pool>] [--image <image>]
484 [--pool <pool>] [--image-id <image-id>]
485 <group-spec> <image-spec>
486
487 Remove an image from a consistency group.
488
489 Positional arguments
490 <group-spec> group specification
491 (example: [<pool-name>/]<group-name>)
492 <image-spec> image specification
493 (example: [<pool-name>/]<image-name>)
494
495 Optional arguments
496 --group-pool arg group pool name
497 --group arg group name
498 --image-pool arg image pool name
499 --image arg image name
500 -p [ --pool ] arg pool name unless overridden
501 --image-id arg image id
502
503 rbd help group list
504 usage: rbd group list [--pool <pool>] [--format <format>] [--pretty-format]
505
506 List rbd consistency groups.
507
508 Optional arguments
509 -p [ --pool ] arg pool name
510 --format arg output format [plain, json, or xml]
511 --pretty-format pretty formatting (json and xml)
512
513 rbd help group remove
514 usage: rbd group remove [--pool <pool>] [--group <group>]
515 <group-spec>
516
517 Delete a consistency group.
518
519 Positional arguments
520 <group-spec> group specification
521 (example: [<pool-name>/]<group-name>)
522
523 Optional arguments
524 -p [ --pool ] arg pool name
525 --group arg group name
526
527 rbd help image-meta get
528 usage: rbd image-meta get [--pool <pool>] [--image <image>]
529 <image-spec> <key>
530
531 Image metadata get the value associated with the key.
532
533 Positional arguments
534 <image-spec> image specification
535 (example: [<pool-name>/]<image-name>)
536 <key> image meta key
537
538 Optional arguments
539 -p [ --pool ] arg pool name
540 --image arg image name
541
542 rbd help image-meta list
543 usage: rbd image-meta list [--pool <pool>] [--image <image>]
544 [--format <format>] [--pretty-format]
545 <image-spec>
546
547 Image metadata list keys with values.
548
549 Positional arguments
550 <image-spec> image specification
551 (example: [<pool-name>/]<image-name>)
552
553 Optional arguments
554 -p [ --pool ] arg pool name
555 --image arg image name
556 --format arg output format [plain, json, or xml]
557 --pretty-format pretty formatting (json and xml)
558
559 rbd help image-meta remove
560 usage: rbd image-meta remove [--pool <pool>] [--image <image>]
561 <image-spec> <key>
562
563 Image metadata remove the key and value associated.
564
565 Positional arguments
566 <image-spec> image specification
567 (example: [<pool-name>/]<image-name>)
568 <key> image meta key
569
570 Optional arguments
571 -p [ --pool ] arg pool name
572 --image arg image name
573
574 rbd help image-meta set
575 usage: rbd image-meta set [--pool <pool>] [--image <image>]
576 <image-spec> <key> <value>
577
578 Image metadata set key with value.
579
580 Positional arguments
581 <image-spec> image specification
582 (example: [<pool-name>/]<image-name>)
583 <key> image meta key
584 <value> image meta value
585
586 Optional arguments
587 -p [ --pool ] arg pool name
588 --image arg image name
589
590 rbd help import
591 usage: rbd import [--path <path>] [--dest-pool <dest-pool>] [--dest <dest>]
592 [--image-format <image-format>] [--new-format]
593 [--order <order>] [--object-size <object-size>]
594 [--image-feature <image-feature>] [--image-shared]
595 [--stripe-unit <stripe-unit>]
596 [--stripe-count <stripe-count>] [--data-pool <data-pool>]
597 [--journal-splay-width <journal-splay-width>]
598 [--journal-object-size <journal-object-size>]
599 [--journal-pool <journal-pool>]
600 [--sparse-size <sparse-size>] [--no-progress]
601 [--export-format <export-format>] [--pool <pool>]
602 [--image <image>]
603 <path-name> <dest-image-spec>
604
605 Import image from file.
606
607 Positional arguments
608 <path-name> import file (or '-' for stdin)
609 <dest-image-spec> destination image specification
610 (example: [<pool-name>/]<image-name>)
611
612 Optional arguments
613 --path arg import file (or '-' for stdin)
614 --dest-pool arg destination pool name
615 --dest arg destination image name
616 --image-format arg image format [1 (deprecated) or 2]
617 --new-format use image format 2
618 (deprecated)
619 --order arg object order [12 <= order <= 25]
620 --object-size arg object size in B/K/M [4K <= object size <= 32M]
621 --image-feature arg image features
622 [layering(+), striping, exclusive-lock(+*),
623 object-map(+*), fast-diff(+*), deep-flatten(+-),
624 journaling(*), data-pool]
625 --image-shared shared image
626 --stripe-unit arg stripe unit in B/K/M
627 --stripe-count arg stripe count
628 --data-pool arg data pool
629 --journal-splay-width arg number of active journal objects
630 --journal-object-size arg size of journal objects
631 --journal-pool arg pool for journal objects
632 --sparse-size arg sparse size in B/K/M [default: 4K]
633 --no-progress disable progress output
634 --export-format arg format of image file
635 -p [ --pool ] arg pool name (deprecated)
636 --image arg image name (deprecated)
637
638 Image Features:
639 (*) supports enabling/disabling on existing images
640 (-) supports disabling-only on existing images
641 (+) enabled by default for new images if features not specified
642
643 rbd help import-diff
644 usage: rbd import-diff [--path <path>] [--pool <pool>] [--image <image>]
645 [--sparse-size <sparse-size>] [--no-progress]
646 <path-name> <image-spec>
647
648 Import an incremental diff.
649
650 Positional arguments
651 <path-name> import file (or '-' for stdin)
652 <image-spec> image specification
653 (example: [<pool-name>/]<image-name>)
654
655 Optional arguments
656 --path arg import file (or '-' for stdin)
657 -p [ --pool ] arg pool name
658 --image arg image name
659 --sparse-size arg sparse size in B/K/M [default: 4K]
660 --no-progress disable progress output
661
662 rbd help info
663 usage: rbd info [--pool <pool>] [--image <image>] [--snap <snap>]
664 [--image-id <image-id>] [--format <format>] [--pretty-format]
665 <image-or-snap-spec>
666
667 Show information about image size, striping, etc.
668
669 Positional arguments
670 <image-or-snap-spec> image or snapshot specification
671 (example: [<pool-name>/]<image-name>[@<snap-name>])
672
673 Optional arguments
674 -p [ --pool ] arg pool name
675 --image arg image name
676 --snap arg snapshot name
677 --image-id arg image id
678 --format arg output format [plain, json, or xml]
679 --pretty-format pretty formatting (json and xml)
680
681 rbd help journal client disconnect
682 usage: rbd journal client disconnect [--pool <pool>] [--image <image>]
683 [--journal <journal>]
684 [--client-id <client-id>]
685 <journal-spec>
686
687 Flag image journal client as disconnected.
688
689 Positional arguments
690 <journal-spec> journal specification
691 (example: [<pool-name>/]<journal-name>)
692
693 Optional arguments
694 -p [ --pool ] arg pool name
695 --image arg image name
696 --journal arg journal name
697 --client-id arg client ID (or leave unspecified to disconnect all)
698
699 rbd help journal export
700 usage: rbd journal export [--pool <pool>] [--image <image>]
701 [--journal <journal>] [--path <path>] [--verbose]
702 [--no-error]
703 <source-journal-spec> <path-name>
704
705 Export image journal.
706
707 Positional arguments
708 <source-journal-spec> source journal specification
709 (example: [<pool-name>/]<journal-name>)
710 <path-name> export file (or '-' for stdout)
711
712 Optional arguments
713 -p [ --pool ] arg source pool name
714 --image arg source image name
715 --journal arg source journal name
716 --path arg export file (or '-' for stdout)
717 --verbose be verbose
718 --no-error continue after error
719
720 rbd help journal import
721 usage: rbd journal import [--path <path>] [--dest-pool <dest-pool>]
722 [--dest <dest>] [--dest-journal <dest-journal>]
723 [--verbose] [--no-error]
724 <path-name> <dest-journal-spec>
725
726 Import image journal.
727
728 Positional arguments
729 <path-name> import file (or '-' for stdin)
730 <dest-journal-spec> destination journal specification
731 (example: [<pool-name>/]<journal-name>)
732
733 Optional arguments
734 --path arg import file (or '-' for stdin)
735 --dest-pool arg destination pool name
736 --dest arg destination image name
737 --dest-journal arg destination journal name
738 --verbose be verbose
739 --no-error continue after error
740
741 rbd help journal info
742 usage: rbd journal info [--pool <pool>] [--image <image>]
743 [--journal <journal>] [--format <format>]
744 [--pretty-format]
745 <journal-spec>
746
747 Show information about image journal.
748
749 Positional arguments
750 <journal-spec> journal specification
751 (example: [<pool-name>/]<journal-name>)
752
753 Optional arguments
754 -p [ --pool ] arg pool name
755 --image arg image name
756 --journal arg journal name
757 --format arg output format [plain, json, or xml]
758 --pretty-format pretty formatting (json and xml)
759
760 rbd help journal inspect
761 usage: rbd journal inspect [--pool <pool>] [--image <image>]
762 [--journal <journal>] [--verbose]
763 <journal-spec>
764
765 Inspect image journal for structural errors.
766
767 Positional arguments
768 <journal-spec> journal specification
769 (example: [<pool-name>/]<journal-name>)
770
771 Optional arguments
772 -p [ --pool ] arg pool name
773 --image arg image name
774 --journal arg journal name
775 --verbose be verbose
776
777 rbd help journal reset
778 usage: rbd journal reset [--pool <pool>] [--image <image>]
779 [--journal <journal>]
780 <journal-spec>
781
782 Reset image journal.
783
784 Positional arguments
785 <journal-spec> journal specification
786 (example: [<pool-name>/]<journal-name>)
787
788 Optional arguments
789 -p [ --pool ] arg pool name
790 --image arg image name
791 --journal arg journal name
792
793 rbd help journal status
794 usage: rbd journal status [--pool <pool>] [--image <image>]
795 [--journal <journal>] [--format <format>]
796 [--pretty-format]
797 <journal-spec>
798
799 Show status of image journal.
800
801 Positional arguments
802 <journal-spec> journal specification
803 (example: [<pool-name>/]<journal-name>)
804
805 Optional arguments
806 -p [ --pool ] arg pool name
807 --image arg image name
808 --journal arg journal name
809 --format arg output format [plain, json, or xml]
810 --pretty-format pretty formatting (json and xml)
811
812 rbd help list
813 usage: rbd list [--long] [--pool <pool>] [--format <format>] [--pretty-format]
814 <pool-name>
815
816 List rbd images.
817
818 Positional arguments
819 <pool-name> pool name
820
821 Optional arguments
822 -l [ --long ] long listing format
823 -p [ --pool ] arg pool name
824 --format arg output format [plain, json, or xml]
825 --pretty-format pretty formatting (json and xml)
826
827 rbd help lock add
828 usage: rbd lock add [--pool <pool>] [--image <image>] [--shared <shared>]
829 <image-spec> <lock-id>
830
831 Take a lock on an image.
832
833 Positional arguments
834 <image-spec> image specification
835 (example: [<pool-name>/]<image-name>)
836 <lock-id> unique lock id
837
838 Optional arguments
839 -p [ --pool ] arg pool name
840 --image arg image name
841 --shared arg shared lock tag
842
843 rbd help lock list
844 usage: rbd lock list [--pool <pool>] [--image <image>] [--format <format>]
845 [--pretty-format]
846 <image-spec>
847
848 Show locks held on an image.
849
850 Positional arguments
851 <image-spec> image specification
852 (example: [<pool-name>/]<image-name>)
853
854 Optional arguments
855 -p [ --pool ] arg pool name
856 --image arg image name
857 --format arg output format [plain, json, or xml]
858 --pretty-format pretty formatting (json and xml)
859
860 rbd help lock remove
861 usage: rbd lock remove [--pool <pool>] [--image <image>]
862 <image-spec> <lock-id> <locker>
863
864 Release a lock on an image.
865
866 Positional arguments
867 <image-spec> image specification
868 (example: [<pool-name>/]<image-name>)
869 <lock-id> unique lock id
870 <locker> locker client
871
872 Optional arguments
873 -p [ --pool ] arg pool name
874 --image arg image name
875
876 rbd help map
877 usage: rbd map [--pool <pool>] [--image <image>] [--snap <snap>]
878 [--options <options>] [--read-only] [--exclusive]
879 <image-or-snap-spec>
880
881 Map image to a block device using the kernel.
882
883 Positional arguments
884 <image-or-snap-spec> image or snapshot specification
885 (example: [<pool-name>/]<image-name>[@<snap-name>])
886
887 Optional arguments
888 -p [ --pool ] arg pool name
889 --image arg image name
890 --snap arg snapshot name
891 -o [ --options ] arg map options
892 --read-only map read-only
893 --exclusive disable automatic exclusive lock transitions
894
895 rbd help merge-diff
896 usage: rbd merge-diff [--path <path>] [--no-progress]
897 <diff1-path> <diff2-path> <path-name>
898
899 Merge two diff exports together.
900
901 Positional arguments
902 <diff1-path> path to first diff (or '-' for stdin)
903 <diff2-path> path to second diff
904 <path-name> path to merged diff (or '-' for stdout)
905
906 Optional arguments
907 --path arg path to merged diff (or '-' for stdout)
908 --no-progress disable progress output
909
910 rbd help mirror image demote
911 usage: rbd mirror image demote [--pool <pool>] [--image <image>]
912 <image-spec>
913
914 Demote an image to non-primary for RBD mirroring.
915
916 Positional arguments
917 <image-spec> image specification
918 (example: [<pool-name>/]<image-name>)
919
920 Optional arguments
921 -p [ --pool ] arg pool name
922 --image arg image name
923
924 rbd help mirror image disable
925 usage: rbd mirror image disable [--force] [--pool <pool>] [--image <image>]
926 <image-spec>
927
928 Disable RBD mirroring for an image.
929
930 Positional arguments
931 <image-spec> image specification
932 (example: [<pool-name>/]<image-name>)
933
934 Optional arguments
935 --force disable even if not primary
936 -p [ --pool ] arg pool name
937 --image arg image name
938
939 rbd help mirror image enable
940 usage: rbd mirror image enable [--pool <pool>] [--image <image>]
941 <image-spec>
942
943 Enable RBD mirroring for an image.
944
945 Positional arguments
946 <image-spec> image specification
947 (example: [<pool-name>/]<image-name>)
948
949 Optional arguments
950 -p [ --pool ] arg pool name
951 --image arg image name
952
953 rbd help mirror image promote
954 usage: rbd mirror image promote [--force] [--pool <pool>] [--image <image>]
955 <image-spec>
956
957 Promote an image to primary for RBD mirroring.
958
959 Positional arguments
960 <image-spec> image specification
961 (example: [<pool-name>/]<image-name>)
962
963 Optional arguments
964 --force promote even if not cleanly demoted by remote cluster
965 -p [ --pool ] arg pool name
966 --image arg image name
967
968 rbd help mirror image resync
969 usage: rbd mirror image resync [--pool <pool>] [--image <image>]
970 <image-spec>
971
972 Force resync to primary image for RBD mirroring.
973
974 Positional arguments
975 <image-spec> image specification
976 (example: [<pool-name>/]<image-name>)
977
978 Optional arguments
979 -p [ --pool ] arg pool name
980 --image arg image name
981
982 rbd help mirror image status
983 usage: rbd mirror image status [--pool <pool>] [--image <image>]
984 [--format <format>] [--pretty-format]
985 <image-spec>
986
987 Show RDB mirroring status for an image.
988
989 Positional arguments
990 <image-spec> image specification
991 (example: [<pool-name>/]<image-name>)
992
993 Optional arguments
994 -p [ --pool ] arg pool name
995 --image arg image name
996 --format arg output format [plain, json, or xml]
997 --pretty-format pretty formatting (json and xml)
998
999 rbd help mirror pool demote
1000 usage: rbd mirror pool demote [--pool <pool>]
1001 <pool-name>
1002
1003 Demote all primary images in the pool.
1004
1005 Positional arguments
1006 <pool-name> pool name
1007
1008 Optional arguments
1009 -p [ --pool ] arg pool name
1010
1011 rbd help mirror pool disable
1012 usage: rbd mirror pool disable [--pool <pool>]
1013 <pool-name>
1014
1015 Disable RBD mirroring by default within a pool.
1016
1017 Positional arguments
1018 <pool-name> pool name
1019
1020 Optional arguments
1021 -p [ --pool ] arg pool name
1022
1023 rbd help mirror pool enable
1024 usage: rbd mirror pool enable [--pool <pool>]
1025 <pool-name> <mode>
1026
1027 Enable RBD mirroring by default within a pool.
1028
1029 Positional arguments
1030 <pool-name> pool name
1031 <mode> mirror mode [image or pool]
1032
1033 Optional arguments
1034 -p [ --pool ] arg pool name
1035
1036 rbd help mirror pool info
1037 usage: rbd mirror pool info [--pool <pool>] [--format <format>]
1038 [--pretty-format]
1039 <pool-name>
1040
1041 Show information about the pool mirroring configuration.
1042
1043 Positional arguments
1044 <pool-name> pool name
1045
1046 Optional arguments
1047 -p [ --pool ] arg pool name
1048 --format arg output format [plain, json, or xml]
1049 --pretty-format pretty formatting (json and xml)
1050
1051 rbd help mirror pool peer add
1052 usage: rbd mirror pool peer add [--pool <pool>]
1053 [--remote-client-name <remote-client-name>]
1054 [--remote-cluster <remote-cluster>]
1055 <pool-name> <remote-cluster-spec>
1056
1057 Add a mirroring peer to a pool.
1058
1059 Positional arguments
1060 <pool-name> pool name
1061 <remote-cluster-spec> remote cluster spec
1062 (example: [<client name>@]<cluster name>
1063
1064 Optional arguments
1065 -p [ --pool ] arg pool name
1066 --remote-client-name arg remote client name
1067 --remote-cluster arg remote cluster name
1068
1069 rbd help mirror pool peer remove
1070 usage: rbd mirror pool peer remove [--pool <pool>]
1071 <pool-name> <uuid>
1072
1073 Remove a mirroring peer from a pool.
1074
1075 Positional arguments
1076 <pool-name> pool name
1077 <uuid> peer uuid
1078
1079 Optional arguments
1080 -p [ --pool ] arg pool name
1081
1082 rbd help mirror pool peer set
1083 usage: rbd mirror pool peer set [--pool <pool>]
1084 <pool-name> <uuid> <key> <value>
1085
1086 Update mirroring peer settings.
1087
1088 Positional arguments
1089 <pool-name> pool name
1090 <uuid> peer uuid
1091 <key> peer parameter [client or cluster]
1092 <value> new client or cluster name
1093
1094 Optional arguments
1095 -p [ --pool ] arg pool name
1096
1097 rbd help mirror pool promote
1098 usage: rbd mirror pool promote [--force] [--pool <pool>]
1099 <pool-name>
1100
1101 Promote all non-primary images in the pool.
1102
1103 Positional arguments
1104 <pool-name> pool name
1105
1106 Optional arguments
1107 --force promote even if not cleanly demoted by remote cluster
1108 -p [ --pool ] arg pool name
1109
1110 rbd help mirror pool status
1111 usage: rbd mirror pool status [--pool <pool>] [--format <format>]
1112 [--pretty-format] [--verbose]
1113 <pool-name>
1114
1115 Show status for all mirrored images in the pool.
1116
1117 Positional arguments
1118 <pool-name> pool name
1119
1120 Optional arguments
1121 -p [ --pool ] arg pool name
1122 --format arg output format [plain, json, or xml]
1123 --pretty-format pretty formatting (json and xml)
1124 --verbose be verbose
1125
1126 rbd help nbd list
1127 usage: rbd nbd list
1128
1129 List the nbd devices already used.
1130
1131 rbd help nbd map
1132 usage: rbd nbd map [--pool <pool>] [--image <image>] [--snap <snap>]
1133 [--read-only] [--exclusive] [--device <device>]
1134 [--nbds_max <nbds_max>] [--max_part <max_part>]
1135 <image-or-snap-spec>
1136
1137 Map image to a nbd device.
1138
1139 Positional arguments
1140 <image-or-snap-spec> image or snapshot specification
1141 (example: [<pool-name>/]<image-name>[@<snap-name>])
1142
1143 Optional arguments
1144 -p [ --pool ] arg pool name
1145 --image arg image name
1146 --snap arg snapshot name
1147 --read-only map read-only
1148 --exclusive forbid writes by other clients
1149 --device arg specify nbd device
1150 --nbds_max arg override module param nbds_max
1151 --max_part arg override module param max_part
1152
1153 rbd help nbd unmap
1154 usage: rbd nbd unmap
1155 <device-spec>
1156
1157 Unmap a nbd device.
1158
1159 Positional arguments
1160 <device-spec> specify nbd device
1161
1162 rbd help object-map check
1163 usage: rbd object-map check [--pool <pool>] [--image <image>] [--snap <snap>]
1164 [--no-progress]
1165 <image-or-snap-spec>
1166
1167 Verify the object map is correct.
1168
1169 Positional arguments
1170 <image-or-snap-spec> image or snapshot specification
1171 (example: [<pool-name>/]<image-name>[@<snap-name>])
1172
1173 Optional arguments
1174 -p [ --pool ] arg pool name
1175 --image arg image name
1176 --snap arg snapshot name
1177 --no-progress disable progress output
1178
1179 rbd help object-map rebuild
1180 usage: rbd object-map rebuild [--pool <pool>] [--image <image>]
1181 [--snap <snap>] [--no-progress]
1182 <image-or-snap-spec>
1183
1184 Rebuild an invalid object map.
1185
1186 Positional arguments
1187 <image-or-snap-spec> image or snapshot specification
1188 (example: [<pool-name>/]<image-name>[@<snap-name>])
1189
1190 Optional arguments
1191 -p [ --pool ] arg pool name
1192 --image arg image name
1193 --snap arg snapshot name
1194 --no-progress disable progress output
1195
1196 rbd help pool init
1197 usage: rbd pool init [--pool <pool>] [--force]
1198 <pool-name>
1199
1200 Initialize pool for use by RBD.
1201
1202 Positional arguments
1203 <pool-name> pool name
1204
1205 Optional arguments
1206 -p [ --pool ] arg pool name
1207 --force force initialize pool for RBD use if registered by
1208 another application
1209
1210 rbd help remove
1211 usage: rbd remove [--pool <pool>] [--image <image>] [--no-progress]
1212 <image-spec>
1213
1214 Delete an image.
1215
1216 Positional arguments
1217 <image-spec> image specification
1218 (example: [<pool-name>/]<image-name>)
1219
1220 Optional arguments
1221 -p [ --pool ] arg pool name
1222 --image arg image name
1223 --no-progress disable progress output
1224
1225 rbd help rename
1226 usage: rbd rename [--pool <pool>] [--image <image>] [--dest-pool <dest-pool>]
1227 [--dest <dest>]
1228 <source-image-spec> <dest-image-spec>
1229
1230 Rename image within pool.
1231
1232 Positional arguments
1233 <source-image-spec> source image specification
1234 (example: [<pool-name>/]<image-name>)
1235 <dest-image-spec> destination image specification
1236 (example: [<pool-name>/]<image-name>)
1237
1238 Optional arguments
1239 -p [ --pool ] arg source pool name
1240 --image arg source image name
1241 --dest-pool arg destination pool name
1242 --dest arg destination image name
1243
1244 rbd help resize
1245 usage: rbd resize [--pool <pool>] [--image <image>] --size <size>
1246 [--allow-shrink] [--no-progress]
1247 <image-spec>
1248
1249 Resize (expand or shrink) image.
1250
1251 Positional arguments
1252 <image-spec> image specification
1253 (example: [<pool-name>/]<image-name>)
1254
1255 Optional arguments
1256 -p [ --pool ] arg pool name
1257 --image arg image name
1258 -s [ --size ] arg image size (in M/G/T) [default: M]
1259 --allow-shrink permit shrinking
1260 --no-progress disable progress output
1261
1262 rbd help showmapped
1263 usage: rbd showmapped [--format <format>] [--pretty-format]
1264
1265 Show the rbd images mapped by the kernel.
1266
1267 Optional arguments
1268 --format arg output format [plain, json, or xml]
1269 --pretty-format pretty formatting (json and xml)
1270
1271 rbd help snap create
1272 usage: rbd snap create [--pool <pool>] [--image <image>] [--snap <snap>]
1273 <snap-spec>
1274
1275 Create a snapshot.
1276
1277 Positional arguments
1278 <snap-spec> snapshot specification
1279 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1280
1281 Optional arguments
1282 -p [ --pool ] arg pool name
1283 --image arg image name
1284 --snap arg snapshot name
1285
1286 rbd help snap limit clear
1287 usage: rbd snap limit clear [--pool <pool>] [--image <image>]
1288 <image-spec>
1289
1290 Remove snapshot limit.
1291
1292 Positional arguments
1293 <image-spec> image specification
1294 (example: [<pool-name>/]<image-name>)
1295
1296 Optional arguments
1297 -p [ --pool ] arg pool name
1298 --image arg image name
1299
1300 rbd help snap limit set
1301 usage: rbd snap limit set [--pool <pool>] [--image <image>] [--limit <limit>]
1302 <image-spec>
1303
1304 Limit the number of snapshots.
1305
1306 Positional arguments
1307 <image-spec> image specification
1308 (example: [<pool-name>/]<image-name>)
1309
1310 Optional arguments
1311 -p [ --pool ] arg pool name
1312 --image arg image name
1313 --limit arg maximum allowed snapshot count
1314
1315 rbd help snap list
1316 usage: rbd snap list [--pool <pool>] [--image <image>] [--image-id <image-id>]
1317 [--format <format>] [--pretty-format]
1318 <image-spec>
1319
1320 Dump list of image snapshots.
1321
1322 Positional arguments
1323 <image-spec> image specification
1324 (example: [<pool-name>/]<image-name>)
1325
1326 Optional arguments
1327 -p [ --pool ] arg pool name
1328 --image arg image name
1329 --image-id arg image id
1330 --format arg output format [plain, json, or xml]
1331 --pretty-format pretty formatting (json and xml)
1332
1333 rbd help snap protect
1334 usage: rbd snap protect [--pool <pool>] [--image <image>] [--snap <snap>]
1335 <snap-spec>
1336
1337 Prevent a snapshot from being deleted.
1338
1339 Positional arguments
1340 <snap-spec> snapshot specification
1341 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1342
1343 Optional arguments
1344 -p [ --pool ] arg pool name
1345 --image arg image name
1346 --snap arg snapshot name
1347
1348 rbd help snap purge
1349 usage: rbd snap purge [--pool <pool>] [--image <image>]
1350 [--image-id <image-id>] [--no-progress]
1351 <image-spec>
1352
1353 Delete all snapshots.
1354
1355 Positional arguments
1356 <image-spec> image specification
1357 (example: [<pool-name>/]<image-name>)
1358
1359 Optional arguments
1360 -p [ --pool ] arg pool name
1361 --image arg image name
1362 --image-id arg image id
1363 --no-progress disable progress output
1364
1365 rbd help snap remove
1366 usage: rbd snap remove [--pool <pool>] [--image <image>] [--snap <snap>]
1367 [--no-progress] [--image-id <image-id>] [--force]
1368 <snap-spec>
1369
1370 Delete a snapshot.
1371
1372 Positional arguments
1373 <snap-spec> snapshot specification
1374 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1375
1376 Optional arguments
1377 -p [ --pool ] arg pool name
1378 --image arg image name
1379 --snap arg snapshot name
1380 --no-progress disable progress output
1381 --image-id arg image id
1382 --force flatten children and unprotect snapshot if needed.
1383
1384 rbd help snap rename
1385 usage: rbd snap rename [--pool <pool>] [--image <image>] [--snap <snap>]
1386 [--dest-pool <dest-pool>] [--dest <dest>]
1387 [--dest-snap <dest-snap>]
1388 <source-snap-spec> <dest-snap-spec>
1389
1390 Rename a snapshot.
1391
1392 Positional arguments
1393 <source-snap-spec> source snapshot specification
1394 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1395 <dest-snap-spec> destination snapshot specification
1396 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1397
1398 Optional arguments
1399 -p [ --pool ] arg source pool name
1400 --image arg source image name
1401 --snap arg source snapshot name
1402 --dest-pool arg destination pool name
1403 --dest arg destination image name
1404 --dest-snap arg destination snapshot name
1405
1406 rbd help snap rollback
1407 usage: rbd snap rollback [--pool <pool>] [--image <image>] [--snap <snap>]
1408 [--no-progress]
1409 <snap-spec>
1410
1411 Rollback image to snapshot.
1412
1413 Positional arguments
1414 <snap-spec> snapshot specification
1415 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1416
1417 Optional arguments
1418 -p [ --pool ] arg pool name
1419 --image arg image name
1420 --snap arg snapshot name
1421 --no-progress disable progress output
1422
1423 rbd help snap unprotect
1424 usage: rbd snap unprotect [--pool <pool>] [--image <image>] [--snap <snap>]
1425 [--image-id <image-id>]
1426 <snap-spec>
1427
1428 Allow a snapshot to be deleted.
1429
1430 Positional arguments
1431 <snap-spec> snapshot specification
1432 (example: [<pool-name>/]<image-name>@<snapshot-name>)
1433
1434 Optional arguments
1435 -p [ --pool ] arg pool name
1436 --image arg image name
1437 --snap arg snapshot name
1438 --image-id arg image id
1439
1440 rbd help status
1441 usage: rbd status [--pool <pool>] [--image <image>] [--format <format>]
1442 [--pretty-format]
1443 <image-spec>
1444
1445 Show the status of this image.
1446
1447 Positional arguments
1448 <image-spec> image specification
1449 (example: [<pool-name>/]<image-name>)
1450
1451 Optional arguments
1452 -p [ --pool ] arg pool name
1453 --image arg image name
1454 --format arg output format [plain, json, or xml]
1455 --pretty-format pretty formatting (json and xml)
1456
1457 rbd help trash list
1458 usage: rbd trash list [--pool <pool>] [--all] [--long] [--format <format>]
1459 [--pretty-format]
1460 <pool-name>
1461
1462 List trash images.
1463
1464 Positional arguments
1465 <pool-name> pool name
1466
1467 Optional arguments
1468 -p [ --pool ] arg pool name
1469 -a [ --all ] list images from all sources
1470 -l [ --long ] long listing format
1471 --format arg output format [plain, json, or xml]
1472 --pretty-format pretty formatting (json and xml)
1473
1474 rbd help trash move
1475 usage: rbd trash move [--pool <pool>] [--image <image>] [--delay <delay>]
1476 <image-spec>
1477
1478 Move an image to the trash.
1479
1480 Positional arguments
1481 <image-spec> image specification
1482 (example: [<pool-name>/]<image-name>)
1483
1484 Optional arguments
1485 -p [ --pool ] arg pool name
1486 --image arg image name
1487 --delay arg time delay in seconds until effectively remove the image
1488
1489 rbd help trash remove
1490 usage: rbd trash remove [--pool <pool>] [--image-id <image-id>]
1491 [--no-progress] [--force]
1492 <image-id>
1493
1494 Remove an image from trash.
1495
1496 Positional arguments
1497 <image-id> image id
1498 (example: [<pool-name>/]<image-id>)
1499
1500 Optional arguments
1501 -p [ --pool ] arg pool name
1502 --image-id arg image id
1503 --no-progress disable progress output
1504 --force force remove of non-expired delayed images
1505
1506 rbd help trash restore
1507 usage: rbd trash restore [--pool <pool>] [--image-id <image-id>]
1508 [--image <image>]
1509 <image-id>
1510
1511 Restore an image from trash.
1512
1513 Positional arguments
1514 <image-id> image id
1515 (example: [<pool-name>/]<image-id>)
1516
1517 Optional arguments
1518 -p [ --pool ] arg pool name
1519 --image-id arg image id
1520 --image arg image name
1521
1522 rbd help unmap
1523 usage: rbd unmap [--pool <pool>] [--image <image>] [--snap <snap>]
1524 [--options <options>]
1525 <image-or-snap-or-device-spec>
1526
1527 Unmap a rbd device that was used by the kernel.
1528
1529 Positional arguments
1530 <image-or-snap-or-device-spec> image, snapshot, or device specification
1531 [<pool-name>/]<image-name>[@<snapshot-name>]
1532 or <device-path>
1533
1534 Optional arguments
1535 -p [ --pool ] arg pool name
1536 --image arg image name
1537 --snap arg snapshot name
1538 -o [ --options ] arg unmap options
1539
1540 rbd help watch
1541 usage: rbd watch [--pool <pool>] [--image <image>]
1542 <image-spec>
1543
1544 Watch events on image.
1545
1546 Positional arguments
1547 <image-spec> image specification
1548 (example: [<pool-name>/]<image-name>)
1549
1550 Optional arguments
1551 -p [ --pool ] arg pool name
1552 --image arg image name
1553
Ceph