3 ======================================================
4 ceph-bluestore-tool -- bluestore administrative tool
5 ======================================================
7 .. program:: ceph-bluestore-tool
12 | **ceph-bluestore-tool** *command*
13 [ --dev *device* ... ]
16 [ --log-file | -l *filename* ]
18 | **ceph-bluestore-tool** fsck|repair --path *osd path* [ --deep ]
19 | **ceph-bluestore-tool** show-label --dev *device* ...
20 | **ceph-bluestore-tool** prime-osd-dir --dev *device* --path *osd path*
21 | **ceph-bluestore-tool** bluefs-export --path *osd path* --out-dir *dir*
22 | **ceph-bluestore-tool** bluefs-export --path *osd path* --out-dir *dir*
28 **ceph-bluestore-tool** is a utility to perform low-level administrative
29 operations on a BlueStore instance.
40 run consistency check on BlueStore metadata. If *--deep* is specified, also read all object data and verify checksums.
44 Run a consistency check *and* repair any errors we can.
46 .. option:: bluefs-export
48 Export the contents of BlueFS (i.e., rocksdb files) to an output directory.
50 .. option:: bluefs-bdev-sizes --path *osd path*
52 Print the device sizes, as understood by BlueFS, to stdout.
54 .. option:: bluefs-bdev-expand --path *osd path*
56 Instruct BlueFS to check the size of its block devices and, if they have expanded, make use of the additional space.
58 .. option:: show-label --dev *device* [...]
65 .. option:: --dev *device*
67 Add *device* to the list of devices to consider
69 .. option:: --path *osd path*
71 Specify an osd path. In most cases, the device list is inferred from the symlinks present in *osd path*. This is usually simpler than explicitly specifying the device(s) with --dev.
73 .. option:: --out-dir *dir*
75 Output directory for bluefs-export
77 .. option:: -l, --log-file *log file*
81 .. option:: --log-level *num*
83 debug log level. Default is 30 (extremely verbose), 20 is very
84 verbose, 10 is verbose, and 1 is not very verbose.
88 deep scrub/repair (read and validate object data, not just metadata)
93 Every BlueStore block device has a single block label at the beginning of the
94 device. You can dump the contents of the label with::
96 ceph-bluestore-tool show-label --dev *device*
98 The main device will have a lot of metadata, including information
99 that used to be stored in small files in the OSD data directory. The
100 auxilliary devices (db and wal) will only have the minimum required
101 fields (OSD UUID, size, device type, birth time).
103 OSD directory priming
104 =====================
106 You can generate the content for an OSD data directory that can start up a
107 BlueStore OSD with the *prime-osd-dir* command::
109 ceph-bluestore-tool prime-osd-dir --dev *main device* --path /var/lib/ceph/osd/ceph-*id*
115 **ceph-bluestore-tool** is part of Ceph, a massively scalable,
116 open-source, distributed storage system. Please refer to the Ceph
117 documentation at http://ceph.com/docs for more information.
123 :doc:`ceph-osd <ceph-osd>`\(8)