From: David Zafman Date: Thu, 12 Mar 2015 18:39:52 +0000 (-0700) Subject: doc: Fix ceph command manpage to match ceph -h (firefly) X-Git-Tag: v0.87.2~41^2~2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=15e1c6fb3a0e2e191025f96df33feaf115c1411d;p=ceph.git doc: Fix ceph command manpage to match ceph -h (firefly) Improve synopsis section Fixes: #10676 Signed-off-by: David Zafman (cherry picked from commit 9ac488c1eb0e30511079ba05aaf11c79615b3940) Conflicts: man/ceph.8 (took incoming version) --- diff --git a/doc/man/8/ceph.rst b/doc/man/8/ceph.rst index 73cb10f5aa869..ed7de18979333 100644 --- a/doc/man/8/ceph.rst +++ b/doc/man/8/ceph.rst @@ -7,31 +7,54 @@ Synopsis ======== -| **ceph** **auth** *add* ** {** [**...]} +| **ceph** **auth** [ *add* \| *caps* \| *del* \| *export* \| *get* \| *get-key* \| *get-or-create* \| *get-or-create-key* \| *import* \| *list* \| *print-key* \| *print_key* ] ... -| **ceph** **auth** *export* ** +| **ceph** **compact** -| **ceph** **config-key** *get* ** +| **ceph** **config-key** [ *del* | *exists* | *get* | *list* | *put* ] ... -| **ceph** **mds** *add_data_pool* ** +| **ceph** **df** *{detail}* -| **ceph** **mds** *getmap* {**} +| **ceph** **fsid** -| **ceph** **mon** *add* ** <*IPaddr[:port]*> +| **ceph** **health** *{detail}* + +| **ceph** **heap** [ *dump* \| *start_profiler* \| *stop_profiler* \| *release* \| *stats* ] ... + +| **ceph** **injectargs** ** [ **... ] + +| **ceph** **log** ** [ **... ] + +| **ceph** **mds** [ *add_data_pool* \| *cluster_down* \| *cluster_up* \| *compat* \| *deactivate* \| *dump* \| *fail* \| *getmap* \| *newfs* \| *remove_data_pool* \| *rm* \| *rmfailed* \| *set* \| *set_max_mds* \| *set_state* \| *setmap* \| *stat* \| *stop* \| *tell* ] ... + +| **ceph** **mon** [ *add* \| *dump* \| *getmap* \| *remove* \| *stat* ] ... | **ceph** **mon_status** -| **ceph** **osd** *create* {**} +| **ceph** **osd** [ *blacklist* \| *create* \| *deep-scrub* \| *down* \| *dump* \| *erasure-code-profile* \| *find* \| *getcrushmap* \| *getmap* \| *getmaxosd* \| *in* \| *lost* \| *ls* \| *lspools* \| *map* \| *metadata* \| *out* \| *pause* \| *perf* \| *primary-affinity* \| *primary-temp* \| *repair* \| *reweight* \| *reweight-by-utilization* \| *rm* \| *scrub* \| *set* \| *setcrushmap* \| *setmaxosd* \| *stat* \| *thrash* \| *tree* \| *unpause* \| *unset* ] ... + +| **ceph** **osd** **crush** [ *add* \| *add-bucket* \| *create-or-move* \| *dump* \| *get-tunable* \| *link* \| *move* \| *remove* \| *reweight* \| *reweight-all* \| *rm* \| *rule* \| *set* \| *set-tunable* \| *show-tunables* \| *tunables* \| *unlink* ] ... -| **ceph** **osd** **crush** *add* ** -** ** [**...] +| **ceph** **osd** **pool** [ *create* \| *delete* \| *get* \| *get-quota* \| *mksnap* \| *rename* \| *rmsnap* \| *set* \| *set-quota* \| *stats* ] ... -| **ceph** **pg** *force_create_pg* ** +| **ceph** **osd** **tier** [ *add* \| *add-cache* \| *cache-mode* \| *remove* \| *remove-overlay* \| *set-overlay* ] ... -| **ceph** **pg** *stat* +| **ceph** **pg** [ *debug* \| *deep-scrub* \| *dump* \| *dump_json* \| *dump_pools_json* \| *dump_stuck* \| *force_create_pg* \| *getmap* \| *map* \| *repair* \| *scrub* \| *send_pg_creates* \| *set_full_ratio* \| *set_nearfull_ratio* \| *stat* ] ... + +| **ceph** **quorum** [ *enter* \| *exit* ] | **ceph** **quorum_status** +| **ceph** **report** { ** [ *...* ] } + +| **ceph** **scrub** + +| **ceph** **status** + +| **ceph** **sync** **force** {--yes-i-really-mean-it} {--i-know-what-i-am-doing} + +| **ceph** **tell** * [...]* + Description =========== @@ -144,23 +167,23 @@ config-key Manage configuration key. It uses some additional subcommands. -Subcommand ``get`` gets the configuration key. +Subcommand ``del`` deletes configuration key. Usage:: - ceph config-key get + ceph config-key del -Subcommand ``put`` puts configuration key and values. +Subcommand ``exists`` checks for configuration keys existence. Usage:: - ceph config-key put {} + ceph config-key exists -Subcommand ``exists`` checks for configuration keys existence. +Subcommand ``get`` gets the configuration key. Usage:: - ceph config-key exists + ceph config-key get Subcommand ``list`` lists configuration keys. @@ -168,11 +191,11 @@ Usage:: ceph config-key list -Subcommand ``del`` deletes configuration key. +Subcommand ``put`` puts configuration key and values. Usage:: - ceph config-key del + ceph config-key put {} df @@ -182,7 +205,7 @@ Show cluster's free space status. Usage:: - ceph df + ceph df {detail} fsid @@ -202,7 +225,7 @@ Show cluster's health. Usage:: - ceph health + ceph health {detail} heap @@ -328,6 +351,12 @@ Usage:: ceph mds rmfailed +Subcommand ``set`` set mds parameter to + +Usage:: + + ceph mds set max_mds|max_file_size|allow_new_snaps|inline_data {} + Subcommand ``set_max_mds`` sets max MDS index. Usage:: @@ -400,7 +429,10 @@ Usage:: ceph mon stat -Subcommand ``mon_status`` reports status of monitors. +mon_status +---------- + +Reports status of monitors. Usage:: @@ -412,6 +444,28 @@ osd Manage OSD configuration and administration. It uses some additional subcommands. +Subcommand ``blacklist`` manage blacklisted clients. It uses some additional +subcommands. + +Subcommand ``add`` add to blacklist (optionally until seconds +from now) + +Usage:: + + ceph osd blacklist add {} + +Subcommand ``ls`` show blacklisted clients + +Usage:: + + ceph osd blacklist ls + +Subcommand ``rm`` remove from blacklist + +Usage:: + + ceph osd blacklist rm + Subcommand ``create`` creates new osd (with optional UUID). Usage:: @@ -449,6 +503,12 @@ Usage:: ceph osd crush dump +Subcommand ``get-tunable`` get crush tunable straw_calc_version + +Usage:: + + ceph osd crush get-tunable straw_calc_version + Subcommand ``link`` links existing entry for under location . Usage:: @@ -474,6 +534,13 @@ Usage:: ceph osd crush reweight +Subcommand ``reweight-all`` recalculate the weights for the tree to +ensure they sum correctly + +Usage:: + + ceph osd crush reweight-all + Subcommand ``rm`` removes from crush map (everywhere, or just at ). @@ -523,7 +590,7 @@ Usage:: ceph osd crush rule rm -Subcommand ``set`` sets crush map from input file. +Subcommand ``set`` used alone, sets crush map from input file. Usage:: @@ -536,6 +603,13 @@ Usage:: ceph osd crush set [...] +Subcommand ``set-tunable`` set crush tunable to . The only +tunable that can be set is straw_calc_version. + +Usage:: + + ceph osd crush set-tunable straw_calc_version + Subcommand ``show-tunables`` shows current crush tunables. Usage:: @@ -708,7 +782,7 @@ Subcommand ``get`` gets pool parameter . Usage:: ceph osd pool get size|min_size|crash_replay_interval|pg_num| - pgp_num|crush_ruleset|hit_set_type|hit_set_period|hit_set_count|hit_set_fpp| + pgp_num|crush_ruleset|hit_set_type|hit_set_period|hit_set_count|hit_set_fpp ceph osd pool get auid|target_max_objects|target_max_bytes @@ -746,7 +820,7 @@ Subcommand ``set`` sets pool parameter to . Usage:: ceph osd pool set size|min_size|crash_replay_interval|pg_num| - pgp_num|crush_ruleset|hashpspool|hit_set_type|hit_set_period| + pgp_num|crush_ruleset|hashpspool|hit_set_type|hit_set_period ceph osd pool set hit_set_count|hit_set_fpp|debug_fake_ec_pool @@ -754,10 +828,9 @@ Usage:: ceph osd pool set cache_target_dirty_ratio|cache_target_full_ratio - ceph osd pool set cache_min_flush_age + ceph osd pool set cache_min_flush_age|cache_min_evict_age - ceph osd pool set cache_min_evict_age|auid - {--yes-i-really-mean-it} + ceph osd pool set auid {--yes-i-really-mean-it} Subcommand ``set-quota`` sets object or byte limit on pool. @@ -933,16 +1006,13 @@ with plain). Usage:: - ceph pg dump {all|summary|sum|delta|pools|osds|pgs|pgs_brief} - - ceph pg dump {all|summary|sum|delta|pools|osds|pgs|pgs_brief...} + ceph pg dump {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]} Subcommand ``dump_json`` shows human-readable version of pg map in json only. Usage:: - ceph pg dump_json {all|summary|sum|pools|osds|pgs[all|summary|sum|pools| - osds|pgs...]} + ceph pg dump_json {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]} Subcommand ``dump_pools_json`` shows pg pools info in json only. @@ -954,8 +1024,7 @@ Subcommand ``dump_stuck`` shows information about stuck pgs. Usage:: - ceph pg dump_stuck {inactive|unclean|stale[inactive|unclean|stale...]} - {} + ceph pg dump_stuck {inactive|unclean|stale [inactive|unclean|stale...]} {} Subcommand ``force_create_pg`` forces creation of pg . diff --git a/man/ceph.8 b/man/ceph.8 index 9bb903c07c0b5..27396d35648c3 100644 --- a/man/ceph.8 +++ b/man/ceph.8 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "CEPH" "8" "January 12, 2014" "dev" "Ceph" +.TH "CEPH" "8" "March 12, 2015" "dev" "Ceph" .SH NAME -ceph \- ceph file system control utility +ceph \- ceph administration tool . .nr rst2man-indent-level 0 . @@ -59,103 +59,2466 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .SH SYNOPSIS .nf -\fBceph\fP [ \-m \fImonaddr\fP ] [ \-w | \fIcommand\fP ... ] +\fBceph\fP \fBauth\fP [ \fIadd\fP | \fIcaps\fP | \fIdel\fP | \fIexport\fP | \fIget\fP | \fIget\-key\fP | \fIget\-or\-create\fP | \fIget\-or\-create\-key\fP | \fIimport\fP | \fIlist\fP | \fIprint\-key\fP | \fIprint_key\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBcompact\fP +.fi +.sp +.nf +\fBceph\fP \fBconfig\-key\fP [ \fIdel\fP | \fIexists\fP | \fIget\fP | \fIlist\fP | \fIput\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBdf\fP \fI{detail}\fP +.fi +.sp +.nf +\fBceph\fP \fBfsid\fP +.fi +.sp +.nf +\fBceph\fP \fBhealth\fP \fI{detail}\fP +.fi +.sp +.nf +\fBceph\fP \fBheap\fP [ \fIdump\fP | \fIstart_profiler\fP | \fIstop_profiler\fP | \fIrelease\fP | \fIstats\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBinjectargs\fP \fI\fP [ \fI\fP\&... ] +.fi +.sp +.nf +\fBceph\fP \fBlog\fP \fI\fP [ \fI\fP\&... ] +.fi +.sp +.nf +\fBceph\fP \fBmds\fP [ \fIadd_data_pool\fP | \fIcluster_down\fP | \fIcluster_up\fP | \fIcompat\fP | \fIdeactivate\fP | \fIdump\fP | \fIfail\fP | \fIgetmap\fP | \fInewfs\fP | \fIremove_data_pool\fP | \fIrm\fP | \fIrmfailed\fP | \fIset\fP | \fIset_max_mds\fP | \fIset_state\fP | \fIsetmap\fP | \fIstat\fP | \fIstop\fP | \fItell\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBmon\fP [ \fIadd\fP | \fIdump\fP | \fIgetmap\fP | \fIremove\fP | \fIstat\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBmon_status\fP +.fi +.sp +.nf +\fBceph\fP \fBosd\fP [ \fIblacklist\fP | \fIcreate\fP | \fIdeep\-scrub\fP | \fIdown\fP | \fIdump\fP | \fIerasure\-code\-profile\fP | \fIfind\fP | \fIgetcrushmap\fP | \fIgetmap\fP | \fIgetmaxosd\fP | \fIin\fP | \fIlost\fP | \fIls\fP | \fIlspools\fP | \fImap\fP | \fImetadata\fP | \fIout\fP | \fIpause\fP | \fIperf\fP | \fIprimary\-affinity\fP | \fIprimary\-temp\fP | \fIrepair\fP | \fIreweight\fP | \fIreweight\-by\-utilization\fP | \fIrm\fP | \fIscrub\fP | \fIset\fP | \fIsetcrushmap\fP | \fIsetmaxosd\fP | \fIstat\fP | \fIthrash\fP | \fItree\fP | \fIunpause\fP | \fIunset\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBosd\fP \fBcrush\fP [ \fIadd\fP | \fIadd\-bucket\fP | \fIcreate\-or\-move\fP | \fIdump\fP | \fIget\-tunable\fP | \fIlink\fP | \fImove\fP | \fIremove\fP | \fIreweight\fP | \fIreweight\-all\fP | \fIrm\fP | \fIrule\fP | \fIset\fP | \fIset\-tunable\fP | \fIshow\-tunables\fP | \fItunables\fP | \fIunlink\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBosd\fP \fBpool\fP [ \fIcreate\fP | \fIdelete\fP | \fIget\fP | \fIget\-quota\fP | \fImksnap\fP | \fIrename\fP | \fIrmsnap\fP | \fIset\fP | \fIset\-quota\fP | \fIstats\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBosd\fP \fBtier\fP [ \fIadd\fP | \fIadd\-cache\fP | \fIcache\-mode\fP | \fIremove\fP | \fIremove\-overlay\fP | \fIset\-overlay\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBpg\fP [ \fIdebug\fP | \fIdeep\-scrub\fP | \fIdump\fP | \fIdump_json\fP | \fIdump_pools_json\fP | \fIdump_stuck\fP | \fIforce_create_pg\fP | \fIgetmap\fP | \fImap\fP | \fIrepair\fP | \fIscrub\fP | \fIsend_pg_creates\fP | \fIset_full_ratio\fP | \fIset_nearfull_ratio\fP | \fIstat\fP ] ... +.fi +.sp +.nf +\fBceph\fP \fBquorum\fP [ \fIenter\fP | \fIexit\fP ] +.fi +.sp +.nf +\fBceph\fP \fBquorum_status\fP +.fi +.sp +.nf +\fBceph\fP \fBreport\fP { \fI\fP [ \fI...\fP ] } +.fi +.sp +.nf +\fBceph\fP \fBscrub\fP +.fi +.sp +.nf +\fBceph\fP \fBstatus\fP +.fi +.sp +.nf +\fBceph\fP \fBsync\fP \fBforce\fP {\-\-yes\-i\-really\-mean\-it} {\-\-i\-know\-what\-i\-am\-doing} +.fi +.sp +.nf +\fBceph\fP \fBtell\fP \fI [...]\fP .fi .sp .SH DESCRIPTION .sp -\fBceph\fP is a control utility for communicating with the monitor -cluster of a running Ceph distributed storage system. +\fBceph\fP is a control utility which is used for manual deployment and maintenance +of a Ceph cluster. It provides a diverse set of commands that allows deployment of +monitors, OSDs, placement groups, MDS and overall maintenance, administration +of the cluster. +.SH COMMANDS +.SS auth .sp -There are three basic modes of operation. -.SS Interactive mode +Manage authentication keys. It is used for adding, removing, exporting +or updating of authentication keys for a particular entity such as a monitor or +OSD. It uses some additional subcommands. .sp -To start in interactive mode, no arguments are necessary. Control\-d or -\(aqquit\(aq will exit. -.SS Watch mode +Subcommand \fBadd\fP adds authentication info for a particular entity from input +file, or random key if no input given and/or any caps specified in the command. .sp -Watch mode shows cluster state changes as they occur. For example: +Usage: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -ceph \-w +ceph auth add { [...]} .ft P .fi .UNINDENT .UNINDENT -.SS Command line mode .sp -Finally, to send a single instruction to the monitor cluster (and wait -for a response), the command can be specified on the command line. -.SH OPTIONS +Subcommand \fBcaps\fP updates caps for \fBname\fP from caps specified in the command. +.sp +Usage: .INDENT 0.0 -.TP -.B \-i infile -will specify an input file to be passed along as a payload with the -command to the monitor cluster. This is only used for specific -monitor commands. +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth caps [...] +.ft P +.fi .UNINDENT +.UNINDENT +.sp +Subcommand \fBdel\fP deletes all caps for \fBname\fP\&. +.sp +Usage: .INDENT 0.0 -.TP -.B \-o outfile -will write any payload returned by the monitor cluster with its -reply to outfile. Only specific monitor commands (e.g. osd getmap) -return a payload. +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth del +.ft P +.fi .UNINDENT +.UNINDENT +.sp +Subcommand \fBexport\fP writes keyring for requested entity, or master keyring if +none given. +.sp +Usage: .INDENT 0.0 -.TP -.B \-c ceph.conf, \-\-conf=ceph.conf -Use ceph.conf configuration file instead of the default -/etc/ceph/ceph.conf to determine monitor addresses during startup. +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth export {} +.ft P +.fi .UNINDENT +.UNINDENT +.sp +Subcommand \fBget\fP writes keyring file with requested key. +.sp +Usage: .INDENT 0.0 -.TP -.B \-m monaddress[:port] -Connect to specified monitor (instead of looking through ceph.conf). +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth get +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBget\-key\fP displays requested key. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth get\-key +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBget\-or\-create\fP adds authentication info for a particular entity +from input file, or random key if no input given and/or any caps specified in the +command. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth get\-or\-create { [...]} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBget\-or\-create\-key\fP gets or adds key for \fBname\fP from system/caps +pairs specified in the command. If key already exists, any given caps must match +the existing caps for that key. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth get\-or\-create\-key { [...]} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBimport\fP reads keyring from input file. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth import +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBlist\fP lists authentication state. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth list +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBprint\-key\fP displays requested key. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth print\-key +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBprint_key\fP displays requested key. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph auth print_key +.ft P +.fi +.UNINDENT +.UNINDENT +.SS compact +.sp +Causes compaction of monitor\(aqs leveldb storage. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph compact +.ft P +.fi +.UNINDENT +.UNINDENT +.SS config\-key +.sp +Manage configuration key. It uses some additional subcommands. +.sp +Subcommand \fBdel\fP deletes configuration key. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph config\-key del +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBexists\fP checks for configuration keys existence. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph config\-key exists +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBget\fP gets the configuration key. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph config\-key get +.ft P +.fi .UNINDENT -.SH EXAMPLES +.UNINDENT +.sp +Subcommand \fBlist\fP lists configuration keys. .sp -To grab a copy of the current OSD map: +Usage: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -ceph \-m 1.2.3.4:6789 osd getmap \-o osdmap +ceph config\-key list .ft P .fi .UNINDENT .UNINDENT .sp -To get a dump of placement group (PG) state: +Subcommand \fBput\fP puts configuration key and values. +.sp +Usage: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -ceph pg dump \-o pg.txt +ceph config\-key put {} .ft P .fi .UNINDENT .UNINDENT -.SH MONITOR COMMANDS +.SS df +.sp +Show cluster\(aqs free space status. .sp -A more complete summary of commands understood by the monitor cluster can be found in the -online documentation, at +Usage: .INDENT 0.0 .INDENT 3.5 -\fI\%http://ceph.com/docs/master/rados/operations/control\fP +.sp +.nf +.ft C +ceph df {detail} +.ft P +.fi +.UNINDENT .UNINDENT +.SS fsid +.sp +Show cluster\(aqs FSID/UUID. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph fsid +.ft P +.fi +.UNINDENT +.UNINDENT +.SS health +.sp +Show cluster\(aqs health. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph health {detail} +.ft P +.fi +.UNINDENT +.UNINDENT +.SS heap +.sp +Show heap usage info (available only if compiled with tcmalloc) +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph heap dump|start_profiler|stop_profiler|release|stats +.ft P +.fi +.UNINDENT +.UNINDENT +.SS injectargs +.sp +Inject configuration arguments into monitor. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph injectargs [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.SS log +.sp +Log supplied text to the monitor log. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph log [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.SS mds +.sp +Manage metadata server configuration and administration. It uses some +additional subcommands. +.sp +Subcommand \fBadd_data_pool\fP adds data pool. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds add_data_pool +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBcluster_down\fP takes mds cluster down. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds cluster_down +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBcluster_up\fP brings mds cluster up. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds cluster_up +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBcompat\fP manages compatible features. It uses some additional +subcommands. +.sp +Subcommand \fBrm_compat\fP removes compatible feature. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds compat rm_compat +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrm_incompat\fP removes incompatible feature. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds compat rm_incompat +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBshow\fP shows mds compatibility settings. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds compat show +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdeactivate\fP stops mds. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds deactivate +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdump\fP dumps information, optionally from epoch. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds dump {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBfail\fP forces mds to status fail. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds fail +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBgetmap\fP gets MDS map, optionally from epoch. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds getmap {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBnewfs\fP makes new filesystem using pools and . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds newfs {\-\-yes\-i\-really\-mean\-it} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBremove_data_pool\fP removes data pool. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds remove_data_pool +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrm\fP removes inactive mds. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds rm (type.id)> +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrmfailed\fP removes failed mds. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds rmfailed +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset\fP set mds parameter to +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds set max_mds|max_file_size|allow_new_snaps|inline_data {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset_max_mds\fP sets max MDS index. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds set_max_mds +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset_state\fP sets mds state of to . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds set_state +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBsetmap\fP sets mds map; must supply correct epoch number. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds setmap +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBstat\fP shows MDS status. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds stat +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBstop\fP stops mds. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds stop +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBtell\fP sends command to particular mds. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mds tell [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.SS mon +.sp +Manage monitor configuration and administration. It uses some additional +subcommands. +.sp +Subcommand \fBadd\fP adds new monitor named at . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mon add +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdump\fP dumps formatted monmap (optionally from epoch) +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mon dump {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBgetmap\fP gets monmap. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mon getmap {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBremove\fP removes monitor named . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mon remove +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBstat\fP summarizes monitor status. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mon stat +.ft P +.fi +.UNINDENT +.UNINDENT +.SS mon_status +.sp +Reports status of monitors. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph mon_status +.ft P +.fi +.UNINDENT +.UNINDENT +.SS osd +.sp +Manage OSD configuration and administration. It uses some additional +subcommands. +.sp +Subcommand \fBblacklist\fP manage blacklisted clients. It uses some additional +subcommands. +.sp +Subcommand \fBadd\fP add to blacklist (optionally until seconds +from now) +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd blacklist add {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBls\fP show blacklisted clients +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd blacklist ls +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrm\fP remove from blacklist +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd blacklist rm +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBcreate\fP creates new osd (with optional UUID). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd create {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBcrush\fP is used for CRUSH management. It uses some additional +subcommands. +.sp +Subcommand \fBadd\fP adds or updates crushmap position and weight for with + and location . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush add [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBadd\-bucket\fP adds no\-parent (probably root) crush bucket of +type . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush add\-bucket +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBcreate\-or\-move\fP creates entry or moves existing entry for + at/to location . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush create\-or\-move +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +[...] +.sp +Subcommand \fBdump\fP dumps crush map. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush dump +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBget\-tunable\fP get crush tunable straw_calc_version +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush get\-tunable straw_calc_version +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBlink\fP links existing entry for under location . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush link [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBmove\fP moves existing entry for to location . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush move [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBremove\fP removes from crush map (everywhere, or just at +). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush remove {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBreweight\fP change \(aqs weight to in crush map. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush reweight +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBreweight\-all\fP recalculate the weights for the tree to +ensure they sum correctly +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush reweight\-all +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrm\fP removes from crush map (everywhere, or just at +). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush rm {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrule\fP is used for creating crush rules. It uses some additional +subcommands. +.sp +Subcommand \fBcreate\-erasure\fP creates crush rule for erasure coded pool +created with (default default). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush rule create\-erasure {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBcreate\-simple\fP creates crush rule to start from , +replicate across buckets of type , using a choose mode of +(default firstn; indep best for erasure pools). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush rule create\-simple {firstn|indep} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdump\fP dumps crush rule (default all). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush rule dump {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBlist\fP lists crush rules. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush rule list +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBls\fP lists crush rules. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush rule ls +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrm\fP removes crush rule . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush rule rm +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset\fP used alone, sets crush map from input file. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush set +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset\fP with osdname/osd.id update crushmap position and weight +for to with location . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush set [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset\-tunable\fP set crush tunable to . The only +tunable that can be set is straw_calc_version. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush set\-tunable straw_calc_version +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBshow\-tunables\fP shows current crush tunables. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush show\-tunables +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBtunables\fP sets crush tunables values to . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush tunables legacy|argonaut|bobtail|firefly|optimal|default +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBunlink\fP unlinks from crush map (everywhere, or just at +). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd crush unlink {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdeep\-scrub\fP initiates deep scrub on specified osd. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd deep\-scrub +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdown\fP sets osd(s) [...] down. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd down [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdump\fP prints summary of OSD map. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd dump {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBerasure\-code\-profile\fP is used for managing the erasure code +profiles. It uses some additional subcommands. +.sp +Subcommand \fBget\fP gets erasure code profile . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd erasure\-code\-profile get +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBls\fP lists all erasure code profiles. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd erasure\-code\-profile ls +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrm\fP removes erasure code profile . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd erasure\-code\-profile rm +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset\fP creates erasure code profile with [ ...] +pairs. Add a \-\-force at the end to override an existing profile (IT IS RISKY). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd erasure\-code\-profile set { [...]} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBfind\fP find osd in the CRUSH map and shows its location. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd find +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBgetcrushmap\fP gets CRUSH map. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd getcrushmap {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBgetmap\fP gets OSD map. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd getmap {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBgetmaxosd\fP shows largest OSD id. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd getmaxosd +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBin\fP sets osd(s) [...] in. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd in [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBlost\fP marks osd as permanently lost. THIS DESTROYS DATA IF NO +MORE REPLICAS EXIST, BE CAREFUL. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd lost {\-\-yes\-i\-really\-mean\-it} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBls\fP shows all OSD ids. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd ls {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBlspools\fP lists pools. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd lspools {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBmap\fP finds pg for in . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd map +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBmetadata\fP fetches metadata for osd . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd metadata +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBout\fP sets osd(s) [...] out. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd out [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBpause\fP pauses osd. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pause +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBperf\fP prints dump of OSD perf summary stats. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd perf +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBpg\-temp\fP set pg_temp mapping pgid:[ [...]] (developers +only). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pg\-temp { [...]} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBpool\fP is used for managing data pools. It uses some additional +subcommands. +.sp +Subcommand \fBcreate\fP creates pool. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool create {} {replicated|erasure} +{} {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdelete\fP deletes pool. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool delete {} {\-\-yes\-i\-really\-really\-mean\-it} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBget\fP gets pool parameter . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool get size|min_size|crash_replay_interval|pg_num| +pgp_num|crush_ruleset|hit_set_type|hit_set_period|hit_set_count|hit_set_fpp + +ceph osd pool get auid|target_max_objects|target_max_bytes + +ceph osd pool get cache_target_dirty_ratio|cache_target_full_ratio + +ceph osd pool get cache_min_flush_age|cache_min_evict_age| +erasure_code_profile +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBget\-quota\fP obtains object or byte limits for pool. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool get\-quota +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBmksnap\fP makes snapshot in . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool mksnap +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrename\fP renames to . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool rename +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrmsnap\fP removes snapshot from . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool rmsnap +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset\fP sets pool parameter to . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool set size|min_size|crash_replay_interval|pg_num| +pgp_num|crush_ruleset|hashpspool|hit_set_type|hit_set_period + +ceph osd pool set hit_set_count|hit_set_fpp|debug_fake_ec_pool + +ceph osd pool set target_max_bytes|target_max_objects + +ceph osd pool set cache_target_dirty_ratio|cache_target_full_ratio + +ceph osd pool set cache_min_flush_age|cache_min_evict_age + +ceph osd pool set auid {\-\-yes\-i\-really\-mean\-it} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset\-quota\fP sets object or byte limit on pool. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool set\-quota max_objects|max_bytes +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBstats\fP obtain stats from all pools, or from specified pool. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd pool stats {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBprimary\-affinity\fP adjust osd primary\-affinity from 0.0 <= +<= 1.0 +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd primary\-affinity +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBprimary\-temp\fP sets primary_temp mapping pgid:|\-1 (developers +only). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd primary\-temp +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrepair\fP initiates repair on a specified osd. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd repair +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBreweight\fP reweights osd to 0.0 < < 1.0. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +osd reweight +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBreweight\-by\-utilization\fP reweight OSDs by utilization +[overload\-percentage\-for\-consideration, default 120]. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd reweight\-by\-utilization {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrm\fP removes osd(s) [...] in the cluster. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd rm [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBscrub\fP initiates scrub on specified osd. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd scrub +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset\fP sets . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd set pause|noup|nodown|noout|noin|nobackfill|norecover|noscrub| +nodeep\-scrub|notieragent +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBsetcrushmap\fP sets crush map from input file. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd setcrushmap +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBsetmaxosd\fP sets new maximum osd value. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd setmaxosd +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBstat\fP prints summary of OSD map. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd stat +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBthrash\fP thrashes OSDs for . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd thrash +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBtier\fP is used for managing tiers. It uses some additional +subcommands. +.sp +Subcommand \fBadd\fP adds the tier (the second one) to base pool +(the first one). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd tier add {\-\-force\-nonempty} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBadd\-cache\fP adds a cache (the second one) of size +to existing pool (the first one). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd tier add\-cache +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBcache\-mode\fP specifies the caching mode for cache tier . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd tier cache\-mode none|writeback|forward|readonly +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBremove\fP removes the tier (the second one) from base pool + (the first one). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd tier remove +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBremove\-overlay\fP removes the overlay pool for base pool . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd tier remove\-overlay +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset\-overlay\fP set the overlay pool for base pool to be +. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd tier set\-overlay +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBtree\fP prints OSD tree. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd tree {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBunpause\fP unpauses osd. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph osd unpause +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBunset\fP unsets . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +osd unset pause|noup|nodown|noout|noin|nobackfill|norecover|noscrub| +nodeep\-scrub|notieragent +.ft P +.fi +.UNINDENT +.UNINDENT +.SS pg +.sp +It is used for managing the placement groups in OSDs. It uses some +additional subcommands. +.sp +Subcommand \fBdebug\fP shows debug info about pgs. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg debug unfound_objects_exist|degraded_pgs_exist +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdeep\-scrub\fP starts deep\-scrub on . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg deep\-scrub +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdump\fP shows human\-readable versions of pg map (only \(aqall\(aq valid +with plain). +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg dump {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdump_json\fP shows human\-readable version of pg map in json only. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg dump_json {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdump_pools_json\fP shows pg pools info in json only. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg dump_pools_json +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBdump_stuck\fP shows information about stuck pgs. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg dump_stuck {inactive|unclean|stale [inactive|unclean|stale...]} {} +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBforce_create_pg\fP forces creation of pg . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg force_create_pg +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBgetmap\fP gets binary pg map to \-o/stdout. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg getmap +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBmap\fP shows mapping of pg to osds. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg map +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBrepair\fP starts repair on . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg repair +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBscrub\fP starts scrub on . +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg scrub +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBsend_pg_creates\fP triggers pg creates to be issued. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg send_pg_creates +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset_full_ratio\fP sets ratio at which pgs are considered full. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg set_full_ratio +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBset_nearfull_ratio\fP sets ratio at which pgs are considered nearly +full. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg set_nearfull_ratio +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Subcommand \fBstat\fP shows placement group status. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph pg stat +.ft P +.fi +.UNINDENT +.UNINDENT +.SS quorum +.sp +Enter or exit quorum. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph quorum enter|exit +.ft P +.fi +.UNINDENT +.UNINDENT +.SS quorum_status +.sp +Reports status of monitor quorum. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph quorum_status +.ft P +.fi +.UNINDENT +.UNINDENT +.SS report +.sp +Reports full status of cluster, optional title tag strings. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph report { [...]} +.ft P +.fi +.UNINDENT +.UNINDENT +.SS scrub +.sp +Scrubs the monitor stores. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph scrub +.ft P +.fi +.UNINDENT +.UNINDENT +.SS status +.sp +Shows cluster status. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph status +.ft P +.fi +.UNINDENT +.UNINDENT +.SS sync force +.sp +Forces sync of and clear monitor store. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph sync force {\-\-yes\-i\-really\-mean\-it} {\-\-i\-know\-what\-i\-am\-doing} +.ft P +.fi +.UNINDENT +.UNINDENT +.SS tell +.sp +Sends a command to a specific daemon. +.sp +Usage: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +ceph tell [...] +.ft P +.fi +.UNINDENT +.UNINDENT +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-i infile +will specify an input file to be passed along as a payload with the +command to the monitor cluster. This is only used for specific +monitor commands. +.UNINDENT +.INDENT 0.0 +.TP +.B \-o outfile +will write any payload returned by the monitor cluster with its +reply to outfile. Only specific monitor commands (e.g. osd getmap) +return a payload. +.UNINDENT +.INDENT 0.0 +.TP +.B \-c ceph.conf, \-\-conf=ceph.conf +Use ceph.conf configuration file instead of the default +\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-id CLIENT_ID, \-\-user CLIENT_ID +Client id for authentication. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-name CLIENT_NAME, \-n CLIENT_NAME +Client name for authentication. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-cluster CLUSTER +Name of the Ceph cluster. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-admin\-daemon ADMIN_SOCKET +Submit admin\-socket commands. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-admin\-socket ADMIN_SOCKET_NOPE +You probably mean \-\-admin\-daemon +.UNINDENT +.INDENT 0.0 +.TP +.B \-s, \-\-status +Show cluster status. +.UNINDENT +.INDENT 0.0 +.TP +.B \-w, \-\-watch +Watch live cluster changes. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-watch\-debug +Watch debug events. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-watch\-info +Watch info events. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-watch\-sec +Watch security events. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-watch\-warn +Watch warning events. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-watch\-error +Watch error events. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-version, \-v +Display version. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-verbose +Make verbose. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-concise +Make less verbose. +.UNINDENT +.INDENT 0.0 +.TP +.B \-f {json,json\-pretty,xml,xml\-pretty,plain}, \-\-format +Format of output. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-connect\-timeout CLUSTER_TIMEOUT +Set a timeout for connecting to the cluster. .UNINDENT .SH AVAILABILITY .sp -\fBceph\fP is part of the Ceph distributed storage system. Please refer to the Ceph documentation at -\fI\%http://ceph.com/docs\fP for more information. +\fBceph\fP is a part of the Ceph distributed storage system. Please refer to +the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information. .SH SEE ALSO .sp -\fBceph\fP(8), +\fBceph\-mon\fP(8), +\fBceph\-osd\fP(8), +\fBceph\-mds\fP(8) .SH COPYRIGHT 2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA .\" Generated by docutils manpage writer.