summaryrefslogtreecommitdiffstats
path: root/doc/man/8/ceph-monstore-tool.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/8/ceph-monstore-tool.rst')
-rw-r--r--doc/man/8/ceph-monstore-tool.rst90
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/man/8/ceph-monstore-tool.rst b/doc/man/8/ceph-monstore-tool.rst
new file mode 100644
index 000000000..9396df0b6
--- /dev/null
+++ b/doc/man/8/ceph-monstore-tool.rst
@@ -0,0 +1,90 @@
+:orphan:
+
+======================================================
+ ceph-monstore-tool -- ceph monstore manipulation tool
+======================================================
+
+.. program:: ceph-monstore-tool
+
+Synopsis
+========
+
+| **ceph-monstore-tool** <store path> <cmd> [args|options]
+
+
+Description
+===========
+
+:program:`ceph-monstore-tool` is used to manipulate MonitorDBStore's data
+(monmap, osdmap, etc.) offline. It is similar to `ceph-kvstore-tool`.
+
+The default RocksDB debug level is `0`. This can be changed using `--debug`.
+
+Note:
+ Ceph-specific options take the format `--option-name=VAL`
+ DO NOT FORGET THE EQUALS SIGN. ('=')
+ Command-specific options must be passed after a `--`
+ for example, `get monmap --debug -- --version 10 --out /tmp/foo`
+
+Commands
+========
+
+:program:`ceph-monstore-tool` uses many commands for debugging purposes:
+
+:command:`store-copy <path>`
+ Copy the store to PATH.
+
+:command:`get monmap [-- options]`
+ Get monmap (version VER if specified) (default: last committed).
+
+:command:`get osdmap [-- options]`
+ Get osdmap (version VER if specified) (default: last committed).
+
+:command:`get msdmap [-- options]`
+ Get msdmap (version VER if specified) (default: last committed).
+
+:command:`get mgr [-- options]`
+ Get mgrmap (version VER if specified) (default: last committed).
+
+:command:`get crushmap [-- options]`
+ Get crushmap (version VER if specified) (default: last committed).
+
+:command:`get osd_snap <key> [-- options]`
+ Get osd_snap key (`purged_snap` or `purged_epoch`).
+
+:command:`dump-keys`
+ Dump store keys to FILE (default: stdout).
+
+:command:`dump-paxos [-- options]`
+ Dump Paxos transactions (-- -- help for more info).
+
+:command:`dump-trace FILE [-- options]`
+ Dump contents of trace file FILE (-- --help for more info).
+
+:command:`replay-trace FILE [-- options]`
+ Replay trace from FILE (-- --help for more info).
+
+:command:`random-gen [-- options]`
+ Add randomly genererated ops to the store (-- --help for more info).
+
+:command:`rewrite-crush [-- options]`
+ Add a rewrite commit to the store
+
+:command:`rebuild`
+ Rebuild store.
+
+:command:`rm <prefix> <key>`
+ Remove specified key from the store.
+
+Availability
+============
+
+**ceph-monstore-tool** is part of Ceph, a massively scalable, open-source,
+distributed storage system. See the Ceph documentation at
+https://docs.ceph.com for more information.
+
+
+See also
+========
+
+:doc:`ceph <ceph>`\(8)