X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fceph%2Fsrc%2Ftest%2Fcli%2Frbd%2Fhelp.t;fp=src%2Fceph%2Fsrc%2Ftest%2Fcli%2Frbd%2Fhelp.t;h=0000000000000000000000000000000000000000;hb=7da45d65be36d36b880cc55c5036e96c24b53f00;hp=06cfa294f814be5e4229a0fc64f22ebef87cf01c;hpb=691462d09d0987b47e112d6ee8740375df3c51b2;p=stor4nfv.git diff --git a/src/ceph/src/test/cli/rbd/help.t b/src/ceph/src/test/cli/rbd/help.t deleted file mode 100644 index 06cfa29..0000000 --- a/src/ceph/src/test/cli/rbd/help.t +++ /dev/null @@ -1,1453 +0,0 @@ -Skip test on FreeBSD as it generates different output there. - - $ test "$(uname)" = "FreeBSD" && exit 80 || true - - $ rbd --help - usage: rbd ... - - Command-line interface for managing Ceph RBD images. - - Positional arguments: - - bench Simple 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. - journal client disconnect Flag image journal client as disconnected. - journal export Export image journal. - journal import Import image journal. - journal info Show information about image journal. - journal inspect Inspect image journal for structural errors. - journal reset Reset image journal. - journal status Show status of image journal. - list (ls) List rbd images. - lock add Take a lock on an image. - lock list (lock ls) 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. - mirror image demote Demote an image to non-primary for RBD - mirroring. - mirror image disable Disable RBD mirroring for an image. - mirror image enable Enable RBD mirroring for an image. - mirror image promote Promote an image to primary for RBD mirroring. - mirror image resync Force resync to primary image for RBD mirroring. - mirror image status Show RDB mirroring status for an image. - mirror pool demote Demote all primary images in the pool. - mirror pool disable Disable RBD mirroring by default within a pool. - mirror pool enable Enable RBD mirroring by default within a pool. - mirror pool info Show information about the pool mirroring - configuration. - mirror pool peer add Add a mirroring peer to a pool. - mirror pool peer remove Remove a mirroring peer from a pool. - mirror pool peer set Update mirroring peer settings. - mirror pool promote Promote all non-primary images in the pool. - mirror pool status Show status for all mirrored images in the pool. - nbd list (nbd ls) List the nbd devices already used. - nbd map Map image to a nbd device. - nbd unmap Unmap a nbd device. - object-map check Verify the object map is correct. - object-map rebuild Rebuild an invalid object map. - pool init Initialize pool for use by RBD. - 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 (snap add) Create a snapshot. - snap limit clear Remove snapshot limit. - snap limit set Limit the number of snapshots. - snap list (snap ls) Dump list of image snapshots. - snap protect Prevent a snapshot from being deleted. - snap purge Delete all snapshots. - snap remove (snap rm) Delete a snapshot. - snap rename Rename a snapshot. - snap rollback (snap revert) Rollback image to snapshot. - snap unprotect Allow a snapshot to be deleted. - status Show the status of this image. - trash list (trash ls) List trash images. - trash move (trash mv) Move an image to the trash. - trash remove (trash rm) Remove an image from trash. - trash restore Restore an image from trash. - 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 - --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 - - See 'rbd help ' 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 - rbd help bench - usage: rbd bench [--pool ] [--image ] [--io-size ] - [--io-threads ] [--io-total ] - [--io-pattern ] --io-type - - - Simple benchmark. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --io-size arg IO size (in B/K/M/G/T) [default: 4K] - --io-threads arg ios in flight [default: 16] - --io-total arg total size for IO (in B/K/M/G/T) [default: 1G] - --io-pattern arg IO pattern (rand or seq) [default: seq] - --io-type arg IO type (read or write) - - 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) [default: plain] - --pretty-format pretty formatting (json and xml) - - rbd help clone - usage: rbd clone [--pool ] [--image ] [--snap ] - [--dest-pool ] [--dest ] [--order ] - [--object-size ] - [--image-feature ] [--image-shared] - [--stripe-unit ] [--stripe-count ] - [--data-pool ] - [--journal-splay-width ] - [--journal-object-size ] - [--journal-pool ] - - - 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] - --object-size arg object size in B/K/M [4K <= object size <= 32M] - --image-feature arg image features - [layering(+), striping, exclusive-lock(+*), - object-map(+*), fast-diff(+*), deep-flatten(+-), - journaling(*), data-pool] - --image-shared shared image - --stripe-unit arg stripe unit in B/K/M - --stripe-count arg stripe count - --data-pool arg data pool - --journal-splay-width arg number of active journal objects - --journal-object-size arg size of journal objects - --journal-pool arg pool for journal objects - - Image Features: - (*) supports enabling/disabling on existing images - (-) supports disabling-only 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 ] [--order ] - [--object-size ] - [--image-feature ] [--image-shared] - [--stripe-unit ] [--stripe-count ] - [--data-pool ] - [--journal-splay-width ] - [--journal-object-size ] - [--journal-pool ] [--sparse-size ] - [--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 - --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(+), striping, exclusive-lock(+*), - object-map(+*), fast-diff(+*), deep-flatten(+-), - journaling(*), data-pool] - --image-shared shared image - --stripe-unit arg stripe unit in B/K/M - --stripe-count arg stripe count - --data-pool arg data pool - --journal-splay-width arg number of active journal objects - --journal-object-size arg size of journal objects - --journal-pool arg pool for journal objects - --sparse-size arg sparse size in B/K/M [default: 4K] - --no-progress disable progress output - - Image Features: - (*) supports enabling/disabling on existing images - (-) supports disabling-only on existing images - (+) enabled by default for new images if features not specified - - rbd help create - usage: rbd create [--pool ] [--image ] - [--image-format ] [--new-format] - [--order ] [--object-size ] - [--image-feature ] [--image-shared] - [--stripe-unit ] - [--stripe-count ] [--data-pool ] - [--journal-splay-width ] - [--journal-object-size ] - [--journal-pool ] --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 (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(+), striping, exclusive-lock(+*), - object-map(+*), fast-diff(+*), deep-flatten(+-), - journaling(*), data-pool] - --image-shared shared image - --stripe-unit arg stripe unit in B/K/M - --stripe-count arg stripe count - --data-pool arg data pool - --journal-splay-width arg number of active journal objects - --journal-object-size arg size of journal objects - --journal-pool arg pool for journal objects - -s [ --size ] arg image size (in M/G/T) [default: M] - - Image Features: - (*) supports enabling/disabling on existing images - (-) supports disabling-only 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) [default: plain] - --pretty-format pretty formatting (json and xml) - - rbd help disk-usage - usage: rbd disk-usage [--pool ] [--image ] [--snap ] - [--format ] [--pretty-format] - [--from-snap ] - - - 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) [default: plain] - --pretty-format pretty formatting (json and xml) - --from-snap arg snapshot starting point - - rbd help export - usage: rbd export [--pool ] [--image ] [--snap ] - [--path ] [--no-progress] - [--export-format ] - - - 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 - --export-format arg format of image file - - 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, journaling, data-pool] - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - - rbd help feature enable - usage: rbd feature enable [--pool ] [--image ] - [--journal-splay-width ] - [--journal-object-size ] - [--journal-pool ] - [ ...] - - Enable the specified image feature. - - Positional arguments - image specification - (example: [/]) - image features - [layering, striping, exclusive-lock, object-map, - fast-diff, deep-flatten, journaling, data-pool] - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --journal-splay-width arg number of active journal objects - --journal-object-size arg size of journal objects - --journal-pool arg pool for journal objects - - 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) [default: plain] - --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 ] [--object-size ] - [--image-feature ] [--image-shared] - [--stripe-unit ] - [--stripe-count ] [--data-pool ] - [--journal-splay-width ] - [--journal-object-size ] - [--journal-pool ] - [--sparse-size ] [--no-progress] - [--export-format ] [--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 (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(+), striping, exclusive-lock(+*), - object-map(+*), fast-diff(+*), deep-flatten(+-), - journaling(*), data-pool] - --image-shared shared image - --stripe-unit arg stripe unit in B/K/M - --stripe-count arg stripe count - --data-pool arg data pool - --journal-splay-width arg number of active journal objects - --journal-object-size arg size of journal objects - --journal-pool arg pool for journal objects - --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 - (-) supports disabling-only on existing images - (+) enabled by default for new images if features not specified - - rbd help import-diff - usage: rbd import-diff [--path ] [--pool ] [--image ] - [--sparse-size ] [--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 - --sparse-size arg sparse size in B/K/M [default: 4K] - --no-progress disable progress output - - rbd help info - usage: rbd info [--pool ] [--image ] [--snap ] - [--image-id ] [--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 - --image-id arg image id - --format arg output format (plain, json, or xml) [default: plain] - --pretty-format pretty formatting (json and xml) - - rbd help journal client disconnect - usage: rbd journal client disconnect [--pool ] [--image ] - [--journal ] - [--client-id ] - - - Flag image journal client as disconnected. - - Positional arguments - journal specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --journal arg journal name - --client-id arg client ID (or leave unspecified to disconnect all) - - rbd help journal export - usage: rbd journal export [--pool ] [--image ] - [--journal ] [--path ] [--verbose] - [--no-error] - - - Export image journal. - - Positional arguments - source journal specification - (example: [/]) - export file (or '-' for stdout) - - Optional arguments - -p [ --pool ] arg source pool name - --image arg source image name - --journal arg source journal name - --path arg export file (or '-' for stdout) - --verbose be verbose - --no-error continue after error - - rbd help journal import - usage: rbd journal import [--path ] [--dest-pool ] - [--dest ] [--dest-journal ] - [--verbose] [--no-error] - - - Import image journal. - - Positional arguments - import file (or '-' for stdin) - destination journal specification - (example: [/]) - - Optional arguments - --path arg import file (or '-' for stdin) - --dest-pool arg destination pool name - --dest arg destination image name - --dest-journal arg destination journal name - --verbose be verbose - --no-error continue after error - - rbd help journal info - usage: rbd journal info [--pool ] [--image ] - [--journal ] [--format ] - [--pretty-format] - - - Show information about image journal. - - Positional arguments - journal specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --journal arg journal name - --format arg output format (plain, json, or xml) [default: plain] - --pretty-format pretty formatting (json and xml) - - rbd help journal inspect - usage: rbd journal inspect [--pool ] [--image ] - [--journal ] [--verbose] - - - Inspect image journal for structural errors. - - Positional arguments - journal specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --journal arg journal name - --verbose be verbose - - rbd help journal reset - usage: rbd journal reset [--pool ] [--image ] - [--journal ] - - - Reset image journal. - - Positional arguments - journal specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --journal arg journal name - - rbd help journal status - usage: rbd journal status [--pool ] [--image ] - [--journal ] [--format ] - [--pretty-format] - - - Show status of image journal. - - Positional arguments - journal specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --journal arg journal name - --format arg output format (plain, json, or xml) [default: plain] - --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) [default: plain] - --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) [default: plain] - --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] [--exclusive] - - - 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 map options - --read-only map read-only - --exclusive disable automatic exclusive lock transitions - - 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 mirror image demote - usage: rbd mirror image demote [--pool ] [--image ] - - - Demote an image to non-primary for RBD mirroring. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - - rbd help mirror image disable - usage: rbd mirror image disable [--force] [--pool ] [--image ] - - - Disable RBD mirroring for an image. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - --force disable even if not primary - -p [ --pool ] arg pool name - --image arg image name - - rbd help mirror image enable - usage: rbd mirror image enable [--pool ] [--image ] - - - Enable RBD mirroring for an image. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - - rbd help mirror image promote - usage: rbd mirror image promote [--force] [--pool ] [--image ] - - - Promote an image to primary for RBD mirroring. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - --force promote even if not cleanly demoted by remote cluster - -p [ --pool ] arg pool name - --image arg image name - - rbd help mirror image resync - usage: rbd mirror image resync [--pool ] [--image ] - - - Force resync to primary image for RBD mirroring. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - - rbd help mirror image status - usage: rbd mirror image status [--pool ] [--image ] - [--format ] [--pretty-format] - - - Show RDB mirroring status for 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) [default: plain] - --pretty-format pretty formatting (json and xml) - - rbd help mirror pool demote - usage: rbd mirror pool demote [--pool ] - - - Demote all primary images in the pool. - - Positional arguments - pool name - - Optional arguments - -p [ --pool ] arg pool name - - rbd help mirror pool disable - usage: rbd mirror pool disable [--pool ] - - - Disable RBD mirroring by default within a pool. - - Positional arguments - pool name - - Optional arguments - -p [ --pool ] arg pool name - - rbd help mirror pool enable - usage: rbd mirror pool enable [--pool ] - - - Enable RBD mirroring by default within a pool. - - Positional arguments - pool name - mirror mode [image or pool] - - Optional arguments - -p [ --pool ] arg pool name - - rbd help mirror pool info - usage: rbd mirror pool info [--pool ] [--format ] - [--pretty-format] - - - Show information about the pool mirroring configuration. - - Positional arguments - pool name - - Optional arguments - -p [ --pool ] arg pool name - --format arg output format (plain, json, or xml) [default: plain] - --pretty-format pretty formatting (json and xml) - - rbd help mirror pool peer add - usage: rbd mirror pool peer add [--pool ] - [--remote-client-name ] - [--remote-cluster ] - - - Add a mirroring peer to a pool. - - Positional arguments - pool name - remote cluster spec - (example: [@] - - Optional arguments - -p [ --pool ] arg pool name - --remote-client-name arg remote client name - --remote-cluster arg remote cluster name - - rbd help mirror pool peer remove - usage: rbd mirror pool peer remove [--pool ] - - - Remove a mirroring peer from a pool. - - Positional arguments - pool name - peer uuid - - Optional arguments - -p [ --pool ] arg pool name - - rbd help mirror pool peer set - usage: rbd mirror pool peer set [--pool ] - - - Update mirroring peer settings. - - Positional arguments - pool name - peer uuid - peer parameter [client or cluster] - new client or cluster name - - Optional arguments - -p [ --pool ] arg pool name - - rbd help mirror pool promote - usage: rbd mirror pool promote [--force] [--pool ] - - - Promote all non-primary images in the pool. - - Positional arguments - pool name - - Optional arguments - --force promote even if not cleanly demoted by remote cluster - -p [ --pool ] arg pool name - - rbd help mirror pool status - usage: rbd mirror pool status [--pool ] [--format ] - [--pretty-format] [--verbose] - - - Show status for all mirrored images in the pool. - - Positional arguments - pool name - - Optional arguments - -p [ --pool ] arg pool name - --format arg output format (plain, json, or xml) [default: plain] - --pretty-format pretty formatting (json and xml) - --verbose be verbose - - rbd help nbd list - usage: rbd nbd list - - List the nbd devices already used. - - rbd help nbd map - usage: rbd nbd map [--pool ] [--image ] [--snap ] - [--read-only] [--exclusive] [--device ] - [--nbds_max ] [--max_part ] - - - Map image to a nbd device. - - Positional arguments - image or snapshot specification - (example: [/][@]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --snap arg snapshot name - --read-only map read-only - --exclusive forbid writes by other clients - --device arg specify nbd device - --nbds_max arg override module param nbds_max - --max_part arg override module param max_part - - rbd help nbd unmap - usage: rbd nbd unmap - - - Unmap a nbd device. - - Positional arguments - specify nbd device - - rbd help object-map check - usage: rbd object-map check [--pool ] [--image ] [--snap ] - [--no-progress] - - - Verify the object map is correct. - - 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 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 pool init - usage: rbd pool init [--pool ] [--force] - - - Initialize pool for use by RBD. - - Positional arguments - pool name - - Optional arguments - -p [ --pool ] arg pool name - --force force initialize pool for RBD use if registered by - another application - - 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) [default: M] - --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) [default: plain] - --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 limit clear - usage: rbd snap limit clear [--pool ] [--image ] - - - Remove snapshot limit. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - - rbd help snap limit set - usage: rbd snap limit set [--pool ] [--image ] [--limit ] - - - Limit the number of snapshots. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --limit arg maximum allowed snapshot count - - rbd help snap list - usage: rbd snap list [--pool ] [--image ] [--image-id ] - [--format ] [--pretty-format] - - - Dump list of image snapshots. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --image-id arg image id - --format arg output format (plain, json, or xml) [default: plain] - --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 ] - [--image-id ] [--no-progress] - - - Delete all snapshots. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --image-id arg image id - --no-progress disable progress output - - rbd help snap remove - usage: rbd snap remove [--pool ] [--image ] [--snap ] - [--no-progress] [--image-id ] [--force] - - - Delete a 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 - --image-id arg image id - --force flatten children and unprotect snapshot if needed. - - rbd help snap rename - usage: rbd snap rename [--pool ] [--image ] [--snap ] - [--dest-pool ] [--dest ] - [--dest-snap ] - - - Rename a snapshot. - - Positional arguments - source snapshot specification - (example: [/]@) - destination snapshot 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 - --dest-snap arg destination 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 ] - [--image-id ] - - - 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 - --image-id arg image id - - 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) [default: plain] - --pretty-format pretty formatting (json and xml) - - rbd help trash list - usage: rbd trash list [--pool ] [--all] [--long] [--format ] - [--pretty-format] - - - List trash images. - - Positional arguments - pool name - - Optional arguments - -p [ --pool ] arg pool name - -a [ --all ] list images from all sources - -l [ --long ] long listing format - --format arg output format (plain, json, or xml) [default: plain] - --pretty-format pretty formatting (json and xml) - - rbd help trash move - usage: rbd trash move [--pool ] [--image ] [--delay ] - - - Move an image to the trash. - - Positional arguments - image specification - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image arg image name - --delay arg time delay in seconds until effectively remove the image - - rbd help trash remove - usage: rbd trash remove [--pool ] [--image-id ] - [--no-progress] [--force] - - - Remove an image from trash. - - Positional arguments - image id - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image-id arg image id - --no-progress disable progress output - --force force remove of non-expired delayed images - - rbd help trash restore - usage: rbd trash restore [--pool ] [--image-id ] - [--image ] - - - Restore an image from trash. - - Positional arguments - image id - (example: [/]) - - Optional arguments - -p [ --pool ] arg pool name - --image-id arg image id - --image arg image name - - rbd help unmap - usage: rbd unmap [--pool ] [--image ] [--snap ] - [--options ] - - - 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 - -o [ --options ] arg unmap options - - 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 -