]>
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> | |
11fdf7f2 TL |
8 | bench Simple benchmark. |
9 | children Display children of an image or its | |
10 | snapshot. | |
11 | clone Clone a snapshot into a CoW child image. | |
12 | config global get Get a global-level configuration override. | |
13 | config global list (... ls) List global-level configuration overrides. | |
14 | config global remove (... rm) Remove a global-level configuration | |
15 | override. | |
16 | config global set Set a global-level configuration override. | |
17 | config image get Get an image-level configuration override. | |
18 | config image list (... ls) List image-level configuration overrides. | |
19 | config image remove (... rm) Remove an image-level configuration | |
20 | override. | |
21 | config image set Set an image-level configuration override. | |
22 | config pool get Get a pool-level configuration override. | |
23 | config pool list (... ls) List pool-level configuration overrides. | |
24 | config pool remove (... rm) Remove a pool-level configuration | |
25 | override. | |
26 | config pool set Set a pool-level configuration override. | |
27 | copy (cp) Copy src image to dest. | |
28 | create Create an empty image. | |
29 | deep copy (deep cp) Deep copy src image to dest. | |
30 | device list (showmapped) List mapped rbd images. | |
31 | device map (map) Map an image to a block device. | |
32 | device unmap (unmap) Unmap a rbd device. | |
33 | diff Print extents that differ since a | |
34 | previous snap, or image creation. | |
35 | disk-usage (du) Show disk usage stats for pool, image or | |
36 | snapshot. | |
37 | export Export image to file. | |
38 | export-diff Export incremental diff to file. | |
39 | feature disable Disable the specified image feature. | |
40 | feature enable Enable the specified image feature. | |
41 | flatten Fill clone with parent data (make it | |
42 | independent). | |
43 | group create Create a group. | |
44 | group image add Add an image to a group. | |
45 | group image list (... ls) List images in a group. | |
46 | group image remove (... rm) Remove an image from a group. | |
47 | group list (group ls) List rbd groups. | |
48 | group remove (group rm) Delete a group. | |
49 | group rename Rename a group within pool. | |
50 | group snap create Make a snapshot of a group. | |
51 | group snap list (... ls) List snapshots of a group. | |
52 | group snap remove (... rm) Remove a snapshot from a group. | |
53 | group snap rename Rename group's snapshot. | |
54 | group snap rollback Rollback group to snapshot. | |
55 | image-meta get Image metadata get the value associated | |
56 | with the key. | |
57 | image-meta list (image-meta ls) Image metadata list keys with values. | |
58 | image-meta remove (image-meta rm) Image metadata remove the key and value | |
59 | associated. | |
60 | image-meta set Image metadata set key with value. | |
61 | import Import image from file. | |
62 | import-diff Import an incremental diff. | |
63 | info Show information about image size, | |
64 | striping, etc. | |
65 | journal client disconnect Flag image journal client as disconnected. | |
66 | journal export Export image journal. | |
67 | journal import Import image journal. | |
68 | journal info Show information about image journal. | |
69 | journal inspect Inspect image journal for structural | |
70 | errors. | |
71 | journal reset Reset image journal. | |
72 | journal status Show status of image journal. | |
73 | list (ls) List rbd images. | |
74 | lock add Take a lock on an image. | |
75 | lock list (lock ls) Show locks held on an image. | |
76 | lock remove (lock rm) Release a lock on an image. | |
77 | merge-diff Merge two diff exports together. | |
78 | migration abort Cancel interrupted image migration. | |
79 | migration commit Commit image migration. | |
80 | migration execute Execute image migration. | |
81 | migration prepare Prepare image migration. | |
82 | mirror image demote Demote an image to non-primary for RBD | |
83 | mirroring. | |
84 | mirror image disable Disable RBD mirroring for an image. | |
85 | mirror image enable Enable RBD mirroring for an image. | |
86 | mirror image promote Promote an image to primary for RBD | |
87 | mirroring. | |
88 | mirror image resync Force resync to primary image for RBD | |
89 | mirroring. | |
90 | mirror image status Show RBD mirroring status for an image. | |
91 | mirror pool demote Demote all primary images in the pool. | |
92 | mirror pool disable Disable RBD mirroring by default within a | |
93 | pool. | |
94 | mirror pool enable Enable RBD mirroring by default within a | |
95 | pool. | |
96 | mirror pool info Show information about the pool mirroring | |
97 | configuration. | |
98 | mirror pool peer add Add a mirroring peer to a pool. | |
eafe8130 TL |
99 | mirror pool peer bootstrap create Create a peer bootstrap token to import |
100 | in a remote cluster | |
101 | mirror pool peer bootstrap import Import a peer bootstrap token created | |
102 | from a remote cluster | |
11fdf7f2 TL |
103 | mirror pool peer remove Remove a mirroring peer from a pool. |
104 | mirror pool peer set Update mirroring peer settings. | |
105 | mirror pool promote Promote all non-primary images in the | |
106 | pool. | |
107 | mirror pool status Show status for all mirrored images in | |
108 | the pool. | |
109 | namespace create Create an RBD image namespace. | |
110 | namespace list (namespace ls) List RBD image namespaces. | |
111 | namespace remove (namespace rm) Remove an RBD image namespace. | |
112 | object-map check Verify the object map is correct. | |
113 | object-map rebuild Rebuild an invalid object map. | |
114 | perf image iostat Display image IO statistics. | |
115 | perf image iotop Display a top-like IO monitor. | |
116 | pool init Initialize pool for use by RBD. | |
117 | pool stats Display pool statistics. | |
118 | remove (rm) Delete an image. | |
119 | rename (mv) Rename image within pool. | |
120 | resize Resize (expand or shrink) image. | |
121 | snap create (snap add) Create a snapshot. | |
122 | snap limit clear Remove snapshot limit. | |
123 | snap limit set Limit the number of snapshots. | |
124 | snap list (snap ls) Dump list of image snapshots. | |
125 | snap protect Prevent a snapshot from being deleted. | |
126 | snap purge Delete all unprotected snapshots. | |
127 | snap remove (snap rm) Delete a snapshot. | |
128 | snap rename Rename a snapshot. | |
129 | snap rollback (snap revert) Rollback image to snapshot. | |
130 | snap unprotect Allow a snapshot to be deleted. | |
131 | sparsify Reclaim space for zeroed image extents. | |
132 | status Show the status of this image. | |
133 | trash list (trash ls) List trash images. | |
134 | trash move (trash mv) Move an image to the trash. | |
135 | trash purge Remove all expired images from trash. | |
136 | trash remove (trash rm) Remove an image from trash. | |
137 | trash restore Restore an image from trash. | |
138 | watch Watch events on image. | |
7c673cae FG |
139 | |
140 | Optional arguments: | |
141 | -c [ --conf ] arg path to cluster configuration | |
142 | --cluster arg cluster name | |
143 | --id arg client id (without 'client.' prefix) | |
144 | --user arg client id (without 'client.' prefix) | |
145 | -n [ --name ] arg client name | |
146 | -m [ --mon_host ] arg monitor host | |
147 | --secret arg path to secret key (deprecated) | |
148 | -K [ --keyfile ] arg path to secret key | |
149 | -k [ --keyring ] arg path to keyring | |
150 | ||
151 | See 'rbd help <command>' for help on a specific command. | |
152 | $ 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 | |
153 | rbd help bench | |
11fdf7f2 TL |
154 | usage: rbd bench [--pool <pool>] [--namespace <namespace>] [--image <image>] |
155 | [--io-size <io-size>] [--io-threads <io-threads>] | |
156 | [--io-total <io-total>] [--io-pattern <io-pattern>] | |
157 | [--rw-mix-read <rw-mix-read>] --io-type <io-type> | |
7c673cae FG |
158 | <image-spec> |
159 | ||
160 | Simple benchmark. | |
161 | ||
162 | Positional arguments | |
163 | <image-spec> image specification | |
11fdf7f2 | 164 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
165 | |
166 | Optional arguments | |
167 | -p [ --pool ] arg pool name | |
11fdf7f2 | 168 | --namespace arg namespace name |
7c673cae FG |
169 | --image arg image name |
170 | --io-size arg IO size (in B/K/M/G/T) [default: 4K] | |
171 | --io-threads arg ios in flight [default: 16] | |
172 | --io-total arg total size for IO (in B/K/M/G/T) [default: 1G] | |
173 | --io-pattern arg IO pattern (rand or seq) [default: seq] | |
11fdf7f2 TL |
174 | --rw-mix-read arg read proportion in readwrite (<= 100) [default: 50] |
175 | --io-type arg IO type (read , write, or readwrite(rw)) | |
7c673cae FG |
176 | |
177 | rbd help children | |
11fdf7f2 TL |
178 | usage: rbd children [--pool <pool>] [--namespace <namespace>] |
179 | [--image <image>] [--snap <snap>] [--snap-id <snap-id>] | |
180 | [--all] [--descendants] [--format <format>] | |
181 | [--pretty-format] | |
182 | <image-or-snap-spec> | |
7c673cae | 183 | |
11fdf7f2 | 184 | Display children of an image or its snapshot. |
7c673cae FG |
185 | |
186 | Positional arguments | |
11fdf7f2 TL |
187 | <image-or-snap-spec> image or snapshot specification |
188 | (example: | |
189 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-name>]) | |
7c673cae FG |
190 | |
191 | Optional arguments | |
11fdf7f2 TL |
192 | -p [ --pool ] arg pool name |
193 | --namespace arg namespace name | |
194 | --image arg image name | |
195 | --snap arg snapshot name | |
196 | --snap-id arg snapshot id | |
197 | -a [ --all ] list all children (include trash) | |
198 | --descendants include all descendants | |
199 | --format arg output format (plain, json, or xml) [default: plain] | |
200 | --pretty-format pretty formatting (json and xml) | |
7c673cae FG |
201 | |
202 | rbd help clone | |
11fdf7f2 TL |
203 | usage: rbd clone [--pool <pool>] [--namespace <namespace>] [--image <image>] |
204 | [--snap <snap>] [--dest-pool <dest-pool>] | |
205 | [--dest-namespace <dest-namespace>] [--dest <dest>] | |
206 | [--order <order>] [--object-size <object-size>] | |
7c673cae FG |
207 | [--image-feature <image-feature>] [--image-shared] |
208 | [--stripe-unit <stripe-unit>] [--stripe-count <stripe-count>] | |
209 | [--data-pool <data-pool>] | |
210 | [--journal-splay-width <journal-splay-width>] | |
211 | [--journal-object-size <journal-object-size>] | |
212 | [--journal-pool <journal-pool>] | |
213 | <source-snap-spec> <dest-image-spec> | |
214 | ||
11fdf7f2 | 215 | Clone a snapshot into a CoW child image. |
7c673cae FG |
216 | |
217 | Positional arguments | |
218 | <source-snap-spec> source snapshot specification | |
219 | (example: | |
11fdf7f2 TL |
220 | [<pool-name>/[<namespace>/]]<image-name>@<snapshot-n |
221 | ame>) | |
7c673cae | 222 | <dest-image-spec> destination image specification |
11fdf7f2 | 223 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
224 | |
225 | Optional arguments | |
226 | -p [ --pool ] arg source pool name | |
11fdf7f2 | 227 | --namespace arg source namespace name |
7c673cae FG |
228 | --image arg source image name |
229 | --snap arg source snapshot name | |
230 | --dest-pool arg destination pool name | |
11fdf7f2 | 231 | --dest-namespace arg destination namespace name |
7c673cae FG |
232 | --dest arg destination image name |
233 | --order arg object order [12 <= order <= 25] | |
234 | --object-size arg object size in B/K/M [4K <= object size <= 32M] | |
235 | --image-feature arg image features | |
11fdf7f2 TL |
236 | [layering(+), exclusive-lock(+*), object-map(+*), |
237 | deep-flatten(+-), journaling(*)] | |
7c673cae FG |
238 | --image-shared shared image |
239 | --stripe-unit arg stripe unit in B/K/M | |
240 | --stripe-count arg stripe count | |
241 | --data-pool arg data pool | |
242 | --journal-splay-width arg number of active journal objects | |
a8e16298 | 243 | --journal-object-size arg size of journal objects [4K <= size <= 64M] |
7c673cae FG |
244 | --journal-pool arg pool for journal objects |
245 | ||
246 | Image Features: | |
247 | (*) supports enabling/disabling on existing images | |
248 | (-) supports disabling-only on existing images | |
249 | (+) enabled by default for new images if features not specified | |
250 | ||
11fdf7f2 TL |
251 | rbd help config global get |
252 | usage: rbd config global get <config-entity> <key> | |
253 | ||
254 | Get a global-level configuration override. | |
255 | ||
256 | Positional arguments | |
257 | <config-entity> config entity (global, client, client.<id>) | |
258 | <key> config key | |
259 | ||
260 | rbd help config global list | |
261 | usage: rbd config global list [--format <format>] [--pretty-format] | |
262 | <config-entity> | |
263 | ||
264 | List global-level configuration overrides. | |
265 | ||
266 | Positional arguments | |
267 | <config-entity> config entity (global, client, client.<id>) | |
268 | ||
269 | Optional arguments | |
270 | --format arg output format (plain, json, or xml) [default: plain] | |
271 | --pretty-format pretty formatting (json and xml) | |
272 | ||
273 | rbd help config global remove | |
274 | usage: rbd config global remove <config-entity> <key> | |
275 | ||
276 | Remove a global-level configuration override. | |
277 | ||
278 | Positional arguments | |
279 | <config-entity> config entity (global, client, client.<id>) | |
280 | <key> config key | |
281 | ||
282 | rbd help config global set | |
283 | usage: rbd config global set <config-entity> <key> <value> | |
284 | ||
285 | Set a global-level configuration override. | |
286 | ||
287 | Positional arguments | |
288 | <config-entity> config entity (global, client, client.<id>) | |
289 | <key> config key | |
290 | <value> config value | |
291 | ||
292 | rbd help config image get | |
293 | usage: rbd config image get [--pool <pool>] [--namespace <namespace>] | |
294 | [--image <image>] | |
295 | <image-spec> <key> | |
296 | ||
297 | Get an image-level configuration override. | |
298 | ||
299 | Positional arguments | |
300 | <image-spec> image specification | |
301 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
302 | <key> config key | |
303 | ||
304 | Optional arguments | |
305 | -p [ --pool ] arg pool name | |
306 | --namespace arg namespace name | |
307 | --image arg image name | |
308 | ||
309 | rbd help config image list | |
310 | usage: rbd config image list [--pool <pool>] [--namespace <namespace>] | |
311 | [--image <image>] [--format <format>] | |
312 | [--pretty-format] | |
313 | <image-spec> | |
314 | ||
315 | List image-level configuration overrides. | |
316 | ||
317 | Positional arguments | |
318 | <image-spec> image specification | |
319 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
320 | ||
321 | Optional arguments | |
322 | -p [ --pool ] arg pool name | |
323 | --namespace arg namespace name | |
324 | --image arg image name | |
325 | --format arg output format (plain, json, or xml) [default: plain] | |
326 | --pretty-format pretty formatting (json and xml) | |
327 | ||
328 | rbd help config image remove | |
329 | usage: rbd config image remove [--pool <pool>] [--namespace <namespace>] | |
330 | [--image <image>] | |
331 | <image-spec> <key> | |
332 | ||
333 | Remove an image-level configuration override. | |
334 | ||
335 | Positional arguments | |
336 | <image-spec> image specification | |
337 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
338 | <key> config key | |
339 | ||
340 | Optional arguments | |
341 | -p [ --pool ] arg pool name | |
342 | --namespace arg namespace name | |
343 | --image arg image name | |
344 | ||
345 | rbd help config image set | |
346 | usage: rbd config image set [--pool <pool>] [--namespace <namespace>] | |
347 | [--image <image>] | |
348 | <image-spec> <key> <value> | |
349 | ||
350 | Set an image-level configuration override. | |
351 | ||
352 | Positional arguments | |
353 | <image-spec> image specification | |
354 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
355 | <key> config key | |
356 | <value> config value | |
357 | ||
358 | Optional arguments | |
359 | -p [ --pool ] arg pool name | |
360 | --namespace arg namespace name | |
361 | --image arg image name | |
362 | ||
363 | rbd help config pool get | |
364 | usage: rbd config pool get <pool-name> <key> | |
365 | ||
366 | Get a pool-level configuration override. | |
367 | ||
368 | Positional arguments | |
369 | <pool-name> pool name | |
370 | <key> config key | |
371 | ||
372 | rbd help config pool list | |
373 | usage: rbd config pool list [--format <format>] [--pretty-format] | |
374 | <pool-name> | |
375 | ||
376 | List pool-level configuration overrides. | |
377 | ||
378 | Positional arguments | |
379 | <pool-name> pool name | |
380 | ||
381 | Optional arguments | |
382 | --format arg output format (plain, json, or xml) [default: plain] | |
383 | --pretty-format pretty formatting (json and xml) | |
384 | ||
385 | rbd help config pool remove | |
386 | usage: rbd config pool remove <pool-name> <key> | |
387 | ||
388 | Remove a pool-level configuration override. | |
389 | ||
390 | Positional arguments | |
391 | <pool-name> pool name | |
392 | <key> config key | |
393 | ||
394 | rbd help config pool set | |
395 | usage: rbd config pool set <pool-name> <key> <value> | |
396 | ||
397 | Set a pool-level configuration override. | |
398 | ||
399 | Positional arguments | |
400 | <pool-name> pool name | |
401 | <key> config key | |
402 | <value> config value | |
403 | ||
7c673cae | 404 | rbd help copy |
11fdf7f2 TL |
405 | usage: rbd copy [--pool <pool>] [--namespace <namespace>] [--image <image>] |
406 | [--snap <snap>] [--dest-pool <dest-pool>] | |
407 | [--dest-namespace <dest-namespace>] [--dest <dest>] | |
408 | [--order <order>] [--object-size <object-size>] | |
7c673cae FG |
409 | [--image-feature <image-feature>] [--image-shared] |
410 | [--stripe-unit <stripe-unit>] [--stripe-count <stripe-count>] | |
411 | [--data-pool <data-pool>] | |
412 | [--journal-splay-width <journal-splay-width>] | |
413 | [--journal-object-size <journal-object-size>] | |
414 | [--journal-pool <journal-pool>] [--sparse-size <sparse-size>] | |
415 | [--no-progress] | |
416 | <source-image-or-snap-spec> <dest-image-spec> | |
417 | ||
418 | Copy src image to dest. | |
419 | ||
420 | Positional arguments | |
421 | <source-image-or-snap-spec> source image or snapshot specification | |
422 | (example: | |
11fdf7f2 TL |
423 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-n |
424 | ame>]) | |
7c673cae | 425 | <dest-image-spec> destination image specification |
11fdf7f2 TL |
426 | (example: |
427 | [<pool-name>/[<namespace>/]]<image-name>) | |
7c673cae FG |
428 | |
429 | Optional arguments | |
430 | -p [ --pool ] arg source pool name | |
11fdf7f2 | 431 | --namespace arg source namespace name |
7c673cae FG |
432 | --image arg source image name |
433 | --snap arg source snapshot name | |
434 | --dest-pool arg destination pool name | |
11fdf7f2 | 435 | --dest-namespace arg destination namespace name |
7c673cae FG |
436 | --dest arg destination image name |
437 | --order arg object order [12 <= order <= 25] | |
438 | --object-size arg object size in B/K/M [4K <= object size <= 32M] | |
439 | --image-feature arg image features | |
11fdf7f2 TL |
440 | [layering(+), exclusive-lock(+*), |
441 | object-map(+*), deep-flatten(+-), journaling(*)] | |
7c673cae FG |
442 | --image-shared shared image |
443 | --stripe-unit arg stripe unit in B/K/M | |
444 | --stripe-count arg stripe count | |
445 | --data-pool arg data pool | |
446 | --journal-splay-width arg number of active journal objects | |
a8e16298 | 447 | --journal-object-size arg size of journal objects [4K <= size <= 64M] |
7c673cae FG |
448 | --journal-pool arg pool for journal objects |
449 | --sparse-size arg sparse size in B/K/M [default: 4K] | |
450 | --no-progress disable progress output | |
451 | ||
452 | Image Features: | |
453 | (*) supports enabling/disabling on existing images | |
454 | (-) supports disabling-only on existing images | |
455 | (+) enabled by default for new images if features not specified | |
456 | ||
457 | rbd help create | |
11fdf7f2 | 458 | usage: rbd create [--pool <pool>] [--namespace <namespace>] [--image <image>] |
7c673cae FG |
459 | [--image-format <image-format>] [--new-format] |
460 | [--order <order>] [--object-size <object-size>] | |
461 | [--image-feature <image-feature>] [--image-shared] | |
462 | [--stripe-unit <stripe-unit>] | |
463 | [--stripe-count <stripe-count>] [--data-pool <data-pool>] | |
464 | [--journal-splay-width <journal-splay-width>] | |
465 | [--journal-object-size <journal-object-size>] | |
11fdf7f2 TL |
466 | [--journal-pool <journal-pool>] |
467 | [--thick-provision] --size <size> [--no-progress] | |
7c673cae FG |
468 | <image-spec> |
469 | ||
470 | Create an empty image. | |
471 | ||
472 | Positional arguments | |
473 | <image-spec> image specification | |
11fdf7f2 | 474 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
475 | |
476 | Optional arguments | |
477 | -p [ --pool ] arg pool name | |
11fdf7f2 | 478 | --namespace arg namespace name |
7c673cae FG |
479 | --image arg image name |
480 | --image-format arg image format [1 (deprecated) or 2] | |
481 | --new-format use image format 2 | |
482 | (deprecated) | |
483 | --order arg object order [12 <= order <= 25] | |
484 | --object-size arg object size in B/K/M [4K <= object size <= 32M] | |
485 | --image-feature arg image features | |
11fdf7f2 TL |
486 | [layering(+), exclusive-lock(+*), object-map(+*), |
487 | deep-flatten(+-), journaling(*)] | |
7c673cae FG |
488 | --image-shared shared image |
489 | --stripe-unit arg stripe unit in B/K/M | |
490 | --stripe-count arg stripe count | |
491 | --data-pool arg data pool | |
492 | --journal-splay-width arg number of active journal objects | |
a8e16298 | 493 | --journal-object-size arg size of journal objects [4K <= size <= 64M] |
7c673cae | 494 | --journal-pool arg pool for journal objects |
11fdf7f2 | 495 | --thick-provision fully allocate storage and zero image |
31f18b77 | 496 | -s [ --size ] arg image size (in M/G/T) [default: M] |
11fdf7f2 | 497 | --no-progress disable progress output |
7c673cae FG |
498 | |
499 | Image Features: | |
500 | (*) supports enabling/disabling on existing images | |
501 | (-) supports disabling-only on existing images | |
502 | (+) enabled by default for new images if features not specified | |
503 | ||
11fdf7f2 TL |
504 | rbd help deep copy |
505 | usage: rbd deep copy [--pool <pool>] [--namespace <namespace>] | |
506 | [--image <image>] [--snap <snap>] | |
507 | [--dest-pool <dest-pool>] | |
508 | [--dest-namespace <dest-namespace>] [--dest <dest>] | |
509 | [--order <order>] [--object-size <object-size>] | |
510 | [--image-feature <image-feature>] [--image-shared] | |
511 | [--stripe-unit <stripe-unit>] | |
512 | [--stripe-count <stripe-count>] [--data-pool <data-pool>] | |
513 | [--journal-splay-width <journal-splay-width>] | |
514 | [--journal-object-size <journal-object-size>] | |
515 | [--journal-pool <journal-pool>] [--flatten] | |
516 | [--no-progress] | |
517 | <source-image-or-snap-spec> <dest-image-spec> | |
518 | ||
519 | Deep copy src image to dest. | |
520 | ||
521 | Positional arguments | |
522 | <source-image-or-snap-spec> source image or snapshot specification | |
523 | (example: | |
524 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-n | |
525 | ame>]) | |
526 | <dest-image-spec> destination image specification | |
527 | (example: | |
528 | [<pool-name>/[<namespace>/]]<image-name>) | |
529 | ||
530 | Optional arguments | |
531 | -p [ --pool ] arg source pool name | |
532 | --namespace arg source namespace name | |
533 | --image arg source image name | |
534 | --snap arg source snapshot name | |
535 | --dest-pool arg destination pool name | |
536 | --dest-namespace arg destination namespace name | |
537 | --dest arg destination image name | |
538 | --order arg object order [12 <= order <= 25] | |
539 | --object-size arg object size in B/K/M [4K <= object size <= 32M] | |
540 | --image-feature arg image features | |
541 | [layering(+), exclusive-lock(+*), | |
542 | object-map(+*), deep-flatten(+-), journaling(*)] | |
543 | --image-shared shared image | |
544 | --stripe-unit arg stripe unit in B/K/M | |
545 | --stripe-count arg stripe count | |
546 | --data-pool arg data pool | |
547 | --journal-splay-width arg number of active journal objects | |
548 | --journal-object-size arg size of journal objects [4K <= size <= 64M] | |
549 | --journal-pool arg pool for journal objects | |
550 | --flatten fill clone with parent data (make it independent) | |
551 | --no-progress disable progress output | |
552 | ||
553 | Image Features: | |
554 | (*) supports enabling/disabling on existing images | |
555 | (-) supports disabling-only on existing images | |
556 | (+) enabled by default for new images if features not specified | |
557 | ||
558 | rbd help device list | |
559 | usage: rbd device list [--device-type <device-type>] [--format <format>] | |
560 | [--pretty-format] | |
561 | ||
562 | List mapped rbd images. | |
563 | ||
564 | Optional arguments | |
565 | -t [ --device-type ] arg device type [ggate, krbd (default), nbd] | |
566 | --format arg output format (plain, json, or xml) [default: plain] | |
567 | --pretty-format pretty formatting (json and xml) | |
568 | ||
569 | rbd help device map | |
570 | usage: rbd device map [--device-type <device-type>] [--pool <pool>] | |
571 | [--namespace <namespace>] [--image <image>] | |
572 | [--snap <snap>] [--read-only] [--exclusive] | |
573 | [--options <options>] | |
574 | <image-or-snap-spec> | |
575 | ||
576 | Map an image to a block device. | |
577 | ||
578 | Positional arguments | |
579 | <image-or-snap-spec> image or snapshot specification | |
580 | (example: | |
581 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-name> | |
582 | ]) | |
583 | ||
584 | Optional arguments | |
585 | -t [ --device-type ] arg device type [ggate, krbd (default), nbd] | |
586 | -p [ --pool ] arg pool name | |
587 | --namespace arg namespace name | |
588 | --image arg image name | |
589 | --snap arg snapshot name | |
590 | --read-only map read-only | |
591 | --exclusive disable automatic exclusive lock transitions | |
592 | -o [ --options ] arg device specific options | |
593 | ||
594 | rbd help device unmap | |
595 | usage: rbd device unmap [--device-type <device-type>] [--pool <pool>] | |
596 | [--image <image>] [--snap <snap>] [--options <options>] | |
597 | <image-or-snap-or-device-spec> | |
598 | ||
599 | Unmap a rbd device. | |
600 | ||
601 | Positional arguments | |
602 | <image-or-snap-or-device-spec> image, snapshot, or device specification | |
603 | [<pool-name>/]<image-name>[@<snapshot-name>] | |
604 | or <device-path> | |
605 | ||
606 | Optional arguments | |
607 | -t [ --device-type ] arg device type [ggate, krbd (default), nbd] | |
608 | -p [ --pool ] arg pool name | |
609 | --image arg image name | |
610 | --snap arg snapshot name | |
611 | -o [ --options ] arg device specific options | |
612 | ||
7c673cae | 613 | rbd help diff |
11fdf7f2 TL |
614 | usage: rbd diff [--pool <pool>] [--namespace <namespace>] [--image <image>] |
615 | [--snap <snap>] [--from-snap <from-snap>] [--whole-object] | |
616 | [--format <format>] [--pretty-format] | |
7c673cae FG |
617 | <image-or-snap-spec> |
618 | ||
619 | Print extents that differ since a previous snap, or image creation. | |
620 | ||
621 | Positional arguments | |
622 | <image-or-snap-spec> image or snapshot specification | |
11fdf7f2 TL |
623 | (example: |
624 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-name>]) | |
7c673cae FG |
625 | |
626 | Optional arguments | |
627 | -p [ --pool ] arg pool name | |
11fdf7f2 | 628 | --namespace arg namespace name |
7c673cae FG |
629 | --image arg image name |
630 | --snap arg snapshot name | |
631 | --from-snap arg snapshot starting point | |
632 | --whole-object compare whole object | |
181888fb | 633 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
634 | --pretty-format pretty formatting (json and xml) |
635 | ||
636 | rbd help disk-usage | |
11fdf7f2 TL |
637 | usage: rbd disk-usage [--pool <pool>] [--namespace <namespace>] |
638 | [--image <image>] [--snap <snap>] [--format <format>] | |
639 | [--pretty-format] [--from-snap <from-snap>] [--exact] | |
7c673cae FG |
640 | <image-or-snap-spec> |
641 | ||
11fdf7f2 | 642 | Show disk usage stats for pool, image or snapshot. |
7c673cae FG |
643 | |
644 | Positional arguments | |
645 | <image-or-snap-spec> image or snapshot specification | |
11fdf7f2 TL |
646 | (example: |
647 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-name>]) | |
7c673cae FG |
648 | |
649 | Optional arguments | |
650 | -p [ --pool ] arg pool name | |
11fdf7f2 | 651 | --namespace arg namespace name |
7c673cae FG |
652 | --image arg image name |
653 | --snap arg snapshot name | |
181888fb | 654 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
655 | --pretty-format pretty formatting (json and xml) |
656 | --from-snap arg snapshot starting point | |
11fdf7f2 | 657 | --exact compute exact disk usage (slow) |
7c673cae FG |
658 | |
659 | rbd help export | |
11fdf7f2 TL |
660 | usage: rbd export [--pool <pool>] [--namespace <namespace>] [--image <image>] |
661 | [--snap <snap>] [--path <path>] [--no-progress] | |
7c673cae FG |
662 | [--export-format <export-format>] |
663 | <source-image-or-snap-spec> <path-name> | |
664 | ||
665 | Export image to file. | |
666 | ||
667 | Positional arguments | |
668 | <source-image-or-snap-spec> source image or snapshot specification | |
669 | (example: | |
11fdf7f2 TL |
670 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-n |
671 | ame>]) | |
7c673cae FG |
672 | <path-name> export file (or '-' for stdout) |
673 | ||
674 | Optional arguments | |
675 | -p [ --pool ] arg source pool name | |
11fdf7f2 | 676 | --namespace arg source namespace name |
7c673cae FG |
677 | --image arg source image name |
678 | --snap arg source snapshot name | |
679 | --path arg export file (or '-' for stdout) | |
680 | --no-progress disable progress output | |
681 | --export-format arg format of image file | |
682 | ||
683 | rbd help export-diff | |
11fdf7f2 TL |
684 | usage: rbd export-diff [--pool <pool>] [--namespace <namespace>] |
685 | [--image <image>] [--snap <snap>] [--path <path>] | |
686 | [--from-snap <from-snap>] [--whole-object] | |
687 | [--no-progress] | |
7c673cae FG |
688 | <source-image-or-snap-spec> <path-name> |
689 | ||
690 | Export incremental diff to file. | |
691 | ||
692 | Positional arguments | |
693 | <source-image-or-snap-spec> source image or snapshot specification | |
694 | (example: | |
11fdf7f2 TL |
695 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-n |
696 | ame>]) | |
7c673cae FG |
697 | <path-name> export file (or '-' for stdout) |
698 | ||
699 | Optional arguments | |
700 | -p [ --pool ] arg source pool name | |
11fdf7f2 | 701 | --namespace arg source namespace name |
7c673cae FG |
702 | --image arg source image name |
703 | --snap arg source snapshot name | |
704 | --path arg export file (or '-' for stdout) | |
705 | --from-snap arg snapshot starting point | |
706 | --whole-object compare whole object | |
707 | --no-progress disable progress output | |
708 | ||
709 | rbd help feature disable | |
11fdf7f2 TL |
710 | usage: rbd feature disable [--pool <pool>] [--namespace <namespace>] |
711 | [--image <image>] | |
7c673cae FG |
712 | <image-spec> <features> [<features> ...] |
713 | ||
714 | Disable the specified image feature. | |
715 | ||
716 | Positional arguments | |
717 | <image-spec> image specification | |
11fdf7f2 | 718 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae | 719 | <features> image features |
11fdf7f2 | 720 | [exclusive-lock, object-map, journaling] |
7c673cae FG |
721 | |
722 | Optional arguments | |
723 | -p [ --pool ] arg pool name | |
11fdf7f2 | 724 | --namespace arg namespace name |
7c673cae FG |
725 | --image arg image name |
726 | ||
727 | rbd help feature enable | |
11fdf7f2 TL |
728 | usage: rbd feature enable [--pool <pool>] [--namespace <namespace>] |
729 | [--image <image>] | |
7c673cae FG |
730 | [--journal-splay-width <journal-splay-width>] |
731 | [--journal-object-size <journal-object-size>] | |
732 | [--journal-pool <journal-pool>] | |
733 | <image-spec> <features> [<features> ...] | |
734 | ||
735 | Enable the specified image feature. | |
736 | ||
737 | Positional arguments | |
738 | <image-spec> image specification | |
11fdf7f2 | 739 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae | 740 | <features> image features |
11fdf7f2 | 741 | [exclusive-lock, object-map, journaling] |
7c673cae FG |
742 | |
743 | Optional arguments | |
744 | -p [ --pool ] arg pool name | |
11fdf7f2 | 745 | --namespace arg namespace name |
7c673cae FG |
746 | --image arg image name |
747 | --journal-splay-width arg number of active journal objects | |
a8e16298 | 748 | --journal-object-size arg size of journal objects [4K <= size <= 64M] |
7c673cae FG |
749 | --journal-pool arg pool for journal objects |
750 | ||
751 | rbd help flatten | |
11fdf7f2 TL |
752 | usage: rbd flatten [--pool <pool>] [--namespace <namespace>] [--image <image>] |
753 | [--no-progress] | |
7c673cae FG |
754 | <image-spec> |
755 | ||
756 | Fill clone with parent data (make it independent). | |
757 | ||
758 | Positional arguments | |
759 | <image-spec> image specification | |
11fdf7f2 | 760 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
761 | |
762 | Optional arguments | |
763 | -p [ --pool ] arg pool name | |
11fdf7f2 | 764 | --namespace arg namespace name |
7c673cae FG |
765 | --image arg image name |
766 | --no-progress disable progress output | |
767 | ||
11fdf7f2 TL |
768 | rbd help group create |
769 | usage: rbd group create [--pool <pool>] [--namespace <namespace>] | |
770 | [--group <group>] | |
771 | <group-spec> | |
772 | ||
773 | Create a group. | |
774 | ||
775 | Positional arguments | |
776 | <group-spec> group specification | |
777 | (example: [<pool-name>/[<namespace>/]]<group-name>) | |
778 | ||
779 | Optional arguments | |
780 | -p [ --pool ] arg pool name | |
781 | --namespace arg namespace name | |
782 | --group arg group name | |
783 | ||
784 | rbd help group image add | |
785 | usage: rbd group image add [--group-pool <group-pool>] | |
786 | [--group-namespace <group-namespace>] | |
787 | [--group <group>] [--image-pool <image-pool>] | |
788 | [--image-namespace <image-namespace>] | |
789 | [--image <image>] [--pool <pool>] | |
790 | <group-spec> <image-spec> | |
791 | ||
792 | Add an image to a group. | |
793 | ||
794 | Positional arguments | |
795 | <group-spec> group specification | |
796 | (example: [<pool-name>/[<namespace>/]]<group-name>) | |
797 | <image-spec> image specification | |
798 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
799 | ||
800 | Optional arguments | |
801 | --group-pool arg group pool name | |
802 | --group-namespace arg group namespace name | |
803 | --group arg group name | |
804 | --image-pool arg image pool name | |
805 | --image-namespace arg image namespace name | |
806 | --image arg image name | |
807 | -p [ --pool ] arg pool name unless overridden | |
808 | ||
809 | rbd help group image list | |
810 | usage: rbd group image list [--format <format>] [--pretty-format] | |
811 | [--pool <pool>] [--namespace <namespace>] | |
812 | [--group <group>] | |
813 | <group-spec> | |
814 | ||
815 | List images in a group. | |
816 | ||
817 | Positional arguments | |
818 | <group-spec> group specification | |
819 | (example: [<pool-name>/[<namespace>/]]<group-name>) | |
820 | ||
821 | Optional arguments | |
822 | --format arg output format (plain, json, or xml) [default: plain] | |
823 | --pretty-format pretty formatting (json and xml) | |
824 | -p [ --pool ] arg pool name | |
825 | --namespace arg namespace name | |
826 | --group arg group name | |
827 | ||
828 | rbd help group image remove | |
829 | usage: rbd group image remove [--group-pool <group-pool>] | |
830 | [--group-namespace <group-namespace>] | |
831 | [--group <group>] [--image-pool <image-pool>] | |
832 | [--image-namespace <image-namespace>] | |
833 | [--image <image>] [--pool <pool>] | |
834 | [--image-id <image-id>] | |
835 | <group-spec> <image-spec> | |
836 | ||
837 | Remove an image from a group. | |
838 | ||
839 | Positional arguments | |
840 | <group-spec> group specification | |
841 | (example: [<pool-name>/[<namespace>/]]<group-name>) | |
842 | <image-spec> image specification | |
843 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
844 | ||
845 | Optional arguments | |
846 | --group-pool arg group pool name | |
847 | --group-namespace arg group namespace name | |
848 | --group arg group name | |
849 | --image-pool arg image pool name | |
850 | --image-namespace arg image namespace name | |
851 | --image arg image name | |
852 | -p [ --pool ] arg pool name unless overridden | |
853 | --image-id arg image id | |
854 | ||
855 | rbd help group list | |
856 | usage: rbd group list [--pool <pool>] [--namespace <namespace>] | |
857 | [--format <format>] [--pretty-format] | |
858 | <pool-spec> | |
859 | ||
860 | List rbd groups. | |
861 | ||
862 | Positional arguments | |
863 | <pool-spec> pool specification | |
864 | (example: <pool-name>[/<namespace>] | |
865 | ||
866 | Optional arguments | |
867 | -p [ --pool ] arg pool name | |
868 | --namespace arg namespace name | |
869 | --format arg output format (plain, json, or xml) [default: plain] | |
870 | --pretty-format pretty formatting (json and xml) | |
871 | ||
872 | rbd help group remove | |
873 | usage: rbd group remove [--pool <pool>] [--namespace <namespace>] | |
874 | [--group <group>] | |
875 | <group-spec> | |
876 | ||
877 | Delete a group. | |
878 | ||
879 | Positional arguments | |
880 | <group-spec> group specification | |
881 | (example: [<pool-name>/[<namespace>/]]<group-name>) | |
882 | ||
883 | Optional arguments | |
884 | -p [ --pool ] arg pool name | |
885 | --namespace arg namespace name | |
886 | --group arg group name | |
887 | ||
888 | rbd help group rename | |
889 | usage: rbd group rename [--pool <pool>] [--namespace <namespace>] | |
890 | [--group <group>] [--dest-pool <dest-pool>] | |
891 | [--dest-namespace <dest-namespace>] | |
892 | [--dest-group <dest-group>] | |
893 | <source-group-spec> <dest-group-spec> | |
894 | ||
895 | Rename a group within pool. | |
896 | ||
897 | Positional arguments | |
898 | <source-group-spec> source group specification | |
899 | (example: [<pool-name>/[<namespace>/]]<group-name>) | |
900 | <dest-group-spec> destination group specification | |
901 | (example: [<pool-name>/[<namespace>/]]<group-name>) | |
902 | ||
903 | Optional arguments | |
904 | -p [ --pool ] arg source pool name | |
905 | --namespace arg source namespace name | |
906 | --group arg source group name | |
907 | --dest-pool arg destination pool name | |
908 | --dest-namespace arg destination namespace name | |
909 | --dest-group arg destination group name | |
910 | ||
911 | rbd help group snap create | |
912 | usage: rbd group snap create [--pool <pool>] [--namespace <namespace>] | |
913 | [--group <group>] [--snap <snap>] | |
914 | <group-snap-spec> | |
915 | ||
916 | Make a snapshot of a group. | |
917 | ||
918 | Positional arguments | |
919 | <group-snap-spec> group specification | |
920 | (example: | |
921 | [<pool-name>/[<namespace>/]]<group-name>@<snap-name>) | |
922 | ||
923 | Optional arguments | |
924 | -p [ --pool ] arg pool name | |
925 | --namespace arg namespace name | |
926 | --group arg group name | |
927 | --snap arg snapshot name | |
928 | ||
929 | rbd help group snap list | |
930 | usage: rbd group snap list [--format <format>] [--pretty-format] | |
931 | [--pool <pool>] [--namespace <namespace>] | |
932 | [--group <group>] | |
933 | <group-spec> | |
934 | ||
935 | List snapshots of a group. | |
936 | ||
937 | Positional arguments | |
938 | <group-spec> group specification | |
939 | (example: [<pool-name>/[<namespace>/]]<group-name>) | |
940 | ||
941 | Optional arguments | |
942 | --format arg output format (plain, json, or xml) [default: plain] | |
943 | --pretty-format pretty formatting (json and xml) | |
944 | -p [ --pool ] arg pool name | |
945 | --namespace arg namespace name | |
946 | --group arg group name | |
947 | ||
948 | rbd help group snap remove | |
949 | usage: rbd group snap remove [--pool <pool>] [--namespace <namespace>] | |
950 | [--group <group>] [--snap <snap>] | |
951 | <group-snap-spec> | |
952 | ||
953 | Remove a snapshot from a group. | |
954 | ||
955 | Positional arguments | |
956 | <group-snap-spec> group specification | |
957 | (example: | |
958 | [<pool-name>/[<namespace>/]]<group-name>@<snap-name>) | |
959 | ||
960 | Optional arguments | |
961 | -p [ --pool ] arg pool name | |
962 | --namespace arg namespace name | |
963 | --group arg group name | |
964 | --snap arg snapshot name | |
965 | ||
966 | rbd help group snap rename | |
967 | usage: rbd group snap rename [--pool <pool>] [--namespace <namespace>] | |
968 | [--group <group>] [--snap <snap>] | |
969 | [--dest-snap <dest-snap>] | |
970 | <group-snap-spec> <dest-snap> | |
971 | ||
972 | Rename group's snapshot. | |
973 | ||
974 | Positional arguments | |
975 | <group-snap-spec> group specification | |
976 | (example: | |
977 | [<pool-name>/[<namespace>/]]<group-name>@<snap-name>) | |
978 | <dest-snap> destination snapshot name | |
979 | (example: <snapshot-name>) | |
980 | ||
981 | Optional arguments | |
982 | -p [ --pool ] arg pool name | |
983 | --namespace arg namespace name | |
984 | --group arg group name | |
985 | --snap arg snapshot name | |
986 | --dest-snap arg destination snapshot name | |
987 | ||
988 | rbd help group snap rollback | |
989 | usage: rbd group snap rollback [--no-progress] [--pool <pool>] | |
990 | [--namespace <namespace>] [--group <group>] | |
991 | [--snap <snap>] | |
992 | <group-snap-spec> | |
993 | ||
994 | Rollback group to snapshot. | |
995 | ||
996 | Positional arguments | |
997 | <group-snap-spec> group specification | |
998 | (example: | |
999 | [<pool-name>/[<namespace>/]]<group-name>@<snap-name>) | |
1000 | ||
1001 | Optional arguments | |
1002 | --no-progress disable progress output | |
1003 | -p [ --pool ] arg pool name | |
1004 | --namespace arg namespace name | |
1005 | --group arg group name | |
1006 | --snap arg snapshot name | |
1007 | ||
7c673cae | 1008 | rbd help image-meta get |
11fdf7f2 TL |
1009 | usage: rbd image-meta get [--pool <pool>] [--namespace <namespace>] |
1010 | [--image <image>] | |
7c673cae FG |
1011 | <image-spec> <key> |
1012 | ||
1013 | Image metadata get the value associated with the key. | |
1014 | ||
1015 | Positional arguments | |
1016 | <image-spec> image specification | |
11fdf7f2 | 1017 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1018 | <key> image meta key |
1019 | ||
1020 | Optional arguments | |
1021 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1022 | --namespace arg namespace name |
7c673cae FG |
1023 | --image arg image name |
1024 | ||
1025 | rbd help image-meta list | |
11fdf7f2 TL |
1026 | usage: rbd image-meta list [--pool <pool>] [--namespace <namespace>] |
1027 | [--image <image>] [--format <format>] | |
1028 | [--pretty-format] | |
7c673cae FG |
1029 | <image-spec> |
1030 | ||
1031 | Image metadata list keys with values. | |
1032 | ||
1033 | Positional arguments | |
1034 | <image-spec> image specification | |
11fdf7f2 | 1035 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1036 | |
1037 | Optional arguments | |
1038 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1039 | --namespace arg namespace name |
7c673cae | 1040 | --image arg image name |
181888fb | 1041 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
1042 | --pretty-format pretty formatting (json and xml) |
1043 | ||
1044 | rbd help image-meta remove | |
11fdf7f2 TL |
1045 | usage: rbd image-meta remove [--pool <pool>] [--namespace <namespace>] |
1046 | [--image <image>] | |
7c673cae FG |
1047 | <image-spec> <key> |
1048 | ||
1049 | Image metadata remove the key and value associated. | |
1050 | ||
1051 | Positional arguments | |
1052 | <image-spec> image specification | |
11fdf7f2 | 1053 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1054 | <key> image meta key |
1055 | ||
1056 | Optional arguments | |
1057 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1058 | --namespace arg namespace name |
7c673cae FG |
1059 | --image arg image name |
1060 | ||
1061 | rbd help image-meta set | |
11fdf7f2 TL |
1062 | usage: rbd image-meta set [--pool <pool>] [--namespace <namespace>] |
1063 | [--image <image>] | |
7c673cae FG |
1064 | <image-spec> <key> <value> |
1065 | ||
1066 | Image metadata set key with value. | |
1067 | ||
1068 | Positional arguments | |
1069 | <image-spec> image specification | |
11fdf7f2 | 1070 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1071 | <key> image meta key |
1072 | <value> image meta value | |
1073 | ||
1074 | Optional arguments | |
1075 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1076 | --namespace arg namespace name |
7c673cae FG |
1077 | --image arg image name |
1078 | ||
1079 | rbd help import | |
11fdf7f2 TL |
1080 | usage: rbd import [--path <path>] [--dest-pool <dest-pool>] |
1081 | [--dest-namespace <dest-namespace>] [--dest <dest>] | |
7c673cae FG |
1082 | [--image-format <image-format>] [--new-format] |
1083 | [--order <order>] [--object-size <object-size>] | |
1084 | [--image-feature <image-feature>] [--image-shared] | |
1085 | [--stripe-unit <stripe-unit>] | |
1086 | [--stripe-count <stripe-count>] [--data-pool <data-pool>] | |
1087 | [--journal-splay-width <journal-splay-width>] | |
1088 | [--journal-object-size <journal-object-size>] | |
1089 | [--journal-pool <journal-pool>] | |
1090 | [--sparse-size <sparse-size>] [--no-progress] | |
1091 | [--export-format <export-format>] [--pool <pool>] | |
1092 | [--image <image>] | |
1093 | <path-name> <dest-image-spec> | |
1094 | ||
1095 | Import image from file. | |
1096 | ||
1097 | Positional arguments | |
1098 | <path-name> import file (or '-' for stdin) | |
1099 | <dest-image-spec> destination image specification | |
11fdf7f2 | 1100 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1101 | |
1102 | Optional arguments | |
1103 | --path arg import file (or '-' for stdin) | |
1104 | --dest-pool arg destination pool name | |
11fdf7f2 | 1105 | --dest-namespace arg destination namespace name |
7c673cae FG |
1106 | --dest arg destination image name |
1107 | --image-format arg image format [1 (deprecated) or 2] | |
1108 | --new-format use image format 2 | |
1109 | (deprecated) | |
1110 | --order arg object order [12 <= order <= 25] | |
1111 | --object-size arg object size in B/K/M [4K <= object size <= 32M] | |
1112 | --image-feature arg image features | |
11fdf7f2 TL |
1113 | [layering(+), exclusive-lock(+*), object-map(+*), |
1114 | deep-flatten(+-), journaling(*)] | |
7c673cae FG |
1115 | --image-shared shared image |
1116 | --stripe-unit arg stripe unit in B/K/M | |
1117 | --stripe-count arg stripe count | |
1118 | --data-pool arg data pool | |
1119 | --journal-splay-width arg number of active journal objects | |
a8e16298 | 1120 | --journal-object-size arg size of journal objects [4K <= size <= 64M] |
7c673cae FG |
1121 | --journal-pool arg pool for journal objects |
1122 | --sparse-size arg sparse size in B/K/M [default: 4K] | |
1123 | --no-progress disable progress output | |
1124 | --export-format arg format of image file | |
1125 | -p [ --pool ] arg pool name (deprecated) | |
1126 | --image arg image name (deprecated) | |
1127 | ||
1128 | Image Features: | |
1129 | (*) supports enabling/disabling on existing images | |
1130 | (-) supports disabling-only on existing images | |
1131 | (+) enabled by default for new images if features not specified | |
1132 | ||
1133 | rbd help import-diff | |
11fdf7f2 TL |
1134 | usage: rbd import-diff [--path <path>] [--pool <pool>] |
1135 | [--namespace <namespace>] [--image <image>] | |
7c673cae FG |
1136 | [--sparse-size <sparse-size>] [--no-progress] |
1137 | <path-name> <image-spec> | |
1138 | ||
1139 | Import an incremental diff. | |
1140 | ||
1141 | Positional arguments | |
1142 | <path-name> import file (or '-' for stdin) | |
1143 | <image-spec> image specification | |
11fdf7f2 | 1144 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1145 | |
1146 | Optional arguments | |
1147 | --path arg import file (or '-' for stdin) | |
1148 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1149 | --namespace arg namespace name |
7c673cae FG |
1150 | --image arg image name |
1151 | --sparse-size arg sparse size in B/K/M [default: 4K] | |
1152 | --no-progress disable progress output | |
1153 | ||
1154 | rbd help info | |
11fdf7f2 TL |
1155 | usage: rbd info [--pool <pool>] [--namespace <namespace>] [--image <image>] |
1156 | [--snap <snap>] [--image-id <image-id>] [--format <format>] | |
1157 | [--pretty-format] | |
7c673cae FG |
1158 | <image-or-snap-spec> |
1159 | ||
1160 | Show information about image size, striping, etc. | |
1161 | ||
1162 | Positional arguments | |
1163 | <image-or-snap-spec> image or snapshot specification | |
11fdf7f2 TL |
1164 | (example: |
1165 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-name>]) | |
7c673cae FG |
1166 | |
1167 | Optional arguments | |
1168 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1169 | --namespace arg namespace name |
7c673cae FG |
1170 | --image arg image name |
1171 | --snap arg snapshot name | |
1172 | --image-id arg image id | |
181888fb | 1173 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
1174 | --pretty-format pretty formatting (json and xml) |
1175 | ||
1176 | rbd help journal client disconnect | |
11fdf7f2 TL |
1177 | usage: rbd journal client disconnect [--pool <pool>] [--namespace <namespace>] |
1178 | [--image <image>] [--journal <journal>] | |
7c673cae FG |
1179 | [--client-id <client-id>] |
1180 | <journal-spec> | |
1181 | ||
1182 | Flag image journal client as disconnected. | |
1183 | ||
1184 | Positional arguments | |
1185 | <journal-spec> journal specification | |
11fdf7f2 | 1186 | (example: [<pool-name>/[<namespace>/]]<journal-name>) |
7c673cae FG |
1187 | |
1188 | Optional arguments | |
1189 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1190 | --namespace arg namespace name |
7c673cae FG |
1191 | --image arg image name |
1192 | --journal arg journal name | |
1193 | --client-id arg client ID (or leave unspecified to disconnect all) | |
1194 | ||
1195 | rbd help journal export | |
11fdf7f2 TL |
1196 | usage: rbd journal export [--pool <pool>] [--namespace <namespace>] |
1197 | [--image <image>] [--journal <journal>] | |
1198 | [--path <path>] [--verbose] [--no-error] | |
7c673cae FG |
1199 | <source-journal-spec> <path-name> |
1200 | ||
1201 | Export image journal. | |
1202 | ||
1203 | Positional arguments | |
1204 | <source-journal-spec> source journal specification | |
11fdf7f2 | 1205 | (example: [<pool-name>/[<namespace>/]]<journal-name>) |
7c673cae FG |
1206 | <path-name> export file (or '-' for stdout) |
1207 | ||
1208 | Optional arguments | |
1209 | -p [ --pool ] arg source pool name | |
11fdf7f2 | 1210 | --namespace arg source namespace name |
7c673cae FG |
1211 | --image arg source image name |
1212 | --journal arg source journal name | |
1213 | --path arg export file (or '-' for stdout) | |
1214 | --verbose be verbose | |
1215 | --no-error continue after error | |
1216 | ||
1217 | rbd help journal import | |
1218 | usage: rbd journal import [--path <path>] [--dest-pool <dest-pool>] | |
11fdf7f2 TL |
1219 | [--dest-namespace <dest-namespace>] [--dest <dest>] |
1220 | [--dest-journal <dest-journal>] [--verbose] | |
1221 | [--no-error] | |
7c673cae FG |
1222 | <path-name> <dest-journal-spec> |
1223 | ||
1224 | Import image journal. | |
1225 | ||
1226 | Positional arguments | |
1227 | <path-name> import file (or '-' for stdin) | |
1228 | <dest-journal-spec> destination journal specification | |
11fdf7f2 | 1229 | (example: [<pool-name>/[<namespace>/]]<journal-name>) |
7c673cae FG |
1230 | |
1231 | Optional arguments | |
1232 | --path arg import file (or '-' for stdin) | |
1233 | --dest-pool arg destination pool name | |
11fdf7f2 | 1234 | --dest-namespace arg destination namespace name |
7c673cae FG |
1235 | --dest arg destination image name |
1236 | --dest-journal arg destination journal name | |
1237 | --verbose be verbose | |
1238 | --no-error continue after error | |
1239 | ||
1240 | rbd help journal info | |
11fdf7f2 TL |
1241 | usage: rbd journal info [--pool <pool>] [--namespace <namespace>] |
1242 | [--image <image>] [--journal <journal>] | |
1243 | [--format <format>] [--pretty-format] | |
7c673cae FG |
1244 | <journal-spec> |
1245 | ||
1246 | Show information about image journal. | |
1247 | ||
1248 | Positional arguments | |
1249 | <journal-spec> journal specification | |
11fdf7f2 | 1250 | (example: [<pool-name>/[<namespace>/]]<journal-name>) |
7c673cae FG |
1251 | |
1252 | Optional arguments | |
1253 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1254 | --namespace arg namespace name |
7c673cae FG |
1255 | --image arg image name |
1256 | --journal arg journal name | |
181888fb | 1257 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
1258 | --pretty-format pretty formatting (json and xml) |
1259 | ||
1260 | rbd help journal inspect | |
11fdf7f2 TL |
1261 | usage: rbd journal inspect [--pool <pool>] [--namespace <namespace>] |
1262 | [--image <image>] [--journal <journal>] [--verbose] | |
7c673cae FG |
1263 | <journal-spec> |
1264 | ||
1265 | Inspect image journal for structural errors. | |
1266 | ||
1267 | Positional arguments | |
1268 | <journal-spec> journal specification | |
11fdf7f2 | 1269 | (example: [<pool-name>/[<namespace>/]]<journal-name>) |
7c673cae FG |
1270 | |
1271 | Optional arguments | |
1272 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1273 | --namespace arg namespace name |
7c673cae FG |
1274 | --image arg image name |
1275 | --journal arg journal name | |
1276 | --verbose be verbose | |
1277 | ||
1278 | rbd help journal reset | |
11fdf7f2 TL |
1279 | usage: rbd journal reset [--pool <pool>] [--namespace <namespace>] |
1280 | [--image <image>] [--journal <journal>] | |
7c673cae FG |
1281 | <journal-spec> |
1282 | ||
1283 | Reset image journal. | |
1284 | ||
1285 | Positional arguments | |
1286 | <journal-spec> journal specification | |
11fdf7f2 | 1287 | (example: [<pool-name>/[<namespace>/]]<journal-name>) |
7c673cae FG |
1288 | |
1289 | Optional arguments | |
1290 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1291 | --namespace arg namespace name |
7c673cae FG |
1292 | --image arg image name |
1293 | --journal arg journal name | |
1294 | ||
1295 | rbd help journal status | |
11fdf7f2 TL |
1296 | usage: rbd journal status [--pool <pool>] [--namespace <namespace>] |
1297 | [--image <image>] [--journal <journal>] | |
1298 | [--format <format>] [--pretty-format] | |
7c673cae FG |
1299 | <journal-spec> |
1300 | ||
1301 | Show status of image journal. | |
1302 | ||
1303 | Positional arguments | |
1304 | <journal-spec> journal specification | |
11fdf7f2 | 1305 | (example: [<pool-name>/[<namespace>/]]<journal-name>) |
7c673cae FG |
1306 | |
1307 | Optional arguments | |
1308 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1309 | --namespace arg namespace name |
7c673cae FG |
1310 | --image arg image name |
1311 | --journal arg journal name | |
181888fb | 1312 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
1313 | --pretty-format pretty formatting (json and xml) |
1314 | ||
1315 | rbd help list | |
11fdf7f2 TL |
1316 | usage: rbd list [--long] [--pool <pool>] [--namespace <namespace>] |
1317 | [--format <format>] [--pretty-format] | |
1318 | <pool-spec> | |
7c673cae FG |
1319 | |
1320 | List rbd images. | |
1321 | ||
1322 | Positional arguments | |
11fdf7f2 TL |
1323 | <pool-spec> pool specification |
1324 | (example: <pool-name>[/<namespace>] | |
7c673cae FG |
1325 | |
1326 | Optional arguments | |
1327 | -l [ --long ] long listing format | |
1328 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1329 | --namespace arg namespace name |
181888fb | 1330 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
1331 | --pretty-format pretty formatting (json and xml) |
1332 | ||
1333 | rbd help lock add | |
11fdf7f2 TL |
1334 | usage: rbd lock add [--pool <pool>] [--namespace <namespace>] |
1335 | [--image <image>] [--shared <shared>] | |
7c673cae FG |
1336 | <image-spec> <lock-id> |
1337 | ||
1338 | Take a lock on an image. | |
1339 | ||
1340 | Positional arguments | |
1341 | <image-spec> image specification | |
11fdf7f2 | 1342 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1343 | <lock-id> unique lock id |
1344 | ||
1345 | Optional arguments | |
1346 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1347 | --namespace arg namespace name |
7c673cae FG |
1348 | --image arg image name |
1349 | --shared arg shared lock tag | |
1350 | ||
1351 | rbd help lock list | |
11fdf7f2 TL |
1352 | usage: rbd lock list [--pool <pool>] [--namespace <namespace>] |
1353 | [--image <image>] [--format <format>] [--pretty-format] | |
7c673cae FG |
1354 | <image-spec> |
1355 | ||
1356 | Show locks held on an image. | |
1357 | ||
1358 | Positional arguments | |
1359 | <image-spec> image specification | |
11fdf7f2 | 1360 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1361 | |
1362 | Optional arguments | |
1363 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1364 | --namespace arg namespace name |
7c673cae | 1365 | --image arg image name |
181888fb | 1366 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
1367 | --pretty-format pretty formatting (json and xml) |
1368 | ||
1369 | rbd help lock remove | |
11fdf7f2 TL |
1370 | usage: rbd lock remove [--pool <pool>] [--namespace <namespace>] |
1371 | [--image <image>] | |
7c673cae FG |
1372 | <image-spec> <lock-id> <locker> |
1373 | ||
1374 | Release a lock on an image. | |
1375 | ||
1376 | Positional arguments | |
1377 | <image-spec> image specification | |
11fdf7f2 | 1378 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1379 | <lock-id> unique lock id |
1380 | <locker> locker client | |
1381 | ||
1382 | Optional arguments | |
1383 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1384 | --namespace arg namespace name |
7c673cae FG |
1385 | --image arg image name |
1386 | ||
7c673cae FG |
1387 | rbd help merge-diff |
1388 | usage: rbd merge-diff [--path <path>] [--no-progress] | |
1389 | <diff1-path> <diff2-path> <path-name> | |
1390 | ||
1391 | Merge two diff exports together. | |
1392 | ||
1393 | Positional arguments | |
1394 | <diff1-path> path to first diff (or '-' for stdin) | |
1395 | <diff2-path> path to second diff | |
1396 | <path-name> path to merged diff (or '-' for stdout) | |
1397 | ||
1398 | Optional arguments | |
1399 | --path arg path to merged diff (or '-' for stdout) | |
1400 | --no-progress disable progress output | |
1401 | ||
11fdf7f2 TL |
1402 | rbd help migration abort |
1403 | usage: rbd migration abort [--pool <pool>] [--namespace <namespace>] | |
1404 | [--image <image>] [--no-progress] | |
1405 | <image-spec> | |
1406 | ||
1407 | Cancel interrupted image migration. | |
1408 | ||
1409 | Positional arguments | |
1410 | <image-spec> image specification | |
1411 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
1412 | ||
1413 | Optional arguments | |
1414 | -p [ --pool ] arg pool name | |
1415 | --namespace arg namespace name | |
1416 | --image arg image name | |
1417 | --no-progress disable progress output | |
1418 | ||
1419 | rbd help migration commit | |
1420 | usage: rbd migration commit [--pool <pool>] [--namespace <namespace>] | |
1421 | [--image <image>] [--no-progress] [--force] | |
1422 | <image-spec> | |
1423 | ||
1424 | Commit image migration. | |
1425 | ||
1426 | Positional arguments | |
1427 | <image-spec> image specification | |
1428 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
1429 | ||
1430 | Optional arguments | |
1431 | -p [ --pool ] arg pool name | |
1432 | --namespace arg namespace name | |
1433 | --image arg image name | |
1434 | --no-progress disable progress output | |
1435 | --force proceed even if the image has children | |
1436 | ||
1437 | rbd help migration execute | |
1438 | usage: rbd migration execute [--pool <pool>] [--namespace <namespace>] | |
1439 | [--image <image>] [--no-progress] | |
1440 | <image-spec> | |
1441 | ||
1442 | Execute image migration. | |
1443 | ||
1444 | Positional arguments | |
1445 | <image-spec> image specification | |
1446 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
1447 | ||
1448 | Optional arguments | |
1449 | -p [ --pool ] arg pool name | |
1450 | --namespace arg namespace name | |
1451 | --image arg image name | |
1452 | --no-progress disable progress output | |
1453 | ||
1454 | rbd help migration prepare | |
1455 | usage: rbd migration prepare [--pool <pool>] [--namespace <namespace>] | |
1456 | [--image <image>] [--dest-pool <dest-pool>] | |
1457 | [--dest-namespace <dest-namespace>] | |
1458 | [--dest <dest>] [--image-format <image-format>] | |
1459 | [--new-format] [--order <order>] | |
1460 | [--object-size <object-size>] | |
1461 | [--image-feature <image-feature>] | |
1462 | [--image-shared] [--stripe-unit <stripe-unit>] | |
1463 | [--stripe-count <stripe-count>] | |
1464 | [--data-pool <data-pool>] | |
1465 | [--journal-splay-width <journal-splay-width>] | |
1466 | [--journal-object-size <journal-object-size>] | |
1467 | [--journal-pool <journal-pool>] [--flatten] | |
1468 | <source-image-spec> <dest-image-spec> | |
1469 | ||
1470 | Prepare image migration. | |
1471 | ||
1472 | Positional arguments | |
1473 | <source-image-spec> source image specification | |
1474 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
1475 | <dest-image-spec> destination image specification | |
1476 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
1477 | ||
1478 | Optional arguments | |
1479 | -p [ --pool ] arg source pool name | |
1480 | --namespace arg source namespace name | |
1481 | --image arg source image name | |
1482 | --dest-pool arg destination pool name | |
1483 | --dest-namespace arg destination namespace name | |
1484 | --dest arg destination image name | |
1485 | --image-format arg image format [1 (deprecated) or 2] | |
1486 | --new-format use image format 2 | |
1487 | (deprecated) | |
1488 | --order arg object order [12 <= order <= 25] | |
1489 | --object-size arg object size in B/K/M [4K <= object size <= 32M] | |
1490 | --image-feature arg image features | |
1491 | [layering(+), exclusive-lock(+*), object-map(+*), | |
1492 | deep-flatten(+-), journaling(*)] | |
1493 | --image-shared shared image | |
1494 | --stripe-unit arg stripe unit in B/K/M | |
1495 | --stripe-count arg stripe count | |
1496 | --data-pool arg data pool | |
1497 | --journal-splay-width arg number of active journal objects | |
1498 | --journal-object-size arg size of journal objects [4K <= size <= 64M] | |
1499 | --journal-pool arg pool for journal objects | |
1500 | --flatten fill clone with parent data (make it independent) | |
1501 | ||
1502 | Image Features: | |
1503 | (*) supports enabling/disabling on existing images | |
1504 | (-) supports disabling-only on existing images | |
1505 | (+) enabled by default for new images if features not specified | |
1506 | ||
7c673cae | 1507 | rbd help mirror image demote |
11fdf7f2 TL |
1508 | usage: rbd mirror image demote [--pool <pool>] [--namespace <namespace>] |
1509 | [--image <image>] | |
7c673cae FG |
1510 | <image-spec> |
1511 | ||
1512 | Demote an image to non-primary for RBD mirroring. | |
1513 | ||
1514 | Positional arguments | |
1515 | <image-spec> image specification | |
11fdf7f2 | 1516 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1517 | |
1518 | Optional arguments | |
1519 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1520 | --namespace arg namespace name |
7c673cae FG |
1521 | --image arg image name |
1522 | ||
1523 | rbd help mirror image disable | |
11fdf7f2 TL |
1524 | usage: rbd mirror image disable [--force] [--pool <pool>] |
1525 | [--namespace <namespace>] [--image <image>] | |
7c673cae FG |
1526 | <image-spec> |
1527 | ||
1528 | Disable RBD mirroring for an image. | |
1529 | ||
1530 | Positional arguments | |
1531 | <image-spec> image specification | |
11fdf7f2 | 1532 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1533 | |
1534 | Optional arguments | |
1535 | --force disable even if not primary | |
1536 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1537 | --namespace arg namespace name |
7c673cae FG |
1538 | --image arg image name |
1539 | ||
1540 | rbd help mirror image enable | |
11fdf7f2 TL |
1541 | usage: rbd mirror image enable [--pool <pool>] [--namespace <namespace>] |
1542 | [--image <image>] | |
7c673cae FG |
1543 | <image-spec> |
1544 | ||
1545 | Enable RBD mirroring for an image. | |
1546 | ||
1547 | Positional arguments | |
1548 | <image-spec> image specification | |
11fdf7f2 | 1549 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1550 | |
1551 | Optional arguments | |
1552 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1553 | --namespace arg namespace name |
7c673cae FG |
1554 | --image arg image name |
1555 | ||
1556 | rbd help mirror image promote | |
11fdf7f2 TL |
1557 | usage: rbd mirror image promote [--force] [--pool <pool>] |
1558 | [--namespace <namespace>] [--image <image>] | |
7c673cae FG |
1559 | <image-spec> |
1560 | ||
1561 | Promote an image to primary for RBD mirroring. | |
1562 | ||
1563 | Positional arguments | |
1564 | <image-spec> image specification | |
11fdf7f2 | 1565 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1566 | |
1567 | Optional arguments | |
1568 | --force promote even if not cleanly demoted by remote cluster | |
1569 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1570 | --namespace arg namespace name |
7c673cae FG |
1571 | --image arg image name |
1572 | ||
1573 | rbd help mirror image resync | |
11fdf7f2 TL |
1574 | usage: rbd mirror image resync [--pool <pool>] [--namespace <namespace>] |
1575 | [--image <image>] | |
7c673cae FG |
1576 | <image-spec> |
1577 | ||
1578 | Force resync to primary image for RBD mirroring. | |
1579 | ||
1580 | Positional arguments | |
1581 | <image-spec> image specification | |
11fdf7f2 | 1582 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1583 | |
1584 | Optional arguments | |
1585 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1586 | --namespace arg namespace name |
7c673cae FG |
1587 | --image arg image name |
1588 | ||
1589 | rbd help mirror image status | |
11fdf7f2 TL |
1590 | usage: rbd mirror image status [--pool <pool>] [--namespace <namespace>] |
1591 | [--image <image>] [--format <format>] | |
1592 | [--pretty-format] | |
7c673cae FG |
1593 | <image-spec> |
1594 | ||
11fdf7f2 | 1595 | Show RBD mirroring status for an image. |
7c673cae FG |
1596 | |
1597 | Positional arguments | |
1598 | <image-spec> image specification | |
11fdf7f2 | 1599 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1600 | |
1601 | Optional arguments | |
1602 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1603 | --namespace arg namespace name |
7c673cae | 1604 | --image arg image name |
181888fb | 1605 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
1606 | --pretty-format pretty formatting (json and xml) |
1607 | ||
1608 | rbd help mirror pool demote | |
1609 | usage: rbd mirror pool demote [--pool <pool>] | |
1610 | <pool-name> | |
1611 | ||
1612 | Demote all primary images in the pool. | |
1613 | ||
1614 | Positional arguments | |
1615 | <pool-name> pool name | |
1616 | ||
1617 | Optional arguments | |
1618 | -p [ --pool ] arg pool name | |
1619 | ||
1620 | rbd help mirror pool disable | |
1621 | usage: rbd mirror pool disable [--pool <pool>] | |
1622 | <pool-name> | |
1623 | ||
1624 | Disable RBD mirroring by default within a pool. | |
1625 | ||
1626 | Positional arguments | |
1627 | <pool-name> pool name | |
1628 | ||
1629 | Optional arguments | |
1630 | -p [ --pool ] arg pool name | |
1631 | ||
1632 | rbd help mirror pool enable | |
eafe8130 | 1633 | usage: rbd mirror pool enable [--pool <pool>] [--site-name <site-name>] |
7c673cae FG |
1634 | <pool-name> <mode> |
1635 | ||
1636 | Enable RBD mirroring by default within a pool. | |
1637 | ||
1638 | Positional arguments | |
1639 | <pool-name> pool name | |
1640 | <mode> mirror mode [image or pool] | |
1641 | ||
1642 | Optional arguments | |
1643 | -p [ --pool ] arg pool name | |
eafe8130 | 1644 | --site-name arg local site name |
7c673cae FG |
1645 | |
1646 | rbd help mirror pool info | |
1647 | usage: rbd mirror pool info [--pool <pool>] [--format <format>] | |
11fdf7f2 | 1648 | [--pretty-format] [--all] |
7c673cae FG |
1649 | <pool-name> |
1650 | ||
1651 | Show information about the pool mirroring configuration. | |
1652 | ||
1653 | Positional arguments | |
1654 | <pool-name> pool name | |
1655 | ||
1656 | Optional arguments | |
1657 | -p [ --pool ] arg pool name | |
181888fb | 1658 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae | 1659 | --pretty-format pretty formatting (json and xml) |
11fdf7f2 | 1660 | --all list all attributes |
7c673cae FG |
1661 | |
1662 | rbd help mirror pool peer add | |
1663 | usage: rbd mirror pool peer add [--pool <pool>] | |
1664 | [--remote-client-name <remote-client-name>] | |
1665 | [--remote-cluster <remote-cluster>] | |
11fdf7f2 TL |
1666 | [--remote-mon-host <remote-mon-host>] |
1667 | [--remote-key-file <remote-key-file>] | |
7c673cae FG |
1668 | <pool-name> <remote-cluster-spec> |
1669 | ||
1670 | Add a mirroring peer to a pool. | |
1671 | ||
1672 | Positional arguments | |
1673 | <pool-name> pool name | |
1674 | <remote-cluster-spec> remote cluster spec | |
11fdf7f2 | 1675 | (example: [<client name>@]<cluster name>) |
7c673cae FG |
1676 | |
1677 | Optional arguments | |
1678 | -p [ --pool ] arg pool name | |
1679 | --remote-client-name arg remote client name | |
1680 | --remote-cluster arg remote cluster name | |
11fdf7f2 TL |
1681 | --remote-mon-host arg remote mon host(s) |
1682 | --remote-key-file arg path to file containing remote key | |
7c673cae | 1683 | |
eafe8130 TL |
1684 | rbd help mirror pool peer bootstrap create |
1685 | usage: rbd mirror pool peer bootstrap create | |
1686 | [--pool <pool>] | |
1687 | [--site-name <site-name>] | |
1688 | <pool-name> | |
1689 | ||
1690 | Create a peer bootstrap token to import in a remote cluster | |
1691 | ||
1692 | Positional arguments | |
1693 | <pool-name> pool name | |
1694 | ||
1695 | Optional arguments | |
1696 | -p [ --pool ] arg pool name | |
1697 | --site-name arg local site name | |
1698 | ||
1699 | rbd help mirror pool peer bootstrap import | |
1700 | usage: rbd mirror pool peer bootstrap import | |
1701 | [--pool <pool>] | |
1702 | [--site-name <site-name>] | |
1703 | [--token-path <token-path>] | |
1704 | [--direction <direction>] | |
1705 | <pool-name> <token-path> | |
1706 | ||
1707 | Import a peer bootstrap token created from a remote cluster | |
1708 | ||
1709 | Positional arguments | |
1710 | <pool-name> pool name | |
1711 | <token-path> bootstrap token file (or '-' for stdin) | |
1712 | ||
1713 | Optional arguments | |
1714 | -p [ --pool ] arg pool name | |
1715 | --site-name arg local site name | |
1716 | --token-path arg bootstrap token file (or '-' for stdin) | |
1717 | --direction arg mirroring direction (rx-only, rx-tx) | |
1718 | [default: rx-tx] | |
1719 | ||
7c673cae FG |
1720 | rbd help mirror pool peer remove |
1721 | usage: rbd mirror pool peer remove [--pool <pool>] | |
1722 | <pool-name> <uuid> | |
1723 | ||
1724 | Remove a mirroring peer from a pool. | |
1725 | ||
1726 | Positional arguments | |
1727 | <pool-name> pool name | |
1728 | <uuid> peer uuid | |
1729 | ||
1730 | Optional arguments | |
1731 | -p [ --pool ] arg pool name | |
1732 | ||
1733 | rbd help mirror pool peer set | |
1734 | usage: rbd mirror pool peer set [--pool <pool>] | |
1735 | <pool-name> <uuid> <key> <value> | |
1736 | ||
1737 | Update mirroring peer settings. | |
1738 | ||
1739 | Positional arguments | |
1740 | <pool-name> pool name | |
1741 | <uuid> peer uuid | |
11fdf7f2 TL |
1742 | <key> peer parameter [client, cluster, mon-host, key-file] |
1743 | <value> new value for specified key | |
7c673cae FG |
1744 | |
1745 | Optional arguments | |
1746 | -p [ --pool ] arg pool name | |
1747 | ||
1748 | rbd help mirror pool promote | |
1749 | usage: rbd mirror pool promote [--force] [--pool <pool>] | |
1750 | <pool-name> | |
1751 | ||
1752 | Promote all non-primary images in the pool. | |
1753 | ||
1754 | Positional arguments | |
1755 | <pool-name> pool name | |
1756 | ||
1757 | Optional arguments | |
1758 | --force promote even if not cleanly demoted by remote cluster | |
1759 | -p [ --pool ] arg pool name | |
1760 | ||
1761 | rbd help mirror pool status | |
1762 | usage: rbd mirror pool status [--pool <pool>] [--format <format>] | |
1763 | [--pretty-format] [--verbose] | |
1764 | <pool-name> | |
1765 | ||
1766 | Show status for all mirrored images in the pool. | |
1767 | ||
1768 | Positional arguments | |
1769 | <pool-name> pool name | |
1770 | ||
1771 | Optional arguments | |
1772 | -p [ --pool ] arg pool name | |
181888fb | 1773 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
1774 | --pretty-format pretty formatting (json and xml) |
1775 | --verbose be verbose | |
1776 | ||
11fdf7f2 TL |
1777 | rbd help namespace create |
1778 | usage: rbd namespace create [--pool <pool>] [--namespace <namespace>] | |
1779 | <pool-spec> | |
7c673cae | 1780 | |
11fdf7f2 | 1781 | Create an RBD image namespace. |
7c673cae | 1782 | |
11fdf7f2 TL |
1783 | Positional arguments |
1784 | <pool-spec> pool specification | |
1785 | (example: <pool-name>[/<namespace>] | |
7c673cae | 1786 | |
11fdf7f2 TL |
1787 | Optional arguments |
1788 | -p [ --pool ] arg pool name | |
1789 | --namespace arg namespace name | |
1790 | ||
1791 | rbd help namespace list | |
1792 | usage: rbd namespace list [--pool <pool>] [--format <format>] [--pretty-format] | |
1793 | <pool-name> | |
1794 | ||
1795 | List RBD image namespaces. | |
7c673cae FG |
1796 | |
1797 | Positional arguments | |
11fdf7f2 | 1798 | <pool-name> pool name |
7c673cae FG |
1799 | |
1800 | Optional arguments | |
11fdf7f2 TL |
1801 | -p [ --pool ] arg pool name |
1802 | --format arg output format (plain, json, or xml) [default: plain] | |
1803 | --pretty-format pretty formatting (json and xml) | |
7c673cae | 1804 | |
11fdf7f2 TL |
1805 | rbd help namespace remove |
1806 | usage: rbd namespace remove [--pool <pool>] [--namespace <namespace>] | |
1807 | <pool-spec> | |
7c673cae | 1808 | |
11fdf7f2 | 1809 | Remove an RBD image namespace. |
7c673cae FG |
1810 | |
1811 | Positional arguments | |
11fdf7f2 TL |
1812 | <pool-spec> pool specification |
1813 | (example: <pool-name>[/<namespace>] | |
1814 | ||
1815 | Optional arguments | |
1816 | -p [ --pool ] arg pool name | |
1817 | --namespace arg namespace name | |
7c673cae FG |
1818 | |
1819 | rbd help object-map check | |
11fdf7f2 TL |
1820 | usage: rbd object-map check [--pool <pool>] [--namespace <namespace>] |
1821 | [--image <image>] [--snap <snap>] [--no-progress] | |
7c673cae FG |
1822 | <image-or-snap-spec> |
1823 | ||
1824 | Verify the object map is correct. | |
1825 | ||
1826 | Positional arguments | |
1827 | <image-or-snap-spec> image or snapshot specification | |
11fdf7f2 TL |
1828 | (example: |
1829 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-name>]) | |
7c673cae FG |
1830 | |
1831 | Optional arguments | |
1832 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1833 | --namespace arg namespace name |
7c673cae FG |
1834 | --image arg image name |
1835 | --snap arg snapshot name | |
1836 | --no-progress disable progress output | |
1837 | ||
1838 | rbd help object-map rebuild | |
11fdf7f2 TL |
1839 | usage: rbd object-map rebuild [--pool <pool>] [--namespace <namespace>] |
1840 | [--image <image>] [--snap <snap>] [--no-progress] | |
7c673cae FG |
1841 | <image-or-snap-spec> |
1842 | ||
1843 | Rebuild an invalid object map. | |
1844 | ||
1845 | Positional arguments | |
1846 | <image-or-snap-spec> image or snapshot specification | |
11fdf7f2 TL |
1847 | (example: |
1848 | [<pool-name>/[<namespace>/]]<image-name>[@<snap-name>]) | |
7c673cae FG |
1849 | |
1850 | Optional arguments | |
1851 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1852 | --namespace arg namespace name |
7c673cae FG |
1853 | --image arg image name |
1854 | --snap arg snapshot name | |
1855 | --no-progress disable progress output | |
1856 | ||
11fdf7f2 TL |
1857 | rbd help perf image iostat |
1858 | usage: rbd perf image iostat [--pool <pool>] [--namespace <namespace>] | |
1859 | [--iterations <iterations>] [--sort-by <sort-by>] | |
1860 | [--format <format>] [--pretty-format] | |
1861 | <pool-spec> | |
1862 | ||
1863 | Display image IO statistics. | |
1864 | ||
1865 | Positional arguments | |
1866 | <pool-spec> pool specification | |
1867 | (example: <pool-name>[/<namespace>] | |
1868 | ||
1869 | Optional arguments | |
1870 | -p [ --pool ] arg pool name | |
1871 | --namespace arg namespace name | |
1872 | --iterations arg iterations of metric collection [> 0] | |
1873 | --sort-by arg (=write_ops) sort-by IO metric (write-ops, read-ops, | |
1874 | write-bytes, read-bytes, write-latency, | |
1875 | read-latency) [default: write-ops] | |
1876 | --format arg output format (plain, json, or xml) [default: | |
1877 | plain] | |
1878 | --pretty-format pretty formatting (json and xml) | |
1879 | ||
1880 | rbd help perf image iotop | |
1881 | usage: rbd perf image iotop [--pool <pool>] [--namespace <namespace>] | |
1882 | <pool-spec> | |
1883 | ||
1884 | Display a top-like IO monitor. | |
1885 | ||
1886 | Positional arguments | |
1887 | <pool-spec> pool specification | |
1888 | (example: <pool-name>[/<namespace>] | |
1889 | ||
1890 | Optional arguments | |
1891 | -p [ --pool ] arg pool name | |
1892 | --namespace arg namespace name | |
1893 | ||
c07f9fc5 FG |
1894 | rbd help pool init |
1895 | usage: rbd pool init [--pool <pool>] [--force] | |
1896 | <pool-name> | |
1897 | ||
1898 | Initialize pool for use by RBD. | |
1899 | ||
1900 | Positional arguments | |
1901 | <pool-name> pool name | |
1902 | ||
1903 | Optional arguments | |
1904 | -p [ --pool ] arg pool name | |
1905 | --force force initialize pool for RBD use if registered by | |
1906 | another application | |
1907 | ||
11fdf7f2 TL |
1908 | rbd help pool stats |
1909 | usage: rbd pool stats [--pool <pool>] [--namespace <namespace>] | |
1910 | [--format <format>] [--pretty-format] | |
1911 | <pool-spec> | |
1912 | ||
1913 | Display pool statistics. | |
1914 | ||
1915 | Positional arguments | |
1916 | <pool-spec> pool specification | |
1917 | (example: <pool-name>[/<namespace>] | |
1918 | ||
1919 | Optional arguments | |
1920 | -p [ --pool ] arg pool name | |
1921 | --namespace arg namespace name | |
1922 | --format arg output format (plain, json, or xml) [default: plain] | |
1923 | --pretty-format pretty formatting (json and xml) | |
1924 | ||
1925 | Note: legacy v1 images are not included in stats | |
7c673cae | 1926 | rbd help remove |
11fdf7f2 TL |
1927 | usage: rbd remove [--pool <pool>] [--namespace <namespace>] [--image <image>] |
1928 | [--no-progress] | |
7c673cae FG |
1929 | <image-spec> |
1930 | ||
1931 | Delete an image. | |
1932 | ||
1933 | Positional arguments | |
1934 | <image-spec> image specification | |
11fdf7f2 | 1935 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1936 | |
1937 | Optional arguments | |
1938 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1939 | --namespace arg namespace name |
7c673cae FG |
1940 | --image arg image name |
1941 | --no-progress disable progress output | |
1942 | ||
1943 | rbd help rename | |
11fdf7f2 TL |
1944 | usage: rbd rename [--pool <pool>] [--namespace <namespace>] [--image <image>] |
1945 | [--dest-pool <dest-pool>] | |
1946 | [--dest-namespace <dest-namespace>] [--dest <dest>] | |
7c673cae FG |
1947 | <source-image-spec> <dest-image-spec> |
1948 | ||
1949 | Rename image within pool. | |
1950 | ||
1951 | Positional arguments | |
1952 | <source-image-spec> source image specification | |
11fdf7f2 | 1953 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae | 1954 | <dest-image-spec> destination image specification |
11fdf7f2 | 1955 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1956 | |
1957 | Optional arguments | |
1958 | -p [ --pool ] arg source pool name | |
11fdf7f2 | 1959 | --namespace arg source namespace name |
7c673cae FG |
1960 | --image arg source image name |
1961 | --dest-pool arg destination pool name | |
11fdf7f2 | 1962 | --dest-namespace arg destination namespace name |
7c673cae FG |
1963 | --dest arg destination image name |
1964 | ||
1965 | rbd help resize | |
11fdf7f2 TL |
1966 | usage: rbd resize [--pool <pool>] [--namespace <namespace>] |
1967 | [--image <image>] --size <size> [--allow-shrink] | |
1968 | [--no-progress] | |
7c673cae FG |
1969 | <image-spec> |
1970 | ||
1971 | Resize (expand or shrink) image. | |
1972 | ||
1973 | Positional arguments | |
1974 | <image-spec> image specification | |
11fdf7f2 | 1975 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
1976 | |
1977 | Optional arguments | |
1978 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1979 | --namespace arg namespace name |
7c673cae | 1980 | --image arg image name |
31f18b77 | 1981 | -s [ --size ] arg image size (in M/G/T) [default: M] |
7c673cae FG |
1982 | --allow-shrink permit shrinking |
1983 | --no-progress disable progress output | |
1984 | ||
7c673cae | 1985 | rbd help snap create |
11fdf7f2 TL |
1986 | usage: rbd snap create [--pool <pool>] [--namespace <namespace>] |
1987 | [--image <image>] [--snap <snap>] | |
7c673cae FG |
1988 | <snap-spec> |
1989 | ||
1990 | Create a snapshot. | |
1991 | ||
1992 | Positional arguments | |
1993 | <snap-spec> snapshot specification | |
11fdf7f2 TL |
1994 | (example: |
1995 | [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>) | |
7c673cae FG |
1996 | |
1997 | Optional arguments | |
1998 | -p [ --pool ] arg pool name | |
11fdf7f2 | 1999 | --namespace arg namespace name |
7c673cae FG |
2000 | --image arg image name |
2001 | --snap arg snapshot name | |
2002 | ||
2003 | rbd help snap limit clear | |
11fdf7f2 TL |
2004 | usage: rbd snap limit clear [--pool <pool>] [--namespace <namespace>] |
2005 | [--image <image>] | |
7c673cae FG |
2006 | <image-spec> |
2007 | ||
2008 | Remove snapshot limit. | |
2009 | ||
2010 | Positional arguments | |
2011 | <image-spec> image specification | |
11fdf7f2 | 2012 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
2013 | |
2014 | Optional arguments | |
2015 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2016 | --namespace arg namespace name |
7c673cae FG |
2017 | --image arg image name |
2018 | ||
2019 | rbd help snap limit set | |
11fdf7f2 TL |
2020 | usage: rbd snap limit set [--pool <pool>] [--namespace <namespace>] |
2021 | [--image <image>] [--limit <limit>] | |
7c673cae FG |
2022 | <image-spec> |
2023 | ||
2024 | Limit the number of snapshots. | |
2025 | ||
2026 | Positional arguments | |
2027 | <image-spec> image specification | |
11fdf7f2 | 2028 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
2029 | |
2030 | Optional arguments | |
2031 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2032 | --namespace arg namespace name |
7c673cae FG |
2033 | --image arg image name |
2034 | --limit arg maximum allowed snapshot count | |
2035 | ||
2036 | rbd help snap list | |
11fdf7f2 TL |
2037 | usage: rbd snap list [--pool <pool>] [--namespace <namespace>] |
2038 | [--image <image>] [--image-id <image-id>] | |
2039 | [--format <format>] [--pretty-format] [--all] | |
7c673cae FG |
2040 | <image-spec> |
2041 | ||
2042 | Dump list of image snapshots. | |
2043 | ||
2044 | Positional arguments | |
2045 | <image-spec> image specification | |
11fdf7f2 | 2046 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
2047 | |
2048 | Optional arguments | |
2049 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2050 | --namespace arg namespace name |
7c673cae FG |
2051 | --image arg image name |
2052 | --image-id arg image id | |
181888fb | 2053 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae | 2054 | --pretty-format pretty formatting (json and xml) |
11fdf7f2 | 2055 | -a [ --all ] list snapshots from all namespaces |
7c673cae FG |
2056 | |
2057 | rbd help snap protect | |
11fdf7f2 TL |
2058 | usage: rbd snap protect [--pool <pool>] [--namespace <namespace>] |
2059 | [--image <image>] [--snap <snap>] | |
7c673cae FG |
2060 | <snap-spec> |
2061 | ||
2062 | Prevent a snapshot from being deleted. | |
2063 | ||
2064 | Positional arguments | |
2065 | <snap-spec> snapshot specification | |
11fdf7f2 TL |
2066 | (example: |
2067 | [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>) | |
7c673cae FG |
2068 | |
2069 | Optional arguments | |
2070 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2071 | --namespace arg namespace name |
7c673cae FG |
2072 | --image arg image name |
2073 | --snap arg snapshot name | |
2074 | ||
2075 | rbd help snap purge | |
11fdf7f2 TL |
2076 | usage: rbd snap purge [--pool <pool>] [--namespace <namespace>] |
2077 | [--image <image>] [--image-id <image-id>] [--no-progress] | |
7c673cae FG |
2078 | <image-spec> |
2079 | ||
11fdf7f2 | 2080 | Delete all unprotected snapshots. |
7c673cae FG |
2081 | |
2082 | Positional arguments | |
2083 | <image-spec> image specification | |
11fdf7f2 | 2084 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
2085 | |
2086 | Optional arguments | |
2087 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2088 | --namespace arg namespace name |
7c673cae FG |
2089 | --image arg image name |
2090 | --image-id arg image id | |
2091 | --no-progress disable progress output | |
2092 | ||
2093 | rbd help snap remove | |
11fdf7f2 TL |
2094 | usage: rbd snap remove [--pool <pool>] [--namespace <namespace>] |
2095 | [--image <image>] [--snap <snap>] | |
2096 | [--image-id <image-id>] [--snap-id <snap-id>] | |
2097 | [--no-progress] [--force] | |
7c673cae FG |
2098 | <snap-spec> |
2099 | ||
c07f9fc5 | 2100 | Delete a snapshot. |
7c673cae FG |
2101 | |
2102 | Positional arguments | |
2103 | <snap-spec> snapshot specification | |
11fdf7f2 TL |
2104 | (example: |
2105 | [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>) | |
7c673cae FG |
2106 | |
2107 | Optional arguments | |
2108 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2109 | --namespace arg namespace name |
7c673cae FG |
2110 | --image arg image name |
2111 | --snap arg snapshot name | |
7c673cae | 2112 | --image-id arg image id |
11fdf7f2 TL |
2113 | --snap-id arg snapshot id |
2114 | --no-progress disable progress output | |
7c673cae FG |
2115 | --force flatten children and unprotect snapshot if needed. |
2116 | ||
2117 | rbd help snap rename | |
11fdf7f2 TL |
2118 | usage: rbd snap rename [--pool <pool>] [--namespace <namespace>] |
2119 | [--image <image>] [--snap <snap>] | |
2120 | [--dest-pool <dest-pool>] | |
2121 | [--dest-namespace <dest-namespace>] [--dest <dest>] | |
7c673cae FG |
2122 | [--dest-snap <dest-snap>] |
2123 | <source-snap-spec> <dest-snap-spec> | |
2124 | ||
2125 | Rename a snapshot. | |
2126 | ||
2127 | Positional arguments | |
2128 | <source-snap-spec> source snapshot specification | |
11fdf7f2 TL |
2129 | (example: |
2130 | [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>) | |
7c673cae | 2131 | <dest-snap-spec> destination snapshot specification |
11fdf7f2 TL |
2132 | (example: |
2133 | [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>) | |
7c673cae FG |
2134 | |
2135 | Optional arguments | |
2136 | -p [ --pool ] arg source pool name | |
11fdf7f2 | 2137 | --namespace arg source namespace name |
7c673cae FG |
2138 | --image arg source image name |
2139 | --snap arg source snapshot name | |
2140 | --dest-pool arg destination pool name | |
11fdf7f2 | 2141 | --dest-namespace arg destination namespace name |
7c673cae FG |
2142 | --dest arg destination image name |
2143 | --dest-snap arg destination snapshot name | |
2144 | ||
2145 | rbd help snap rollback | |
11fdf7f2 TL |
2146 | usage: rbd snap rollback [--pool <pool>] [--namespace <namespace>] |
2147 | [--image <image>] [--snap <snap>] [--no-progress] | |
7c673cae FG |
2148 | <snap-spec> |
2149 | ||
2150 | Rollback image to snapshot. | |
2151 | ||
2152 | Positional arguments | |
2153 | <snap-spec> snapshot specification | |
11fdf7f2 TL |
2154 | (example: |
2155 | [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>) | |
7c673cae FG |
2156 | |
2157 | Optional arguments | |
2158 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2159 | --namespace arg namespace name |
7c673cae FG |
2160 | --image arg image name |
2161 | --snap arg snapshot name | |
2162 | --no-progress disable progress output | |
2163 | ||
2164 | rbd help snap unprotect | |
11fdf7f2 TL |
2165 | usage: rbd snap unprotect [--pool <pool>] [--namespace <namespace>] |
2166 | [--image <image>] [--snap <snap>] | |
7c673cae FG |
2167 | [--image-id <image-id>] |
2168 | <snap-spec> | |
2169 | ||
2170 | Allow a snapshot to be deleted. | |
2171 | ||
2172 | Positional arguments | |
2173 | <snap-spec> snapshot specification | |
11fdf7f2 TL |
2174 | (example: |
2175 | [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>) | |
7c673cae FG |
2176 | |
2177 | Optional arguments | |
2178 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2179 | --namespace arg namespace name |
7c673cae FG |
2180 | --image arg image name |
2181 | --snap arg snapshot name | |
2182 | --image-id arg image id | |
2183 | ||
11fdf7f2 TL |
2184 | rbd help sparsify |
2185 | usage: rbd sparsify [--pool <pool>] [--namespace <namespace>] | |
2186 | [--image <image>] [--no-progress] | |
2187 | [--sparse-size <sparse-size>] | |
2188 | <image-spec> | |
2189 | ||
2190 | Reclaim space for zeroed image extents. | |
2191 | ||
2192 | Positional arguments | |
2193 | <image-spec> image specification | |
2194 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
2195 | ||
2196 | Optional arguments | |
2197 | -p [ --pool ] arg pool name | |
2198 | --namespace arg namespace name | |
2199 | --image arg image name | |
2200 | --no-progress disable progress output | |
2201 | --sparse-size arg sparse size in B/K/M [default: 4K] | |
2202 | ||
7c673cae | 2203 | rbd help status |
11fdf7f2 TL |
2204 | usage: rbd status [--pool <pool>] [--namespace <namespace>] [--image <image>] |
2205 | [--format <format>] [--pretty-format] | |
7c673cae FG |
2206 | <image-spec> |
2207 | ||
2208 | Show the status of this image. | |
2209 | ||
2210 | Positional arguments | |
2211 | <image-spec> image specification | |
11fdf7f2 | 2212 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
2213 | |
2214 | Optional arguments | |
2215 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2216 | --namespace arg namespace name |
7c673cae | 2217 | --image arg image name |
181888fb | 2218 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
2219 | --pretty-format pretty formatting (json and xml) |
2220 | ||
2221 | rbd help trash list | |
11fdf7f2 TL |
2222 | usage: rbd trash list [--pool <pool>] [--namespace <namespace>] [--all] |
2223 | [--long] [--format <format>] [--pretty-format] | |
2224 | <pool-spec> | |
7c673cae FG |
2225 | |
2226 | List trash images. | |
2227 | ||
2228 | Positional arguments | |
11fdf7f2 TL |
2229 | <pool-spec> pool specification |
2230 | (example: <pool-name>[/<namespace>] | |
7c673cae FG |
2231 | |
2232 | Optional arguments | |
2233 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2234 | --namespace arg namespace name |
7c673cae FG |
2235 | -a [ --all ] list images from all sources |
2236 | -l [ --long ] long listing format | |
181888fb | 2237 | --format arg output format (plain, json, or xml) [default: plain] |
7c673cae FG |
2238 | --pretty-format pretty formatting (json and xml) |
2239 | ||
2240 | rbd help trash move | |
11fdf7f2 TL |
2241 | usage: rbd trash move [--pool <pool>] [--namespace <namespace>] |
2242 | [--image <image>] [--expires-at <expires-at>] | |
7c673cae FG |
2243 | <image-spec> |
2244 | ||
c07f9fc5 | 2245 | Move an image to the trash. |
7c673cae FG |
2246 | |
2247 | Positional arguments | |
11fdf7f2 TL |
2248 | <image-spec> image specification |
2249 | (example: [<pool-name>/[<namespace>/]]<image-name>) | |
7c673cae FG |
2250 | |
2251 | Optional arguments | |
11fdf7f2 TL |
2252 | -p [ --pool ] arg pool name |
2253 | --namespace arg namespace name | |
2254 | --image arg image name | |
2255 | --expires-at arg (=now) set the expiration time of an image so it can be | |
2256 | purged when it is stale | |
2257 | ||
2258 | rbd help trash purge | |
2259 | usage: rbd trash purge [--pool <pool>] [--namespace <namespace>] | |
2260 | [--no-progress] [--expired-before <expired-before>] | |
2261 | [--threshold <threshold>] | |
2262 | <pool-spec> | |
2263 | ||
2264 | Remove all expired images from trash. | |
2265 | ||
2266 | Positional arguments | |
2267 | <pool-spec> pool specification | |
2268 | (example: <pool-name>[/<namespace>] | |
2269 | ||
2270 | Optional arguments | |
2271 | -p [ --pool ] arg pool name | |
2272 | --namespace arg namespace name | |
2273 | --no-progress disable progress output | |
2274 | --expired-before date purges images that expired before the given date | |
2275 | --threshold arg purges images until the current pool data usage is | |
2276 | reduced to X%, value range: 0.0-1.0 | |
7c673cae FG |
2277 | |
2278 | rbd help trash remove | |
11fdf7f2 TL |
2279 | usage: rbd trash remove [--pool <pool>] [--namespace <namespace>] |
2280 | [--image-id <image-id>] [--no-progress] [--force] | |
7c673cae FG |
2281 | <image-id> |
2282 | ||
c07f9fc5 | 2283 | Remove an image from trash. |
7c673cae FG |
2284 | |
2285 | Positional arguments | |
2286 | <image-id> image id | |
11fdf7f2 | 2287 | (example: [<pool-name>/[<namespace>/]]<image-id>) |
7c673cae FG |
2288 | |
2289 | Optional arguments | |
2290 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2291 | --namespace arg namespace name |
7c673cae FG |
2292 | --image-id arg image id |
2293 | --no-progress disable progress output | |
2294 | --force force remove of non-expired delayed images | |
2295 | ||
2296 | rbd help trash restore | |
11fdf7f2 TL |
2297 | usage: rbd trash restore [--pool <pool>] [--namespace <namespace>] |
2298 | [--image-id <image-id>] [--image <image>] | |
7c673cae FG |
2299 | <image-id> |
2300 | ||
c07f9fc5 | 2301 | Restore an image from trash. |
7c673cae FG |
2302 | |
2303 | Positional arguments | |
2304 | <image-id> image id | |
2305 | (example: [<pool-name>/]<image-id>) | |
2306 | ||
2307 | Optional arguments | |
2308 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2309 | --namespace arg namespace name |
7c673cae FG |
2310 | --image-id arg image id |
2311 | --image arg image name | |
2312 | ||
7c673cae | 2313 | rbd help watch |
11fdf7f2 | 2314 | usage: rbd watch [--pool <pool>] [--namespace <namespace>] [--image <image>] |
7c673cae FG |
2315 | <image-spec> |
2316 | ||
2317 | Watch events on image. | |
2318 | ||
2319 | Positional arguments | |
2320 | <image-spec> image specification | |
11fdf7f2 | 2321 | (example: [<pool-name>/[<namespace>/]]<image-name>) |
7c673cae FG |
2322 | |
2323 | Optional arguments | |
2324 | -p [ --pool ] arg pool name | |
11fdf7f2 | 2325 | --namespace arg namespace name |
7c673cae FG |
2326 | --image arg image name |
2327 |