previous snap, or image creation.
disk-usage (du) Show disk usage stats for pool, image or
snapshot.
+ encryption format Format image to an encrypted format.
export Export image to file.
export-diff Export incremental diff to file.
feature disable Disable the specified image feature.
group snap remove (... rm) Remove a snapshot from a group.
group snap rename Rename group's snapshot.
group snap rollback Rollback group to snapshot.
+ image-cache invalidate Discard existing / dirty image cache
image-meta get Image metadata get the value associated
with the key.
image-meta list (image-meta ls) Image metadata list keys with values.
watch Watch events on image.
Optional arguments:
- -c [ --conf ] arg path to cluster configuration
- --cluster arg cluster name
- --id arg client id (without 'client.' prefix)
- --user arg client id (without 'client.' prefix)
- -n [ --name ] arg client name
- -m [ --mon_host ] arg monitor host
- --secret arg path to secret key (deprecated)
- -K [ --keyfile ] arg path to secret key
- -k [ --keyring ] arg path to keyring
+ -c [ --conf ] arg path to cluster configuration
+ --cluster arg cluster name
+ --id arg client id (without 'client.' prefix)
+ -n [ --name ] arg client name
+ -m [ --mon_host ] arg monitor host
+ -K [ --keyfile ] arg path to secret key
+ -k [ --keyring ] arg path to keyring
See 'rbd help <command>' for help on a specific command.
$ 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
Positional arguments
<source-snap-spec> source snapshot specification
(example:
- [<pool-name>/[<namespace>/]]<image-name>@<snapshot-n
- ame>)
+ [<pool-name>/[<namespace>/]]<image-name>@<snap-name>
+ )
<dest-image-spec> destination image specification
(example: [<pool-name>/[<namespace>/]]<image-name>)
--dest-pool arg destination pool name
--dest-namespace arg destination namespace name
--dest arg destination image name
- --order arg object order [12 <= order <= 25]
--object-size arg object size in B/K/M [4K <= object size <= 32M]
--image-feature arg image features
[layering(+), exclusive-lock(+*), object-map(+*),
--dest-pool arg destination pool name
--dest-namespace arg destination namespace name
--dest arg destination image name
- --order arg object order [12 <= order <= 25]
--object-size arg object size in B/K/M [4K <= object size <= 32M]
--image-feature arg image features
[layering(+), exclusive-lock(+*),
-p [ --pool ] arg pool name
--namespace arg namespace name
--image arg image name
- --image-format arg image format [1 (deprecated) or 2]
- --new-format use image format 2
- (deprecated)
- --order arg object order [12 <= order <= 25]
+ --image-format arg image format [default: 2]
--object-size arg object size in B/K/M [4K <= object size <= 32M]
--image-feature arg image features
[layering(+), exclusive-lock(+*), object-map(+*),
--dest-pool arg destination pool name
--dest-namespace arg destination namespace name
--dest arg destination image name
- --order arg object order [12 <= order <= 25]
--object-size arg object size in B/K/M [4K <= object size <= 32M]
--image-feature arg image features
[layering(+), exclusive-lock(+*),
rbd help device map
usage: rbd device map [--device-type <device-type>] [--pool <pool>]
[--namespace <namespace>] [--image <image>]
- [--snap <snap>] [--read-only] [--exclusive]
- [--options <options>]
+ [--snap <snap>] [--read-only] [--exclusive] [--quiesce]
+ [--quiesce-hook <quiesce-hook>] [--options <options>]
<image-or-snap-spec>
Map an image to a block device.
--snap arg snapshot name
--read-only map read-only
--exclusive disable automatic exclusive lock transitions
+ --quiesce use quiesce hooks
+ --quiesce-hook arg quiesce hook path
-o [ --options ] arg device specific options
rbd help device unmap
Positional arguments
<image-or-snap-or-device-spec> image, snapshot, or device specification
- [<pool-name>/]<image-name>[@<snapshot-name>]
- or <device-path>
+ [<pool-name>/]<image-name>[@<snap-name>] or
+ <device-path>
Optional arguments
-t [ --device-type ] arg device type [ggate, krbd (default), nbd]
--exact compute exact disk usage (slow)
--merge-snapshots merge snapshot sizes with its image
+ rbd help encryption format
+ usage: rbd encryption format [--pool <pool>] [--namespace <namespace>]
+ [--image <image>] [--cipher-alg <cipher-alg>]
+ <image-spec> <format> <passphrase-file>
+
+ Format image to an encrypted format.
+
+ Positional arguments
+ <image-spec> image specification
+ (example: [<pool-name>/[<namespace>/]]<image-name>)
+ <format> encryption format [possible values: luks1, luks2]
+ <passphrase-file> path of file containing passphrase for unlocking the
+ image
+
+ Optional arguments
+ -p [ --pool ] arg pool name
+ --namespace arg namespace name
+ --image arg image name
+ --cipher-alg arg encryption algorithm [possible values: aes-128, aes-256
+ (default)]
+
rbd help export
usage: rbd export [--pool <pool>] [--namespace <namespace>] [--image <image>]
[--snap <snap>] [--path <path>] [--no-progress]
rbd help feature disable
usage: rbd feature disable [--pool <pool>] [--namespace <namespace>]
[--image <image>]
- <image-spec> <features> [<features> ...]
+ <image-spec> <features> [<features> ...]
Disable the specified image feature.
[--journal-splay-width <journal-splay-width>]
[--journal-object-size <journal-object-size>]
[--journal-pool <journal-pool>]
- <image-spec> <features> [<features> ...]
+ <image-spec> <features> [<features> ...]
Enable the specified image feature.
rbd help group snap create
usage: rbd group snap create [--pool <pool>] [--namespace <namespace>]
[--group <group>] [--snap <snap>]
+ [--skip-quiesce] [--ignore-quiesce-error]
<group-snap-spec>
Make a snapshot of a group.
Positional arguments
- <group-snap-spec> group specification
- (example:
- [<pool-name>/[<namespace>/]]<group-name>@<snap-name>)
+ <group-snap-spec> group specification
+ (example:
+
[<pool-name>/[<namespace>/]]<group-name>@<snap-name>)
Optional arguments
- -p [ --pool ] arg pool name
- --namespace arg namespace name
- --group arg group name
- --snap arg snapshot name
+ -p [ --pool ] arg pool name
+ --namespace arg namespace name
+ --group arg group name
+ --snap arg snapshot name
+ --skip-quiesce do not run quiesce hooks
+ --ignore-quiesce-error ignore quiesce hook error
rbd help group snap list
usage: rbd group snap list [--format <format>] [--pretty-format]
(example:
[<pool-name>/[<namespace>/]]<group-name>@<snap-name>)
<dest-snap> destination snapshot name
- (example: <snapshot-name>)
+ (example: <snap-name>)
Optional arguments
-p [ --pool ] arg pool name
--group arg group name
--snap arg snapshot name
+ rbd help image-cache invalidate
+ usage: rbd image-cache invalidate [--pool <pool>] [--namespace <namespace>]
+ [--image <image>] [--image-id <image-id>]
+ <image-spec>
+
+ Discard existing / dirty image cache
+
+ Positional arguments
+ <image-spec> image specification
+ (example: [<pool-name>/[<namespace>/]]<image-name>)
+
+ Optional arguments
+ -p [ --pool ] arg pool name
+ --namespace arg namespace name
+ --image arg image name
+ --image-id arg image id
+
rbd help image-meta get
usage: rbd image-meta get [--pool <pool>] [--namespace <namespace>]
[--image <image>]
--dest-pool arg destination pool name
--dest-namespace arg destination namespace name
--dest arg destination image name
- --image-format arg image format [1 (deprecated) or 2]
- --new-format use image format 2
- (deprecated)
- --order arg object order [12 <= order <= 25]
+ --image-format arg image format [default: 2]
--object-size arg object size in B/K/M [4K <= object size <= 32M]
--image-feature arg image features
[layering(+), exclusive-lock(+*), object-map(+*),
--sparse-size arg sparse size in B/K/M [default: 4K]
--no-progress disable progress output
--export-format arg format of image file
- -p [ --pool ] arg pool name (deprecated)
- --image arg image name (deprecated)
Image Features:
(*) supports enabling/disabling on existing images
--no-progress disable progress output
rbd help migration prepare
- usage: rbd migration prepare [--pool <pool>] [--namespace <namespace>]
- [--image <image>] [--dest-pool <dest-pool>]
+ usage: rbd migration prepare [--import-only]
+ [--source-spec-path <source-spec-path>]
+ [--source-spec <source-spec>] [--pool <pool>]
+ [--namespace <namespace>] [--image <image>]
+ [--snap <snap>] [--dest-pool <dest-pool>]
[--dest-namespace <dest-namespace>]
[--dest <dest>] [--image-format <image-format>]
[--new-format] [--order <order>]
[--journal-splay-width <journal-splay-width>]
[--journal-object-size <journal-object-size>]
[--journal-pool <journal-pool>] [--flatten]
- <source-image-spec> <dest-image-spec>
+ <source-image-or-snap-spec> <dest-image-spec>
Prepare image migration.
Positional arguments
- <source-image-spec> source image specification
- (example: [<pool-name>/[<namespace>/]]<image-name>)
- <dest-image-spec> destination image specification
- (example: [<pool-name>/[<namespace>/]]<image-name>)
+ <source-image-or-snap-spec> source image or snapshot specification
+ (example:
+ [<pool-name>/[<namespace>/]]<image-name>[@<snap-n
+ ame>])
+ <dest-image-spec> destination image specification
+ (example:
+ [<pool-name>/[<namespace>/]]<image-name>)
Optional arguments
- -p [ --pool ] arg source pool name
- --namespace arg source namespace name
- --image arg source image name
- --dest-pool arg destination pool name
- --dest-namespace arg destination namespace name
- --dest arg destination image name
- --image-format arg image format [1 (deprecated) or 2]
- --new-format use image format 2
- (deprecated)
- --order arg object order [12 <= order <= 25]
- --object-size arg object size in B/K/M [4K <= object size <= 32M]
- --image-feature arg image features
- [layering(+), exclusive-lock(+*), object-map(+*),
- deep-flatten(+-), journaling(*)]
- --image-shared shared image
- --stripe-unit arg stripe unit in B/K/M
- --stripe-count arg stripe count
- --data-pool arg data pool
- --mirror-image-mode arg mirror image mode [journal or snapshot]
- --journal-splay-width arg number of active journal objects
- --journal-object-size arg size of journal objects [4K <= size <= 64M]
- --journal-pool arg pool for journal objects
- --flatten fill clone with parent data (make it independent)
+ --import-only only import data from source
+ --source-spec-path arg source-spec file (or '-' for stdin)
+ --source-spec arg source-spec
+ -p [ --pool ] arg source pool name
+ --namespace arg source namespace name
+ --image arg source image name
+ --snap arg source snapshot name
+ --dest-pool arg destination pool name
+ --dest-namespace arg destination namespace name
+ --dest arg destination image name
+ --image-format arg image format [default: 2]
+ --object-size arg object size in B/K/M [4K <= object size <= 32M]
+ --image-feature arg image features
+ [layering(+), exclusive-lock(+*),
+ object-map(+*), deep-flatten(+-), journaling(*)]
+ --image-shared shared image
+ --stripe-unit arg stripe unit in B/K/M
+ --stripe-count arg stripe count
+ --data-pool arg data pool
+ --mirror-image-mode arg mirror image mode [journal or snapshot]
+ --journal-splay-width arg number of active journal objects
+ --journal-object-size arg size of journal objects [4K <= size <= 64M]
+ --journal-pool arg pool for journal objects
+ --flatten fill clone with parent data (make it independent)
Image Features:
(*) supports enabling/disabling on existing images
rbd help mirror image snapshot
usage: rbd mirror image snapshot [--pool <pool>] [--namespace <namespace>]
- [--image <image>]
+ [--image <image>] [--skip-quiesce]
+ [--ignore-quiesce-error]
<image-spec>
Create RBD mirroring image snapshot.
Positional arguments
- <image-spec> image specification
- (example: [<pool-name>/[<namespace>/]]<image-name>)
+ <image-spec> image specification
+
(example: [<pool-name>/[<namespace>/]]<image-name>)
Optional arguments
- -p [ --pool ] arg pool name
- --namespace arg namespace name
- --image arg image name
+ -p [ --pool ] arg pool name
+ --namespace arg namespace name
+ --image arg image name
+ --skip-quiesce do not run quiesce hooks
+ --ignore-quiesce-error ignore quiesce hook error
rbd help mirror image status
usage: rbd mirror image status [--pool <pool>] [--namespace <namespace>]
rbd help snap create
usage: rbd snap create [--pool <pool>] [--namespace <namespace>]
- [--image <image>] [--snap <snap>]
+ [--image <image>] [--snap <snap>] [--skip-quiesce]
+ [--ignore-quiesce-error] [--no-progress]
<snap-spec>
Create a snapshot.
Positional arguments
- <snap-spec> snapshot specification
- (example:
- [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>)
+ <snap-spec> snapshot specification
+ (example:
+ [<pool-name>/[<namespace>/]]<image-name>@<snap-name>)
Optional arguments
- -p [ --pool ] arg pool name
- --namespace arg namespace name
- --image arg image name
- --snap arg snapshot name
+ -p [ --pool ] arg pool name
+ --namespace arg namespace name
+ --image arg image name
+ --snap arg snapshot name
+ --skip-quiesce do not run quiesce hooks
+ --ignore-quiesce-error ignore quiesce hook error
+ --no-progress disable progress output
rbd help snap limit clear
usage: rbd snap limit clear [--pool <pool>] [--namespace <namespace>]
Positional arguments
<snap-spec> snapshot specification
(example:
- [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>)
+ [<pool-name>/[<namespace>/]]<image-name>@<snap-name>)
Optional arguments
-p [ --pool ] arg pool name
Positional arguments
<snap-spec> snapshot specification
(example:
- [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>)
+ [<pool-name>/[<namespace>/]]<image-name>@<snap-name>)
Optional arguments
-p [ --pool ] arg pool name
Positional arguments
<source-snap-spec> source snapshot specification
(example:
- [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>)
+ [<pool-name>/[<namespace>/]]<image-name>@<snap-name>)
<dest-snap-spec> destination snapshot specification
(example:
- [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>)
+ [<pool-name>/[<namespace>/]]<image-name>@<snap-name>)
Optional arguments
-p [ --pool ] arg source pool name
Positional arguments
<snap-spec> snapshot specification
(example:
- [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>)
+ [<pool-name>/[<namespace>/]]<image-name>@<snap-name>)
Optional arguments
-p [ --pool ] arg pool name
Positional arguments
<snap-spec> snapshot specification
(example:
- [<pool-name>/[<namespace>/]]<image-name>@<snapshot-name>)
+ [<pool-name>/[<namespace>/]]<image-name>@<snap-name>)
Optional arguments
-p [ --pool ] arg pool name
projects / ceph.git / blobdiff