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