.. TODO rst "option" directive seems to require --foo style options, parsing breaks on subcommands.. the args show up as bold too
-:command:`ls` [*pool-name*]
- Will list all rbd images listed in the rbd_directory object.
+:command:`ls` [-l | --long] [pool-name]
+ Will list all rbd images listed in the rbd_directory object. With
+ -l, also show snapshots, and use longer-format output including
+ size, parent (if clone), format, etc.
:command:`info` [*image-name*]
Will dump information (such as size and order) about a specific rbd image.
-.TH "RBD" "8" "September 27, 2012" "dev" "Ceph"
+.TH "RBD" "8" "October 03, 2012" "dev" "Ceph"
.SH NAME
rbd \- manage rados block device (RBD) images
.
.SH COMMANDS
.INDENT 0.0
.TP
-.B \fBls\fP [\fIpool\-name\fP]
-Will list all rbd images listed in the rbd_directory object.
+.B \fBls\fP [\-l | \-\-long] [pool\-name]
+Will list all rbd images listed in the rbd_directory object. With
+\-l, also show snapshots, and use longer\-format output including
+size, parent (if clone), format, etc.
.TP
.B \fBinfo\fP [\fIimage\-name\fP]
Will dump information (such as size and order) about a specific rbd image.
rbd ls | grep test1
rbd ls | grep test2
rbd ls | wc -l | grep 2
+ # look for fields in output of ls -l without worrying about space
+ rbd ls -l | grep 'test1.*image.*1024 KB.*1'
+ rbd ls -l | grep 'test2.*image.*1024 KB.*1'
rbd rm test1
rbd rm test2
rbd ls | grep test1
rbd ls | grep test2
rbd ls | wc -l | grep 2
+ rbd ls -l | grep 'test1.*image.*1024 KB.*2'
+ rbd ls -l | grep 'test2.*image.*1024 KB.*2'
rbd rm test1
rbd rm test2
rbd ls | grep test1
rbd ls | grep test2
rbd ls | wc -l | grep 2
+ rbd ls -l | grep 'test1.*image.*1024 KB.*2'
+ rbd ls -l | grep 'test2.*image.*1024 KB.*1'
remove_images
}
radosacl_LDADD = librados.la $(PTHREAD_LIBS) -lm $(CRYPTO_LIBS) $(EXTRALIBS)
bin_DEBUGPROGRAMS += scratchtool scratchtoolpp radosacl
-rbd_SOURCES = rbd.cc common/fiemap.cc common/secret.c
+rbd_SOURCES = rbd.cc common/fiemap.cc common/secret.c common/TextTable.cc
rbd_CXXFLAGS = ${AM_CXXFLAGS}
rbd_LDADD = libglobal.la librbd.la librados.la $(PTHREAD_LIBS) -lm -lkeyutils $(CRYPTO_LIBS) $(EXTRALIBS)
if LINUX
#include "global/global_init.h"
#include "common/safe_io.h"
#include "common/secret.h"
+#include "include/stringify.h"
#include "include/rados/librados.hpp"
#include "include/rbd/librbd.hpp"
#include "include/byteorder.h"
#include <sys/ioctl.h>
#include "include/rbd_types.h"
+#include "common/TextTable.h"
#if defined(__linux__)
#include <linux/fs.h>
cout <<
"usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...\n"
"where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:\n"
-" (ls | list) [pool-name] list rbd images\n"
+" (ls | list) [-l | --long ] [pool-name] list rbd images\n"
+" (-l includes snapshots/clones)\n"
" info <image-name> show information about image size,\n"
" striping, etc.\n"
" create [--order <bits>] --size <MB> <name> create an empty image\n"
MyProgressContext(const char *o) : operation(o), last_pc(0) {
}
-
+
int update_progress(uint64_t offset, uint64_t total) {
int pc = total ? (offset * 100ull / total) : 0;
if (pc != last_pc) {
}
};
-static int do_list(librbd::RBD &rbd, librados::IoCtx& io_ctx)
+static int do_list(librbd::RBD &rbd, librados::IoCtx& io_ctx, bool lflag)
{
std::vector<string> names;
int r = rbd.list(io_ctx, names);
- if (r < 0)
+ if (r < 0 || (names.size() == 0))
return r;
- for (std::vector<string>::const_iterator i = names.begin(); i != names.end(); i++)
- cout << *i << std::endl;
+ if (!lflag) {
+ for (std::vector<string>::const_iterator i = names.begin();
+ i != names.end(); ++i) {
+ cout << *i << std::endl;
+ }
+ return 0;
+ }
+
+ TextTable tbl;
+ tbl.define_column("NAME", TextTable::LEFT, TextTable::LEFT);
+ tbl.define_column("TYPE", TextTable::LEFT, TextTable::LEFT);
+ tbl.define_column("SIZE", TextTable::RIGHT, TextTable::RIGHT);
+ tbl.define_column("PARENT", TextTable::LEFT, TextTable::LEFT);
+ tbl.define_column("FORMAT", TextTable::RIGHT, TextTable::RIGHT);
+
+ string pool, image, snap, parent;
+
+ for (std::vector<string>::const_iterator i = names.begin();
+ i != names.end(); ++i) {
+ librbd::image_info_t info;
+ librbd::Image im;
+
+ rbd.open(io_ctx, im, i->c_str());
+
+ // handle second-nth trips through loop
+ parent.clear();
+ r = im.parent_info(&pool, &image, &snap);
+ if (r < 0 && r != -ENOENT)
+ return r;
+
+ if (r != -ENOENT)
+ parent = pool + "/" + image + "@" + snap;
+
+ if (im.stat(info, sizeof(info)) < 0)
+ return -EINVAL;
+
+ uint8_t old_format;
+ im.old_format(&old_format);
+
+ tbl << *i
+ << ((parent.length()) ? "clone" : "image")
+ << stringify(prettybyte_t(info.size))
+ << parent
+ << ((old_format) ? '1' : '2')
+ << TextTable::endrow;
+
+ vector<librbd::snap_info_t> snaplist;
+ if (im.snap_list(snaplist) >= 0 && !snaplist.empty()) {
+ for (std::vector<librbd::snap_info_t>::iterator s = snaplist.begin();
+ s != snaplist.end(); ++s) {
+ parent.clear();
+ im.snap_set(s->name.c_str());
+ if (im.parent_info(&pool, &image, &snap) >= 0) {
+ parent = pool + "/" + image + "@" + snap;
+ }
+ tbl << *i + "@" + s->name
+ << "snap"
+ << stringify(prettybyte_t(s->size))
+ << parent
+ << ((old_format) ? '1' : '2')
+ << TextTable::endrow;
+ }
+ }
+ }
+ cout << tbl;
return 0;
}
int format, uint64_t features)
{
int r;
- if (features == 0)
+ if (features == 0)
features = RBD_FEATURES_ALL;
if (format == 1)
}
static int do_clone(librbd::RBD &rbd, librados::IoCtx &p_ioctx,
- const char *p_name, const char *p_snapname,
+ const char *p_name, const char *p_snapname,
librados::IoCtx &c_ioctx, const char *c_name,
uint64_t features, int *c_order)
{
<< std::endl;
}
- // parent info, if present
+ // parent info, if present
if ((image.parent_info(&parent_pool, &parent_name, &parent_snapname) == 0) &&
parent_name.length() > 0) {
{
std::vector<librbd::snap_info_t> snaps;
int r = image.snap_list(snaps);
- if (r < 0)
+ if (r < 0 || snaps.empty())
return r;
- cout << "ID\tNAME\t\tSIZE" << std::endl;
- for (std::vector<librbd::snap_info_t>::iterator i = snaps.begin(); i != snaps.end(); ++i) {
- cout << i->id << '\t' << i->name << '\t' << i->size << std::endl;
+ TextTable t;
+ t.define_column("SNAPID", TextTable::RIGHT, TextTable::RIGHT);
+ t.define_column("NAME", TextTable::LEFT, TextTable::LEFT);
+ t.define_column("SIZE", TextTable::RIGHT, TextTable::RIGHT);
+
+ for (std::vector<librbd::snap_info_t>::iterator s = snaps.begin();
+ s != snaps.end(); ++s) {
+ t << s->id << s->name << stringify(prettybyte_t(s->size))
+ << TextTable::endrow;
}
+ cout << t;
return 0;
}
extent++;
if (extent == fiemap->fm_mapped_extents)
break;
-
+
} while (end_ofs == (off_t)fiemap->fm_extents[extent].fe_logical);
//cerr << "rbd import file_pos=" << file_pos << " extent_len=" << extent_len << std::endl;
*dest_poolname = NULL, *dest_snapname = NULL, *path = NULL,
*devpath = NULL, *lock_cookie = NULL, *lock_client = NULL,
*lock_tag = NULL;
+ bool lflag = false;
std::string val;
std::ostringstream err;
return EXIT_FAILURE;
}
size = sizell << 20; // bytes to MB
+ } else if (ceph_argparse_flag(args, i, "-l", "--long", (char*)NULL)) {
+ lflag = true;
} else if (ceph_argparse_withint(args, i, &order, &err, "--order", (char*)NULL)) {
if (!err.str().empty()) {
cerr << err.str() << std::endl;
switch (opt_cmd) {
case OPT_LIST:
- r = do_list(rbd, io_ctx);
+ r = do_list(rbd, io_ctx, lflag);
if (r < 0) {
switch (r) {
case -ENOENT:
error: image name was not specified
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: device path was not specified
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
$ rbd --help
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
error: snapname specified for a command that doesn't use it
usage: rbd [-n <auth user>] [OPTIONS] <cmd> ...
where 'pool' is a rados pool name (default is 'rbd') and 'cmd' is one of:
- (ls | list) [pool-name] list rbd images
+ (ls | list) [-l | --long ] [pool-name] list rbd images
+ (-l includes snapshots/clones)
info <image-name> show information about image size,
striping, etc.
create [--order <bits>] --size <MB> <name> create an empty image
projects / ceph.git / commitdiff