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