From 7ef01dcdefeaf991a8d26996fbd3694592a48c92 Mon Sep 17 00:00:00 2001 From: Jason Dillaman Date: Fri, 18 Sep 2015 19:36:24 -0400 Subject: [PATCH] tests: update cli/rbd cram tests for refactored rbd Signed-off-by: Jason Dillaman --- src/test/cli/rbd/help.t | 898 ++++++++++++++--- src/test/cli/rbd/invalid-snap-usage.t | 735 +++++++++++++- src/test/cli/rbd/not-enough-args.t | 1339 +++++++++++++++++++++++-- 3 files changed, 2756 insertions(+), 216 deletions(-) diff --git a/src/test/cli/rbd/help.t b/src/test/cli/rbd/help.t index ad6a9ee90b524..9bc818b622942 100644 --- a/src/test/cli/rbd/help.t +++ b/src/test/cli/rbd/help.t @@ -1,119 +1,785 @@ $ rbd --help - usage: rbd [-n ] [OPTIONS] ... - where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of: - (ls | list) [-l | --long ] [pool-name] list rbd images - (-l includes snapshots/clones) - (du | disk-usage) [ | ] - show disk usage stats for pool, - image or snapshot - info | show information about image size, - striping, etc. - create [--order ] [--image-features ] [--image-shared] - --size create an empty image - clone [--order ] [--image-features ] [--image-shared] - - clone a snapshot into a COW - child image - children display children of snapshot - flatten fill clone with parent data - (make it independent) - resize --size resize (expand or contract) image - rm delete an image - export ( | ) [] - export image to file - "-" for stdout - import [--image-features ] [--image-shared] - [] import image from file - "-" for stdin - "rbd/$(basename )" is - assumed for if - omitted - diff [--from-snap ] [--whole-object] - | print extents that differ since - a previous snap, or image creation - export-diff [--from-snap ] [--whole-object] - ( | ) export an incremental diff to - path, or "-" for stdout - merge-diff merge and into - , could be "-" - for stdin, and could be "-" - for stdout - import-diff import an incremental diff from - path or "-" for stdin - (cp | copy) ( | ) - copy src image to dest - (mv | rename) - rename src image to dest - image-meta list image metadata list keys with values - image-meta get image metadata get the value associated with the key - image-meta set image metadata set key with value - image-meta remove image metadata remove the key and value associated - object-map rebuild | - rebuild an invalid object map - snap ls dump list of image snapshots - snap create create a snapshot - snap rollback rollback image to snapshot - snap rm deletes a snapshot - snap purge deletes all snapshots - snap protect prevent a snapshot from being deleted - snap unprotect allow a snapshot to be deleted - watch watch events on image - status show the status of this image - map | map image to a block device - using the kernel - unmap | | unmap a rbd device that was - mapped by the kernel - showmapped show the rbd images mapped - by the kernel - feature disable disable the specified image feature - feature enable enable the specified image feature - lock list show locks held on an image - lock add [--shared ] take a lock called id on an image - lock remove release a lock on an image - bench-write simple write benchmark - --io-size write size - --io-threads ios in flight - --io-total total size to write - --io-pattern write pattern - - is []/, - is []/@, - or you may specify individual pieces of names with -p/--pool , - --image and/or --snap . - - Other input options: - -p, --pool source pool name - --dest-pool destination pool name - --image image name - --dest destination image name - --snap snapshot name - --path path name for import/export - -s, --size size of image for create and resize - --order the object size in bits; object size will be - (1 << order) bytes. Default is 22 (4 MB). - --image-format format to use when creating an image - format 1 is the original format - format 2 supports cloning (default) - --image-feature optional format 2 feature to enable. - use multiple times to enable multiple features - --image-shared image will be used concurrently (disables - RBD exclusive lock and dependent features) - --stripe-unit size of a block of data - --stripe-count number of consecutive objects in a stripe - --id rados user (without 'client.'prefix) to - authenticate as - --keyfile file containing secret key for use with cephx - --keyring file containing keyring for use with cephx - --shared take a shared (rather than exclusive) lock - --format output format (default: plain, json, xml) - --pretty-format make json or xml output more readable - --no-progress do not show progress for long-running commands - -o, --options options to use when mapping an image - --read-only set device readonly when mapping image - --allow-shrink allow shrinking of an image when resizing - - Supported image features: - layering (+), striping (+), exclusive-lock (*), object-map (*), fast-diff (*), deep-flatten + usage: rbd ... + Command-line interface for managing Ceph RBD images. + + Positional arguments: + + bench-write Simple write benchmark. + children Display children of snapshot. + clone Clone a snapshot into a COW child image. + copy (cp) Copy src image to dest. + create Create an empty image. + diff Print extents that differ since a previous snap, or + image creation. + disk-usage (du) Show disk usage stats for pool, image or snapshot + export Export image to file. + export-diff Export incremental diff to file. + feature disable Disable the specified image feature. + feature enable Enable the specified image feature. + flatten Fill clone with parent data (make it independent). + image-meta get Image metadata get the value associated with the key. + image-meta list Image metadata list keys with values. + image-meta remove Image metadata remove the key and value associated. + image-meta set Image metadata set key with value. + import Import image from file. + import-diff Import an incremental diff. + info Show information about image size, striping, etc. + list (ls) List rbd images. + lock add Take a lock on an image. + lock list Show locks held on an image. + lock remove (lock rm) Release a lock on an image. + map Map image to a block device using the kernel. + merge-diff Merge two diff exports together. + object-map rebuild Rebuild an invalid object map. + remove (rm) Delete an image. + rename (mv) Rename image within pool. + resize Resize (expand or shrink) image. + showmapped Show the rbd images mapped by the kernel. + snap create Create a snapshot. + snap ls Dump list of image snapshots. + snap protect Prevent a snapshot from being deleted. + snap purge Deletes all snapshots. + snap remove (snap rm) Deletes a snapshot. + snap rollback Rollback image to snapshot. + snap unprotect Allow a snapshot to be deleted. + status Show the status of this image. + unmap Unmap a rbd device that was used by the kernel. + watch Watch events on image. + + Optional arguments: + -c [ --conf ] arg path to cluster configuration + --cluster arg cluster name + -i [ --id ] arg client id (without 'client.' prefix) + -n [ --name ] arg client name + --secret arg path to secret key (deprecated) + --keyfile arg path to secret key + --keyring arg path to keyring + + See 'rbd help ' for help on a specific command. + $ while read -r line; do echo rbd help $line ; rbd help $line; done <<< "$(rbd help | grep '^ [a-z]' | sed 's/^ \([a-z -]*[a-z]\).*/\1/g')" + rbd help bench-write + usage: rbd bench-write [--pool ] [--image ] [--io-size ] + [--io-threads ] [--io-total ] + [--io-pattern ] + + + Simple write benchmark. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --io-size arg write size (in B/K/M/G/T) + --io-threads arg ios in flight + --io-total arg total size to write (in B/K/M/G/T) + --io-pattern arg write pattern (rand or seq) + + rbd help children + usage: rbd children [--pool ] [--image ] [--snap ] + [--format ] [--pretty-format] + + + Display children of snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help clone + usage: rbd clone [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--order ] + [--image-features ] [--image-shared] + [--stripe-unit ] [--stripe-count ] + + + Clone a snapshot into a COW child image. + + Positional arguments + source snapshot specification + (example: [/]@) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + rbd help copy + usage: rbd copy [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--no-progress] + + + Copy src image to dest. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --no-progress disable progress output + + rbd help create + usage: rbd create [--pool ] [--image ] + [--image-format ] [--new-format] + [--order ] [--image-features ] + [--image-shared] [--stripe-unit ] + [--stripe-count ] --size + + + Create an empty image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --image-format arg image format [1 or 2] + --new-format use image format 2 + (deprecated) + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + -s [ --size ] arg image size (in M/G/T) + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + rbd help diff + usage: rbd diff [--pool ] [--image ] [--snap ] + [--from-snap ] [--whole-object] [--format ] + [--pretty-format] + + + Print extents that differ since a previous snap, or image creation. + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --from-snap arg snapshot starting point + --whole-object compare whole object + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help disk-usage + usage: rbd disk-usage [--pool ] [--image ] [--snap ] + [--format ] [--pretty-format] + + + Show disk usage stats for pool, image or snapshot + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help export + usage: rbd export [--pool ] [--image ] [--snap ] + [--path ] [--no-progress] + + + Export image to file. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + export file (or '-' for stdout) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --path arg export file (or '-' for stdout) + --no-progress disable progress output + + rbd help export-diff + usage: rbd export-diff [--pool ] [--image ] [--snap ] + [--path ] [--from-snap ] + [--whole-object] [--no-progress] + + + Export incremental diff to file. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + export file (or '-' for stdout) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --path arg export file (or '-' for stdout) + --from-snap arg snapshot starting point + --whole-object compare whole object + --no-progress disable progress output + + rbd help feature disable + usage: rbd feature disable [--pool ] [--image ] + [ ...] + + Disable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + rbd help feature enable + usage: rbd feature enable [--pool ] [--image ] + [ ...] + + Enable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + rbd help flatten + usage: rbd flatten [--pool ] [--image ] [--no-progress] + + + Fill clone with parent data (make it independent). + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + rbd help image-meta get + usage: rbd image-meta get [--pool ] [--image ] + + + Image metadata get the value associated with the key. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + rbd help image-meta list + usage: rbd image-meta list [--pool ] [--image ] + [--format ] [--pretty-format] + + + Image metadata list keys with values. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help image-meta remove + usage: rbd image-meta remove [--pool ] [--image ] + + + Image metadata remove the key and value associated. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + rbd help image-meta set + usage: rbd image-meta set [--pool ] [--image ] + + + Image metadata set key with value. + + Positional arguments + image specification + (example: [/]) + image meta key + image meta value + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + rbd help import + usage: rbd import [--path ] [--dest-pool ] [--dest ] + [--image-format ] [--new-format] + [--order ] [--image-features ] + [--image-shared] [--stripe-unit ] + [--stripe-count ] [--no-progress] + [--pool ] [--image ] + + + Import image from file. + + Positional arguments + import file (or '-' for stdin) + destination image specification + (example: [/]) + + Optional arguments + --path arg import file (or '-' for stdin) + --dest-pool arg destination pool name + --dest arg destination image name + --image-format arg image format [1 or 2] + --new-format use image format 2 + (deprecated) + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + --no-progress disable progress output + -p [ --pool ] arg pool name (deprecated) + --image arg image name (deprecated) + + Image Features: (*) supports enabling/disabling on existing images - (+) enabled by default for new images if features are not specified + (+) enabled by default for new images if features not specified + + rbd help import-diff + usage: rbd import-diff [--path ] [--pool ] [--image ] + [--no-progress] + + + Import an incremental diff. + + Positional arguments + import file (or '-' for stdin) + image specification + (example: [/]) + + Optional arguments + --path arg import file (or '-' for stdin) + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + rbd help info + usage: rbd info [--pool ] [--image ] [--snap ] + [--format ] [--pretty-format] + + + Show information about image size, striping, etc. + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help list + usage: rbd list [--long] [--pool ] [--format ] [--pretty-format] + + + List rbd images. + + Positional arguments + pool name + + Optional arguments + -l [ --long ] long listing format + -p [ --pool ] arg pool name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help lock add + usage: rbd lock add [--pool ] [--image ] [--shared ] + + + Take a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --shared arg shared lock tag + + rbd help lock list + usage: rbd lock list [--pool ] [--image ] [--format ] + [--pretty-format] + + + Show locks held on an image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help lock remove + usage: rbd lock remove [--pool ] [--image ] + + + Release a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + locker client + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + rbd help map + usage: rbd map [--pool ] [--image ] [--snap ] + [--options ] [--read-only] + + + Map image to a block device using the kernel. + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + -o [ --options ] arg mapping options + --read-only mount read-only + + rbd help merge-diff + usage: rbd merge-diff [--path ] [--no-progress] + + + Merge two diff exports together. + + Positional arguments + path to first diff (or '-' for stdin) + path to second diff + path to merged diff (or '-' for stdout) + + Optional arguments + --path arg path to merged diff (or '-' for stdout) + --no-progress disable progress output + + rbd help object-map rebuild + usage: rbd object-map rebuild [--pool ] [--image ] + [--snap ] [--no-progress] + + + Rebuild an invalid object map. + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --no-progress disable progress output + + rbd help remove + usage: rbd remove [--pool ] [--image ] [--no-progress] + + + Delete an image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + rbd help rename + usage: rbd rename [--pool ] [--image ] [--dest-pool ] + [--dest ] + + + Rename image within pool. + + Positional arguments + source image specification + (example: [/]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --dest-pool arg destination pool name + --dest arg destination image name + + rbd help resize + usage: rbd resize [--pool ] [--image ] --size + [--allow-shrink] [--no-progress] + + + Resize (expand or shrink) image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + -s [ --size ] arg image size (in M/G/T) + --allow-shrink permit shrinking + --no-progress disable progress output + + rbd help showmapped + usage: rbd showmapped [--format ] [--pretty-format] + + Show the rbd images mapped by the kernel. + + Optional arguments + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help snap create + usage: rbd snap create [--pool ] [--image ] [--snap ] + + + Create a snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + rbd help snap ls + usage: rbd snap ls [--pool ] [--image ] [--format ] + [--pretty-format] + + + Dump list of image snapshots. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help snap protect + usage: rbd snap protect [--pool ] [--image ] [--snap ] + + + Prevent a snapshot from being deleted. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + rbd help snap purge + usage: rbd snap purge [--pool ] [--image ] [--no-progress] + + + Deletes all snapshots. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + rbd help snap remove + usage: rbd snap remove [--pool ] [--image ] [--snap ] + + + Deletes a snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + rbd help snap rollback + usage: rbd snap rollback [--pool ] [--image ] [--snap ] + [--no-progress] + + + Rollback image to snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --no-progress disable progress output + + rbd help snap unprotect + usage: rbd snap unprotect [--pool ] [--image ] [--snap ] + + + Allow a snapshot to be deleted. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + rbd help status + usage: rbd status [--pool ] [--image ] [--format ] + [--pretty-format] + + + Show the status of this image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + rbd help unmap + usage: rbd unmap [--pool ] [--image ] [--snap ] + + + Unmap a rbd device that was used by the kernel. + + Positional arguments + image, snapshot, or device specification + [/][@] + or + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + rbd help watch + usage: rbd watch [--pool ] [--image ] + + + Watch events on image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + diff --git a/src/test/cli/rbd/invalid-snap-usage.t b/src/test/cli/rbd/invalid-snap-usage.t index 6735dc4b33886..bfe87254dc7a6 100644 --- a/src/test/cli/rbd/invalid-snap-usage.t +++ b/src/test/cli/rbd/invalid-snap-usage.t @@ -1,109 +1,772 @@ $ rbd create foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd create [--pool ] [--image ] + [--image-format ] [--new-format] + [--order ] [--image-features ] + [--image-shared] [--stripe-unit ] + [--stripe-count ] --size + + + Create an empty image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --image-format arg image format [1 or 2] + --new-format use image format 2 + (deprecated) + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + -s [ --size ] arg image size (in M/G/T) + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd flatten foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd flatten [--pool ] [--image ] [--no-progress] + + + Fill clone with parent data (make it independent). + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + [22] $ rbd resize foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd resize [--pool ] [--image ] --size + [--allow-shrink] [--no-progress] + + + Resize (expand or shrink) image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + -s [ --size ] arg image size (in M/G/T) + --allow-shrink permit shrinking + --no-progress disable progress output + + [22] $ rbd rm foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd remove [--pool ] [--image ] [--no-progress] + + + Delete an image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + [22] $ rbd import-diff /tmp/diff foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd import-diff [--path ] [--pool ] [--image ] + [--no-progress] + + + Import an incremental diff. + + Positional arguments + import file (or '-' for stdin) + image specification + (example: [/]) + + Optional arguments + --path arg import file (or '-' for stdin) + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + [22] $ rbd mv foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd rename [--pool ] [--image ] [--dest-pool ] + [--dest ] + + + Rename image within pool. + + Positional arguments + source image specification + (example: [/]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --dest-pool arg destination pool name + --dest arg destination image name + + [22] $ rbd mv foo@snap bar rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd rename [--pool ] [--image ] [--dest-pool ] + [--dest ] + + + Rename image within pool. + + Positional arguments + source image specification + (example: [/]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --dest-pool arg destination pool name + --dest arg destination image name + + [22] $ rbd mv foo@snap bar@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd rename [--pool ] [--image ] [--dest-pool ] + [--dest ] + + + Rename image within pool. + + Positional arguments + source image specification + (example: [/]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --dest-pool arg destination pool name + --dest arg destination image name + + [22] $ rbd image-meta list foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd image-meta list [--pool ] [--image ] + [--format ] [--pretty-format] + + + Image metadata list keys with values. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd image-meta get foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd image-meta get [--pool ] [--image ] + + + Image metadata get the value associated with the key. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta get foo@snap key rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd image-meta get [--pool ] [--image ] + + + Image metadata get the value associated with the key. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta set foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd image-meta set [--pool ] [--image ] + + + Image metadata set key with value. + + Positional arguments + image specification + (example: [/]) + image meta key + image meta value + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta set foo@snap key rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd image-meta set [--pool ] [--image ] + + + Image metadata set key with value. + + Positional arguments + image specification + (example: [/]) + image meta key + image meta value + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta set foo@snap key val rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd image-meta set [--pool ] [--image ] + + + Image metadata set key with value. + + Positional arguments + image specification + (example: [/]) + image meta key + image meta value + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta remove foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd image-meta remove [--pool ] [--image ] + + + Image metadata remove the key and value associated. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta remove foo@snap key rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd image-meta remove [--pool ] [--image ] + + + Image metadata remove the key and value associated. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd snap ls foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd snap ls [--pool ] [--image ] [--format ] + [--pretty-format] + + + Dump list of image snapshots. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd snap purge foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd snap purge [--pool ] [--image ] [--no-progress] + + + Deletes all snapshots. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + [22] $ rbd watch foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd watch [--pool ] [--image ] + + + Watch events on image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd status foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd status [--pool ] [--image ] [--format ] + [--pretty-format] + + + Show the status of this image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd feature disable foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd feature disable [--pool ] [--image ] + [ ...] + + Disable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd feature disable foo@snap layering rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd feature disable [--pool ] [--image ] + [ ...] + + Disable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd feature enable foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd feature enable [--pool ] [--image ] + [ ...] + + Enable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd feature enable foo@snap layering rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd feature enable [--pool ] [--image ] + [ ...] + + Enable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd lock list foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd lock list [--pool ] [--image ] [--format ] + [--pretty-format] + + + Show locks held on an image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd lock add foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd lock add [--pool ] [--image ] [--shared ] + + + Take a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --shared arg shared lock tag + + [22] $ rbd lock add foo@snap id rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd lock add [--pool ] [--image ] [--shared ] + + + Take a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --shared arg shared lock tag + + [22] $ rbd lock remove foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd lock remove [--pool ] [--image ] + + + Release a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + locker client + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd lock remove foo@snap id rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd lock remove [--pool ] [--image ] + + + Release a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + locker client + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd lock remove foo@snap id client.1234 rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd lock remove [--pool ] [--image ] + + + Release a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + locker client + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd bench-write foo@snap rbd: snapname specified for a command that doesn't use it - [1] + + usage: rbd bench-write [--pool ] [--image ] [--io-size ] + [--io-threads ] [--io-total ] + [--io-pattern ] + + + Simple write benchmark. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --io-size arg write size (in B/K/M/G/T) + --io-threads arg ios in flight + --io-total arg total size to write (in B/K/M/G/T) + --io-pattern arg write pattern (rand or seq) + + [22] $ rbd clone foo@snap bar@snap rbd: destination snapname specified for a command that doesn't use it - [1] + + usage: rbd clone [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--order ] + [--image-features ] [--image-shared] + [--stripe-unit ] [--stripe-count ] + + + Clone a snapshot into a COW child image. + + Positional arguments + source snapshot specification + (example: [/]@) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd import /bin/ls ls@snap rbd: destination snapname specified for a command that doesn't use it - [1] + + usage: rbd import [--path ] [--dest-pool ] [--dest ] + [--image-format ] [--new-format] + [--order ] [--image-features ] + [--image-shared] [--stripe-unit ] + [--stripe-count ] [--no-progress] + [--pool ] [--image ] + + + Import image from file. + + Positional arguments + import file (or '-' for stdin) + destination image specification + (example: [/]) + + Optional arguments + --path arg import file (or '-' for stdin) + --dest-pool arg destination pool name + --dest arg destination image name + --image-format arg image format [1 or 2] + --new-format use image format 2 + (deprecated) + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + --no-progress disable progress output + -p [ --pool ] arg pool name (deprecated) + --image arg image name (deprecated) + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd cp foo bar@snap rbd: destination snapname specified for a command that doesn't use it - [1] + + usage: rbd copy [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--no-progress] + + + Copy src image to dest. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --no-progress disable progress output + + [22] $ rbd cp foo@snap bar@snap rbd: destination snapname specified for a command that doesn't use it - [1] + + usage: rbd copy [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--no-progress] + + + Copy src image to dest. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --no-progress disable progress output + + [22] $ rbd mv foo bar@snap rbd: destination snapname specified for a command that doesn't use it - [1] + + usage: rbd rename [--pool ] [--image ] [--dest-pool ] + [--dest ] + + + Rename image within pool. + + Positional arguments + source image specification + (example: [/]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --dest-pool arg destination pool name + --dest arg destination image name + + [22] diff --git a/src/test/cli/rbd/not-enough-args.t b/src/test/cli/rbd/not-enough-args.t index df4fbd7f28c45..84b52275e0fbb 100644 --- a/src/test/cli/rbd/not-enough-args.t +++ b/src/test/cli/rbd/not-enough-args.t @@ -1,192 +1,1403 @@ $ rbd info rbd: image name was not specified - [1] + + usage: rbd info [--pool ] [--image ] [--snap ] + [--format ] [--pretty-format] + + + Show information about image size, striping, etc. + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd create rbd: image name was not specified - [1] + + usage: rbd create [--pool ] [--image ] + [--image-format ] [--new-format] + [--order ] [--image-features ] + [--image-shared] [--stripe-unit ] + [--stripe-count ] --size + + + Create an empty image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --image-format arg image format [1 or 2] + --new-format use image format 2 + (deprecated) + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + -s [ --size ] arg image size (in M/G/T) + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd clone rbd: image name was not specified - [1] + + usage: rbd clone [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--order ] + [--image-features ] [--image-shared] + [--stripe-unit ] [--stripe-count ] + + + Clone a snapshot into a COW child image. + + Positional arguments + source snapshot specification + (example: [/]@) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd clone foo rbd: snap name was not specified - [1] + + usage: rbd clone [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--order ] + [--image-features ] [--image-shared] + [--stripe-unit ] [--stripe-count ] + + + Clone a snapshot into a COW child image. + + Positional arguments + source snapshot specification + (example: [/]@) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd clone foo@snap rbd: destination image name was not specified - [1] + + usage: rbd clone [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--order ] + [--image-features ] [--image-shared] + [--stripe-unit ] [--stripe-count ] + + + Clone a snapshot into a COW child image. + + Positional arguments + source snapshot specification + (example: [/]@) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd clone foo bar rbd: snap name was not specified - [1] + + usage: rbd clone [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--order ] + [--image-features ] [--image-shared] + [--stripe-unit ] [--stripe-count ] + + + Clone a snapshot into a COW child image. + + Positional arguments + source snapshot specification + (example: [/]@) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd clone foo bar@snap rbd: snap name was not specified - [1] + + usage: rbd clone [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--order ] + [--image-features ] [--image-shared] + [--stripe-unit ] [--stripe-count ] + + + Clone a snapshot into a COW child image. + + Positional arguments + source snapshot specification + (example: [/]@) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd children rbd: image name was not specified - [1] + + usage: rbd children [--pool ] [--image ] [--snap ] + [--format ] [--pretty-format] + + + Display children of snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd children foo rbd: snap name was not specified - [1] + + usage: rbd children [--pool ] [--image ] [--snap ] + [--format ] [--pretty-format] + + + Display children of snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd flatten rbd: image name was not specified - [1] + + usage: rbd flatten [--pool ] [--image ] [--no-progress] + + + Fill clone with parent data (make it independent). + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + [22] $ rbd resize rbd: image name was not specified - [1] + + usage: rbd resize [--pool ] [--image ] --size + [--allow-shrink] [--no-progress] + + + Resize (expand or shrink) image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + -s [ --size ] arg image size (in M/G/T) + --allow-shrink permit shrinking + --no-progress disable progress output + + [22] $ rbd rm rbd: image name was not specified - [1] + + usage: rbd remove [--pool ] [--image ] [--no-progress] + + + Delete an image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + [22] $ rbd export rbd: image name was not specified - [1] + + usage: rbd export [--pool ] [--image ] [--snap ] + [--path ] [--no-progress] + + + Export image to file. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + export file (or '-' for stdout) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --path arg export file (or '-' for stdout) + --no-progress disable progress output + + [22] $ rbd import rbd: path was not specified - [1] + + usage: rbd import [--path ] [--dest-pool ] [--dest ] + [--image-format ] [--new-format] + [--order ] [--image-features ] + [--image-shared] [--stripe-unit ] + [--stripe-count ] [--no-progress] + [--pool ] [--image ] + + + Import image from file. + + Positional arguments + import file (or '-' for stdin) + destination image specification + (example: [/]) + + Optional arguments + --path arg import file (or '-' for stdin) + --dest-pool arg destination pool name + --dest arg destination image name + --image-format arg image format [1 or 2] + --new-format use image format 2 + (deprecated) + --order arg object order [12 <= order <= 25] + --image-features arg image features + [layering(+), striping(+), exclusive-lock(*), + object-map(*), fast-diff(*), deep-flatten] + --image-shared shared image + --stripe-unit arg stripe unit + --stripe-count arg stripe count + --no-progress disable progress output + -p [ --pool ] arg pool name (deprecated) + --image arg image name (deprecated) + + Image Features: + (*) supports enabling/disabling on existing images + (+) enabled by default for new images if features not specified + + [22] $ rbd diff rbd: image name was not specified - [1] + + usage: rbd diff [--pool ] [--image ] [--snap ] + [--from-snap ] [--whole-object] [--format ] + [--pretty-format] + + + Print extents that differ since a previous snap, or image creation. + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --from-snap arg snapshot starting point + --whole-object compare whole object + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd export-diff rbd: image name was not specified - [1] + + usage: rbd export-diff [--pool ] [--image ] [--snap ] + [--path ] [--from-snap ] + [--whole-object] [--no-progress] + + + Export incremental diff to file. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + export file (or '-' for stdout) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --path arg export file (or '-' for stdout) + --from-snap arg snapshot starting point + --whole-object compare whole object + --no-progress disable progress output + + [22] $ rbd export-diff foo rbd: path was not specified - [1] + + usage: rbd export-diff [--pool ] [--image ] [--snap ] + [--path ] [--from-snap ] + [--whole-object] [--no-progress] + + + Export incremental diff to file. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + export file (or '-' for stdout) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --path arg export file (or '-' for stdout) + --from-snap arg snapshot starting point + --whole-object compare whole object + --no-progress disable progress output + + [22] $ rbd export-diff foo@snap rbd: path was not specified - [1] + + usage: rbd export-diff [--pool ] [--image ] [--snap ] + [--path ] [--from-snap ] + [--whole-object] [--no-progress] + + + Export incremental diff to file. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + export file (or '-' for stdout) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --path arg export file (or '-' for stdout) + --from-snap arg snapshot starting point + --whole-object compare whole object + --no-progress disable progress output + + [22] $ rbd merge-diff rbd: first diff was not specified - [1] + + usage: rbd merge-diff [--path ] [--no-progress] + + + Merge two diff exports together. + + Positional arguments + path to first diff (or '-' for stdin) + path to second diff + path to merged diff (or '-' for stdout) + + Optional arguments + --path arg path to merged diff (or '-' for stdout) + --no-progress disable progress output + + [22] $ rbd merge-diff /tmp/diff1 rbd: second diff was not specified - [1] + + usage: rbd merge-diff [--path ] [--no-progress] + + + Merge two diff exports together. + + Positional arguments + path to first diff (or '-' for stdin) + path to second diff + path to merged diff (or '-' for stdout) + + Optional arguments + --path arg path to merged diff (or '-' for stdout) + --no-progress disable progress output + + [22] $ rbd merge-diff /tmp/diff1 /tmp/diff2 rbd: path was not specified - [1] + + usage: rbd merge-diff [--path ] [--no-progress] + + + Merge two diff exports together. + + Positional arguments + path to first diff (or '-' for stdin) + path to second diff + path to merged diff (or '-' for stdout) + + Optional arguments + --path arg path to merged diff (or '-' for stdout) + --no-progress disable progress output + + [22] $ rbd import-diff rbd: path was not specified - [1] + + usage: rbd import-diff [--path ] [--pool ] [--image ] + [--no-progress] + + + Import an incremental diff. + + Positional arguments + import file (or '-' for stdin) + image specification + (example: [/]) + + Optional arguments + --path arg import file (or '-' for stdin) + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + [22] $ rbd import-diff /tmp/diff rbd: image name was not specified - [1] + + usage: rbd import-diff [--path ] [--pool ] [--image ] + [--no-progress] + + + Import an incremental diff. + + Positional arguments + import file (or '-' for stdin) + image specification + (example: [/]) + + Optional arguments + --path arg import file (or '-' for stdin) + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + [22] $ rbd cp rbd: image name was not specified - [1] + + usage: rbd copy [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--no-progress] + + + Copy src image to dest. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --no-progress disable progress output + + [22] $ rbd cp foo rbd: destination image name was not specified - [1] + + usage: rbd copy [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--no-progress] + + + Copy src image to dest. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --no-progress disable progress output + + [22] $ rbd cp foo@snap rbd: destination image name was not specified - [1] + + usage: rbd copy [--pool ] [--image ] [--snap ] + [--dest-pool ] [--dest ] [--no-progress] + + + Copy src image to dest. + + Positional arguments + source image or snapshot specification + (example: + [/][@]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --snap arg source snapshot name + --dest-pool arg destination pool name + --dest arg destination image name + --no-progress disable progress output + + [22] $ rbd mv rbd: image name was not specified - [1] + + usage: rbd rename [--pool ] [--image ] [--dest-pool ] + [--dest ] + + + Rename image within pool. + + Positional arguments + source image specification + (example: [/]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --dest-pool arg destination pool name + --dest arg destination image name + + [22] $ rbd mv foo rbd: destination image name was not specified - [1] + + usage: rbd rename [--pool ] [--image ] [--dest-pool ] + [--dest ] + + + Rename image within pool. + + Positional arguments + source image specification + (example: [/]) + destination image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg source pool name + --image arg source image name + --dest-pool arg destination pool name + --dest arg destination image name + + [22] $ rbd image-meta list rbd: image name was not specified - [1] + + usage: rbd image-meta list [--pool ] [--image ] + [--format ] [--pretty-format] + + + Image metadata list keys with values. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd image-meta get rbd: image name was not specified - [1] + + usage: rbd image-meta get [--pool ] [--image ] + + + Image metadata get the value associated with the key. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta get foo rbd: metadata key was not specified - [1] + + usage: rbd image-meta get [--pool ] [--image ] + + + Image metadata get the value associated with the key. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta set rbd: image name was not specified - [1] + + usage: rbd image-meta set [--pool ] [--image ] + + + Image metadata set key with value. + + Positional arguments + image specification + (example: [/]) + image meta key + image meta value + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta set foo rbd: metadata key was not specified - [1] + + usage: rbd image-meta set [--pool ] [--image ] + + + Image metadata set key with value. + + Positional arguments + image specification + (example: [/]) + image meta key + image meta value + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta set foo key rbd: metadata value was not specified - [1] + + usage: rbd image-meta set [--pool ] [--image ] + + + Image metadata set key with value. + + Positional arguments + image specification + (example: [/]) + image meta key + image meta value + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta remove rbd: image name was not specified - [1] + + usage: rbd image-meta remove [--pool ] [--image ] + + + Image metadata remove the key and value associated. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd image-meta remove foo rbd: metadata key was not specified - [1] + + usage: rbd image-meta remove [--pool ] [--image ] + + + Image metadata remove the key and value associated. + + Positional arguments + image specification + (example: [/]) + image meta key + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd object-map rebuild rbd: image name was not specified - [1] + + usage: rbd object-map rebuild [--pool ] [--image ] + [--snap ] [--no-progress] + + + Rebuild an invalid object map. + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --no-progress disable progress output + + [22] $ rbd snap ls rbd: image name was not specified - [1] + + usage: rbd snap ls [--pool ] [--image ] [--format ] + [--pretty-format] + + + Dump list of image snapshots. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd snap create rbd: image name was not specified - [1] + + usage: rbd snap create [--pool ] [--image ] [--snap ] + + + Create a snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + [22] $ rbd snap create foo rbd: snap name was not specified - [1] + + usage: rbd snap create [--pool ] [--image ] [--snap ] + + + Create a snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + [22] $ rbd snap rollback rbd: image name was not specified - [1] + + usage: rbd snap rollback [--pool ] [--image ] [--snap ] + [--no-progress] + + + Rollback image to snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --no-progress disable progress output + + [22] $ rbd snap rollback foo rbd: snap name was not specified - [1] + + usage: rbd snap rollback [--pool ] [--image ] [--snap ] + [--no-progress] + + + Rollback image to snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --no-progress disable progress output + + [22] $ rbd snap rm rbd: image name was not specified - [1] + + usage: rbd snap remove [--pool ] [--image ] [--snap ] + + + Deletes a snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + [22] $ rbd snap rm foo rbd: snap name was not specified - [1] + + usage: rbd snap remove [--pool ] [--image ] [--snap ] + + + Deletes a snapshot. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + [22] $ rbd snap purge rbd: image name was not specified - [1] + + usage: rbd snap purge [--pool ] [--image ] [--no-progress] + + + Deletes all snapshots. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --no-progress disable progress output + + [22] $ rbd snap protect rbd: image name was not specified - [1] + + usage: rbd snap protect [--pool ] [--image ] [--snap ] + + + Prevent a snapshot from being deleted. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + [22] $ rbd snap protect foo rbd: snap name was not specified - [1] + + usage: rbd snap protect [--pool ] [--image ] [--snap ] + + + Prevent a snapshot from being deleted. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + [22] $ rbd snap unprotect rbd: image name was not specified - [1] + + usage: rbd snap unprotect [--pool ] [--image ] [--snap ] + + + Allow a snapshot to be deleted. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + [22] $ rbd snap unprotect foo rbd: snap name was not specified - [1] + + usage: rbd snap unprotect [--pool ] [--image ] [--snap ] + + + Allow a snapshot to be deleted. + + Positional arguments + snapshot specification + (example: [/]@) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + [22] $ rbd watch rbd: image name was not specified - [1] + + usage: rbd watch [--pool ] [--image ] + + + Watch events on image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd status rbd: image name was not specified - [1] + + usage: rbd status [--pool ] [--image ] [--format ] + [--pretty-format] + + + Show the status of this image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd map rbd: image name was not specified - [1] + + usage: rbd map [--pool ] [--image ] [--snap ] + [--options ] [--read-only] + + + Map image to a block device using the kernel. + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + -o [ --options ] arg mapping options + --read-only mount read-only + + [22] $ rbd unmap rbd: unmap requires either image name or device path - [1] + + usage: rbd unmap [--pool ] [--image ] [--snap ] + + + Unmap a rbd device that was used by the kernel. + + Positional arguments + image, snapshot, or device specification + [/][@] + or + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + + [22] $ rbd feature disable rbd: image name was not specified - [1] + + usage: rbd feature disable [--pool ] [--image ] + [ ...] + + Disable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd feature disable foo rbd: at least one feature name must be specified - [1] + + usage: rbd feature disable [--pool ] [--image ] + [ ...] + + Disable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd feature enable rbd: image name was not specified - [1] + + usage: rbd feature enable [--pool ] [--image ] + [ ...] + + Enable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd feature enable foo rbd: at least one feature name must be specified - [1] + + usage: rbd feature enable [--pool ] [--image ] + [ ...] + + Enable the specified image feature. + + Positional arguments + image specification + (example: [/]) + image features + [layering, striping, exclusive-lock, object-map, + fast-diff, deep-flatten] + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd lock list rbd: image name was not specified - [1] + + usage: rbd lock list [--pool ] [--image ] [--format ] + [--pretty-format] + + + Show locks held on an image. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --format arg output format [plain, json, or xml] + --pretty-format pretty formatting (json and xml) + + [22] $ rbd lock add rbd: image name was not specified - [1] + + usage: rbd lock add [--pool ] [--image ] [--shared ] + + + Take a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --shared arg shared lock tag + + [22] $ rbd lock add foo rbd: lock id was not specified - [1] + + usage: rbd lock add [--pool ] [--image ] [--shared ] + + + Take a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --shared arg shared lock tag + + [22] $ rbd lock remove rbd: image name was not specified - [1] + + usage: rbd lock remove [--pool ] [--image ] + + + Release a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + locker client + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd lock remove foo rbd: lock id was not specified - [1] + + usage: rbd lock remove [--pool ] [--image ] + + + Release a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + locker client + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd lock remove foo id rbd: locker was not specified - [1] + + usage: rbd lock remove [--pool ] [--image ] + + + Release a lock on an image. + + Positional arguments + image specification + (example: [/]) + unique lock id + locker client + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + + [22] $ rbd bench-write rbd: image name was not specified - [1] + + usage: rbd bench-write [--pool ] [--image ] [--io-size ] + [--io-threads ] [--io-total ] + [--io-pattern ] + + + Simple write benchmark. + + Positional arguments + image specification + (example: [/]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --io-size arg write size (in B/K/M/G/T) + --io-threads arg ios in flight + --io-total arg total size to write (in B/K/M/G/T) + --io-pattern arg write pattern (rand or seq) + + [22] -- 2.39.5