Positional arguments:
<command>
- 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.
- deep copy (deep cp) Deep copy src image to dest.
- 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).
- group create Create a group.
- group image add Add an image to a group.
- group image list List images in a group.
- group image remove Remove an image from a group.
- group list (group ls) List rbd groups.
- group remove (group rm) Delete a group.
- group snap create Make a snapshot of a group.
- group snap list List snapshots of a group.
- group snap remove (group snap rm) Remove a snapshot from a group.
- group snap rename Rename group's snapshot.
- image-meta get Image metadata get the value associated
- with the key.
- image-meta list (image-meta ls) Image metadata list keys with values.
- image-meta remove (image-meta rm) 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 RBD 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 purge Remove all expired images from 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.
+ 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.
+ deep copy (deep cp) Deep copy src image to dest.
+ 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).
+ group create Create a group.
+ group image add Add an image to a group.
+ group image list (group image ls) List images in a group.
+ group image remove (group image rm) Remove an image from a group.
+ group list (group ls) List rbd groups.
+ group remove (group rm) Delete a group.
+ group snap create Make a snapshot of a group.
+ group snap list (group snap ls) List snapshots of a group.
+ group snap remove (group snap rm) Remove a snapshot from a group.
+ group snap rename Rename group's snapshot.
+ image-meta get Image metadata get the value associated
+ with the key.
+ image-meta list (image-meta ls) Image metadata list keys with values.
+ image-meta remove (image-meta rm) 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 RBD 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 purge Remove all expired images from 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
{"group", "image", "add"}, {}, "Add an image to a group.",
"", &get_add_arguments, &execute_add);
Shell::Action action_remove_image(
- {"group", "image", "remove"}, {}, "Remove an image from a group.",
- "", &get_remove_image_arguments, &execute_remove_image);
+ {"group", "image", "remove"}, {"group", "image", "rm"},
+ "Remove an image from a group.", "",
+ &get_remove_image_arguments, &execute_remove_image);
Shell::Action action_list_images(
- {"group", "image", "list"}, {}, "List images in a group.",
- "", &get_list_images_arguments, &execute_list_images);
+ {"group", "image", "list"}, {"group", "image", "ls"},
+ "List images in a group.", "",
+ &get_list_images_arguments, &execute_list_images);
Shell::Action action_group_snap_create(
{"group", "snap", "create"}, {}, "Make a snapshot of a group.",
"", &get_group_snap_create_arguments, &execute_group_snap_create);
Shell::Action action_group_snap_remove(
- {"group", "snap", "remove"}, {"group", "snap", "rm"}, "Remove a snapshot from a group.",
+ {"group", "snap", "remove"}, {"group", "snap", "rm"},
+ "Remove a snapshot from a group.",
"", &get_group_snap_remove_arguments, &execute_group_snap_remove);
Shell::Action action_group_snap_rename(
{"group", "snap", "rename"}, {}, "Rename group's snapshot.",
"", &get_group_snap_rename_arguments, &execute_group_snap_rename);
Shell::Action action_group_snap_list(
- {"group", "snap", "list"}, {}, "List snapshots of a group.",
+ {"group", "snap", "list"}, {"group", "snap", "ls"},
+ "List snapshots of a group.",
"", &get_group_snap_list_arguments, &execute_group_snap_list);
} // namespace group
} // namespace action
projects / ceph.git / commitdiff