1CEPH(8) Ceph CEPH(8)
2
6 ceph - ceph administration tool
7
9 ceph auth [ add | caps | del | export | get | get-key | get-or-create | get-or-create-key | import | list | print-key | print_key ] ...
10 ceph compact
12 ceph config [ dump | ls | help | get | show | show-with-defaults | set | rm | log | reset | assimilate-conf | generate-minimal-conf ] ...
14 ceph config-key [ rm | exists | get | ls | dump | set ] ...
16 ceph daemon <name> | <path> <command> ...
18 ceph daemonperf <name> | <path> [ interval [ count ] ]
20 ceph df {detail}
22 ceph fs [ ls | new | reset | rm ] ...
24 ceph fsid
26 ceph health {detail}
28 ceph injectargs <injectedargs> [ <injectedargs>... ]
30 ceph log <logtext> [ <logtext>... ]
32 ceph mds [ compat | fail | rm | rmfailed | set_state | stat | repaired ] ...
34 ceph mon [ add | dump | getmap | remove | stat ] ...
36 ceph osd [ blacklist | blocked-by | create | new | deep-scrub | df | down | dump | erasure-code-profile | find | getcrushmap | getmap | getmaxosd | in | ls | lspools | map | metadata | ok-to-stop | out | pause | perf | pg-temp | force-create-pg | primary-affinity | primary-temp | repair | reweight | reweight-by-pg | rm | destroy | purge | safe-to-destroy | scrub | set | setcrushmap | setmaxosd | stat | tree | unpause | unset ] ...
38 ceph osd crush [ add | add-bucket | create-or-move | dump | get-tunable | link | move | remove | rename-bucket | reweight | reweight-all | reweight-subtree | rm | rule | set | set-tunable | show-tunables | tunables | unlink ] ...
40 ceph osd pool [ create | delete | get | get-quota | ls | mksnap | rename | rmsnap | set | set-quota | stats ] ...
42 ceph osd pool application [ disable | enable | get | rm | set ] ...
44 ceph osd tier [ add | add-cache | cache-mode | remove | remove-overlay | set-overlay ] ...
46 ceph pg [ debug | deep-scrub | dump | dump_json | dump_pools_json | dump_stuck | getmap | ls | ls-by-osd | ls-by-pool | ls-by-primary | map | repair | scrub | stat ] ...
48 ceph quorum_status
50 ceph report { <tags> [ <tags>... ] }
52 ceph status
54 ceph sync force {--yes-i-really-mean-it} {--i-know-what-i-am-doing}
56 ceph tell <name (type.id)> <command> [options...]
58 ceph version
60
63 ceph is a control utility which is used for manual deployment and main‐
64 tenance of a Ceph cluster. It provides a diverse set of commands that
65 allows deployment of monitors, OSDs, placement groups, MDS and overall
66 maintenance, administration of the cluster.
67
69 auth
70 Manage authentication keys. It is used for adding, removing, exporting
71 or updating of authentication keys for a particular entity such as a
72 monitor or OSD. It uses some additional subcommands.
73 Subcommand add adds authentication info for a particular entity from
75 input file, or random key if no input is given and/or any caps speci‐
76 fied in the command.
77 Usage:
79 ceph auth add <entity> {<caps> [<caps>...]}
81 Subcommand caps updates caps for name from caps specified in the com‐
83 mand.
84 Usage:
86 ceph auth caps <entity> <caps> [<caps>...]
88 Subcommand del deletes all caps for name.
90 Usage:
92 ceph auth del <entity>
94 Subcommand export writes keyring for requested entity, or master
96 keyring if none given.
97 Usage:
99 ceph auth export {<entity>}
101 Subcommand get writes keyring file with requested key.
103 Usage:
105 ceph auth get <entity>
107 Subcommand get-key displays requested key.
109 Usage:
111 ceph auth get-key <entity>
113 Subcommand get-or-create adds authentication info for a particular
115 entity from input file, or random key if no input given and/or any caps
116 specified in the command.
117 Usage:
119 ceph auth get-or-create <entity> {<caps> [<caps>...]}
121 Subcommand get-or-create-key gets or adds key for name from system/caps
123 pairs specified in the command. If key already exists, any given caps
124 must match the existing caps for that key.
125 Usage:
127 ceph auth get-or-create-key <entity> {<caps> [<caps>...]}
129 Subcommand import reads keyring from input file.
131 Usage:
133 ceph auth import
135 Subcommand ls lists authentication state.
137 Usage:
139 ceph auth ls
141 Subcommand print-key displays requested key.
143 Usage:
145 ceph auth print-key <entity>
147 Subcommand print_key displays requested key.
149 Usage:
151 ceph auth print_key <entity>
153 compact
155 Causes compaction of monitor's leveldb storage.
156 Usage:
158 ceph compact
160 config
162 Configure the cluster. By default, Ceph daemons and clients retrieve
163 their configuration options from monitor when they start, and are
164 updated if any of the tracked options is changed at run time. It uses
165 following additional subcommand.
166 Subcommand dump to dump all options for the cluster
168 Usage:
170 ceph config dump
172 Subcommand ls to list all option names for the cluster
174 Usage:
176 ceph config ls
178 Subcommand help to describe the specified configuration option
180 Usage:
182 ceph config help <option>
184 Subcommand get to dump the option(s) for the specified entity.
186 Usage:
188 ceph config get <who> {<option>}
190 Subcommand show to display the running configuration of the specified
192 entity. Please note, unlike get, which only shows the options managed
193 by monitor, show displays all the configurations being actively used.
194 These options are pulled from several sources, for instance, the com‐
195 piled-in default value, the monitor's configuration database, ceph.conf
196 file on the host. The options can even be overridden at runtime. So,
197 there is chance that the configuration options in the output of show
198 could be different from those in the output of get.
199 Usage:
201 ceph config show {<who>}
203 Subcommand show-with-defaults to display the running configuration
205 along with the compiled-in defaults of the specified entity
206 Usage:
208 ceph config show {<who>}
210 Subcommand set to set an option for one or more specified entities
212 Usage:
214 ceph config set <who> <option> <value> {--force}
216 Subcommand rm to clear an option for one or more entities
218 Usage:
220 ceph config rm <who> <option>
222 Subcommand log to show recent history of config changes. If count
224 option is omitted it defeaults to 10.
225 Usage:
227 ceph config log {<count>}
229 Subcommand reset to revert configuration to the specified historical
231 version
232 Usage:
234 ceph config reset <version>
236 Subcommand assimilate-conf to assimilate options from stdin, and return
238 a new, minimal conf file
239 Usage:
241 ceph config assimilate-conf -i <input-config-path> > <output-config-path>
243 ceph config assimilate-conf < <input-config-path>
244 Subcommand generate-minimal-conf to generate a minimal ceph.conf file,
246 which can be used for bootstrapping a daemon or a client.
247 Usage:
249 ceph config generate-minimal-conf > <minimal-config-path>
251 config-key
253 Manage configuration key. Config-key is a general purpose key/value
254 service offered by the monitors. This service is mainly used by Ceph
255 tools and daemons for persisting various settings. Among which,
256 ceph-mgr modules uses it for storing their options. It uses some addi‐
257 tional subcommands.
258 Subcommand rm deletes configuration key.
260 Usage:
262 ceph config-key rm <key>
264 Subcommand exists checks for configuration keys existence.
266 Usage:
268 ceph config-key exists <key>
270 Subcommand get gets the configuration key.
272 Usage:
274 ceph config-key get <key>
276 Subcommand ls lists configuration keys.
278 Usage:
280 ceph config-key ls
282 Subcommand dump dumps configuration keys and values.
284 Usage:
286 ceph config-key dump
288 Subcommand set puts configuration key and value.
290 Usage:
292 ceph config-key set <key> {<val>}
294 daemon
296 Submit admin-socket commands.
297 Usage:
299 ceph daemon {daemon_name|socket_path} {command} ...
301 Example:
303 ceph daemon osd.0 help
305 daemonperf
307 Watch performance counters from a Ceph daemon.
308 Usage:
310 ceph daemonperf {daemon_name|socket_path} [{interval} [{count}]]
312 df
314 Show cluster's free space status.
315 Usage:
317 ceph df {detail}
319 features
321 Show the releases and features of all connected daemons and clients
322 connected to the cluster, along with the numbers of them in each bucket
323 grouped by the corresponding features/releases. Each release of Ceph
324 supports a different set of features, expressed by the features bit‐
325 mask. New cluster features require that clients support the feature, or
326 else they are not allowed to connect to these new features. As new fea‐
327 tures or capabilities are enabled after an upgrade, older clients are
328 prevented from connecting.
329 Usage:
331 ceph features
333 fs
335 Manage cephfs file systems. It uses some additional subcommands.
336 Subcommand ls to list file systems
338 Usage:
340 ceph fs ls
342 Subcommand new to make a new file system using named pools <metadata>
344 and <data>
345 Usage:
347 ceph fs new <fs_name> <metadata> <data>
349 Subcommand reset is used for disaster recovery only: reset to a sin‐
351 gle-MDS map
352 Usage:
354 ceph fs reset <fs_name> {--yes-i-really-mean-it}
356 Subcommand rm to disable the named file system
358 Usage:
360 ceph fs rm <fs_name> {--yes-i-really-mean-it}
362 fsid
364 Show cluster's FSID/UUID.
365 Usage:
367 ceph fsid
369 health
371 Show cluster's health.
372 Usage:
374 ceph health {detail}
376 heap
378 Show heap usage info (available only if compiled with tcmalloc)
379 Usage:
381 ceph tell <name (type.id)> heap dump|start_profiler|stop_profiler|stats
383 Subcommand release to make TCMalloc to releases no-longer-used memory
385 back to the kernel at once.
386 Usage:
388 ceph tell <name (type.id)> heap release
390 Subcommand (get|set)_release_rate get or set the TCMalloc memory
392 release rate. TCMalloc releases no-longer-used memory back to the ker‐
393 nel gradually. the rate controls how quickly this happens. Increase
394 this setting to make TCMalloc to return unused memory more frequently.
395 0 means never return memory to system, 1 means wait for 1000 pages
396 after releasing a page to system. It is 1.0 by default..
397 Usage:
399 ceph tell <name (type.id)> heap get_release_rate|set_release_rate {<val>}
401 injectargs
403 Inject configuration arguments into monitor.
404 Usage:
406 ceph injectargs <injected_args> [<injected_args>...]
408 log
410 Log supplied text to the monitor log.
411 Usage:
413 ceph log <logtext> [<logtext>...]
415 mds
417 Manage metadata server configuration and administration. It uses some
418 additional subcommands.
419 Subcommand compat manages compatible features. It uses some additional
421 subcommands.
422 Subcommand rm_compat removes compatible feature.
424 Usage:
426 ceph mds compat rm_compat <int[0-]>
428 Subcommand rm_incompat removes incompatible feature.
430 Usage:
432 ceph mds compat rm_incompat <int[0-]>
434 Subcommand show shows mds compatibility settings.
436 Usage:
438 ceph mds compat show
440 Subcommand fail forces mds to status fail.
442 Usage:
444 ceph mds fail <role|gid>
446 Subcommand rm removes inactive mds.
448 Usage:
450 ceph mds rm <int[0-]> <name> (type.id)>
452 Subcommand rmfailed removes failed mds.
454 Usage:
456 ceph mds rmfailed <int[0-]>
458 Subcommand set_state sets mds state of <gid> to <numeric-state>.
460 Usage:
462 ceph mds set_state <int[0-]> <int[0-20]>
464 Subcommand stat shows MDS status.
466 Usage:
468 ceph mds stat
470 Subcommand repaired mark a damaged MDS rank as no longer damaged.
472 Usage:
474 ceph mds repaired <role>
476 mon
478 Manage monitor configuration and administration. It uses some addi‐
479 tional subcommands.
480 Subcommand add adds new monitor named <name> at <addr>.
482 Usage:
484 ceph mon add <name> <IPaddr[:port]>
486 Subcommand dump dumps formatted monmap (optionally from epoch)
488 Usage:
490 ceph mon dump {<int[0-]>}
492 Subcommand getmap gets monmap.
494 Usage:
496 ceph mon getmap {<int[0-]>}
498 Subcommand remove removes monitor named <name>.
500 Usage:
502 ceph mon remove <name>
504 Subcommand stat summarizes monitor status.
506 Usage:
508 ceph mon stat
510 mgr
512 Ceph manager daemon configuration and management.
513 Subcommand dump dumps the latest MgrMap, which describes the active and
515 standby manager daemons.
516 Usage:
518 ceph mgr dump
520 Subcommand fail will mark a manager daemon as failed, removing it from
522 the manager map. If it is the active manager daemon a standby will
523 take its place.
524 Usage:
526 ceph mgr fail <name>
528 Subcommand module ls will list currently enabled manager modules (plug‐
530 ins).
531 Usage:
533 ceph mgr module ls
535 Subcommand module enable will enable a manager module. Available mod‐
537 ules are included in MgrMap and visible via mgr dump.
538 Usage:
540 ceph mgr module enable <module>
542 Subcommand module disable will disable an active manager module.
544 Usage:
546 ceph mgr module disable <module>
548 Subcommand metadata will report metadata about all manager daemons or,
550 if the name is specified, a single manager daemon.
551 Usage:
553 ceph mgr metadata [name]
555 Subcommand versions will report a count of running daemon versions.
557 Usage:
559 ceph mgr versions
561 Subcommand count-metadata will report a count of any daemon metadata
563 field.
564 Usage:
566 ceph mgr count-metadata <field>
568 osd
570 Manage OSD configuration and administration. It uses some additional
571 subcommands.
572 Subcommand blacklist manage blacklisted clients. It uses some addi‐
574 tional subcommands.
575 Subcommand add add <addr> to blacklist (optionally until <expire> sec‐
577 onds from now)
578 Usage:
580 ceph osd blacklist add <EntityAddr> {<float[0.0-]>}
582 Subcommand ls show blacklisted clients
584 Usage:
586 ceph osd blacklist ls
588 Subcommand rm remove <addr> from blacklist
590 Usage:
592 ceph osd blacklist rm <EntityAddr>
594 Subcommand blocked-by prints a histogram of which OSDs are blocking
596 their peers
597 Usage:
599 ceph osd blocked-by
601 Subcommand create creates new osd (with optional UUID and ID).
603 This command is DEPRECATED as of the Luminous release, and will be
605 removed in a future release.
606 Subcommand new should instead be used.
608 Usage:
610 ceph osd create {<uuid>} {<id>}
612 Subcommand new can be used to create a new OSD or to recreate a previ‐
614 ously destroyed OSD with a specific id. The new OSD will have the spec‐
615 ified uuid, and the command expects a JSON file containing the base64
616 cephx key for auth entity client.osd.<id>, as well as optional base64
617 cepx key for dm-crypt lockbox access and a dm-crypt key. Specifying a
618 dm-crypt requires specifying the accompanying lockbox cephx key.
619 Usage:
621 ceph osd new {<uuid>} {<id>} -i {<params.json>}
623 The parameters JSON file is optional but if provided, is expected to
625 maintain a form of the following format:
626 {
628 "cephx_secret": "AQBWtwhZdBO5ExAAIDyjK2Bh16ZXylmzgYYEjg==",
629 "crush_device_class": "myclass"
630 }
631 Or:
633 {
635 "cephx_secret": "AQBWtwhZdBO5ExAAIDyjK2Bh16ZXylmzgYYEjg==",
636 "cephx_lockbox_secret": "AQDNCglZuaeVCRAAYr76PzR1Anh7A0jswkODIQ==",
637 "dmcrypt_key": "<dm-crypt key>",
638 "crush_device_class": "myclass"
639 }
640 Or:
642 {
644 "crush_device_class": "myclass"
645 }
646 The "crush_device_class" property is optional. If specified, it will
648 set the initial CRUSH device class for the new OSD.
649 Subcommand crush is used for CRUSH management. It uses some additional
651 subcommands.
652 Subcommand add adds or updates crushmap position and weight for <name>
654 with <weight> and location <args>.
655 Usage:
657 ceph osd crush add <osdname (id|osd.id)> <float[0.0-]> <args> [<args>...]
659 Subcommand add-bucket adds no-parent (probably root) crush bucket
661 <name> of type <type>.
662 Usage:
664 ceph osd crush add-bucket <name> <type>
666 Subcommand create-or-move creates entry or moves existing entry for
668 <name> <weight> at/to location <args>.
669 Usage:
671 ceph osd crush create-or-move <osdname (id|osd.id)> <float[0.0-]> <args>
673 [<args>...]
674 Subcommand dump dumps crush map.
676 Usage:
678 ceph osd crush dump
680 Subcommand get-tunable get crush tunable straw_calc_version
682 Usage:
684 ceph osd crush get-tunable straw_calc_version
686 Subcommand link links existing entry for <name> under location <args>.
688 Usage:
690 ceph osd crush link <name> <args> [<args>...]
692 Subcommand move moves existing entry for <name> to location <args>.
694 Usage:
696 ceph osd crush move <name> <args> [<args>...]
698 Subcommand remove removes <name> from crush map (everywhere, or just at
700 <ancestor>).
701 Usage:
703 ceph osd crush remove <name> {<ancestor>}
705 Subcommand rename-bucket renames bucket <srcname> to <dstname>
707 Usage:
709 ceph osd crush rename-bucket <srcname> <dstname>
711 Subcommand reweight change <name>'s weight to <weight> in crush map.
713 Usage:
715 ceph osd crush reweight <name> <float[0.0-]>
717 Subcommand reweight-all recalculate the weights for the tree to ensure
719 they sum correctly
720 Usage:
722 ceph osd crush reweight-all
724 Subcommand reweight-subtree changes all leaf items beneath <name> to
726 <weight> in crush map
727 Usage:
729 ceph osd crush reweight-subtree <name> <weight>
731 Subcommand rm removes <name> from crush map (everywhere, or just at
733 <ancestor>).
734 Usage:
736 ceph osd crush rm <name> {<ancestor>}
738 Subcommand rule is used for creating crush rules. It uses some addi‐
740 tional subcommands.
741 Subcommand create-erasure creates crush rule <name> for erasure coded
743 pool created with <profile> (default default).
744 Usage:
746 ceph osd crush rule create-erasure <name> {<profile>}
748 Subcommand create-simple creates crush rule <name> to start from
750 <root>, replicate across buckets of type <type>, using a choose mode of
751 <firstn|indep> (default firstn; indep best for erasure pools).
752 Usage:
754 ceph osd crush rule create-simple <name> <root> <type> {firstn|indep}
756 Subcommand dump dumps crush rule <name> (default all).
758 Usage:
760 ceph osd crush rule dump {<name>}
762 Subcommand ls lists crush rules.
764 Usage:
766 ceph osd crush rule ls
768 Subcommand rm removes crush rule <name>.
770 Usage:
772 ceph osd crush rule rm <name>
774 Subcommand set used alone, sets crush map from input file.
776 Usage:
778 ceph osd crush set
780 Subcommand set with osdname/osd.id update crushmap position and weight
782 for <name> to <weight> with location <args>.
783 Usage:
785 ceph osd crush set <osdname (id|osd.id)> <float[0.0-]> <args> [<args>...]
787 Subcommand set-tunable set crush tunable <tunable> to <value>. The
789 only tunable that can be set is straw_calc_version.
790 Usage:
792 ceph osd crush set-tunable straw_calc_version <value>
794 Subcommand show-tunables shows current crush tunables.
796 Usage:
798 ceph osd crush show-tunables
800 Subcommand tree shows the crush buckets and items in a tree view.
802 Usage:
804 ceph osd crush tree
806 Subcommand tunables sets crush tunables values to <profile>.
808 Usage:
810 ceph osd crush tunables legacy|argonaut|bobtail|firefly|hammer|optimal|default
812 Subcommand unlink unlinks <name> from crush map (everywhere, or just at
814 <ancestor>).
815 Usage:
817 ceph osd crush unlink <name> {<ancestor>}
819 Subcommand df shows OSD utilization
821 Usage:
823 ceph osd df {plain|tree}
825 Subcommand deep-scrub initiates deep scrub on specified osd.
827 Usage:
829 ceph osd deep-scrub <who>
831 Subcommand down sets osd(s) <id> [<id>...] down.
833 Usage:
835 ceph osd down <ids> [<ids>...]
837 Subcommand dump prints summary of OSD map.
839 Usage:
841 ceph osd dump {<int[0-]>}
843 Subcommand erasure-code-profile is used for managing the erasure code
845 profiles. It uses some additional subcommands.
846 Subcommand get gets erasure code profile <name>.
848 Usage:
850 ceph osd erasure-code-profile get <name>
852 Subcommand ls lists all erasure code profiles.
854 Usage:
856 ceph osd erasure-code-profile ls
858 Subcommand rm removes erasure code profile <name>.
860 Usage:
862 ceph osd erasure-code-profile rm <name>
864 Subcommand set creates erasure code profile <name> with [<key[=value]>
866 ...] pairs. Add a --force at the end to override an existing profile
867 (IT IS RISKY).
868 Usage:
870 ceph osd erasure-code-profile set <name> {<profile> [<profile>...]}
872 Subcommand find find osd <id> in the CRUSH map and shows its location.
874 Usage:
876 ceph osd find <int[0-]>
878 Subcommand getcrushmap gets CRUSH map.
880 Usage:
882 ceph osd getcrushmap {<int[0-]>}
884 Subcommand getmap gets OSD map.
886 Usage:
888 ceph osd getmap {<int[0-]>}
890 Subcommand getmaxosd shows largest OSD id.
892 Usage:
894 ceph osd getmaxosd
896 Subcommand in sets osd(s) <id> [<id>...] in.
898 Usage:
900 ceph osd in <ids> [<ids>...]
902 Subcommand lost marks osd as permanently lost. THIS DESTROYS DATA IF NO
904 MORE REPLICAS EXIST, BE CAREFUL.
905 Usage:
907 ceph osd lost <int[0-]> {--yes-i-really-mean-it}
909 Subcommand ls shows all OSD ids.
911 Usage:
913 ceph osd ls {<int[0-]>}
915 Subcommand lspools lists pools.
917 Usage:
919 ceph osd lspools {<int>}
921 Subcommand map finds pg for <object> in <pool>.
923 Usage:
925 ceph osd map <poolname> <objectname>
927 Subcommand metadata fetches metadata for osd <id>.
929 Usage:
931 ceph osd metadata {int[0-]} (default all)
933 Subcommand out sets osd(s) <id> [<id>...] out.
935 Usage:
937 ceph osd out <ids> [<ids>...]
939 Subcommand ok-to-stop checks whether the list of OSD(s) can be stopped
941 without immediately making data unavailable. That is, all data should
942 remain readable and writeable, although data redundancy may be reduced
943 as some PGs may end up in a degraded (but active) state. It will
944 return a success code if it is okay to stop the OSD(s), or an error
945 code and informative message if it is not or if no conclusion can be
946 drawn at the current time.
947 Usage:
949 ceph osd ok-to-stop <id> [<ids>...]
951 Subcommand pause pauses osd.
953 Usage:
955 ceph osd pause
957 Subcommand perf prints dump of OSD perf summary stats.
959 Usage:
961 ceph osd perf
963 Subcommand pg-temp set pg_temp mapping pgid:[<id> [<id>...]] (develop‐
965 ers only).
966 Usage:
968 ceph osd pg-temp <pgid> {<id> [<id>...]}
970 Subcommand force-create-pg forces creation of pg <pgid>.
972 Usage:
974 ceph osd force-create-pg <pgid>
976 Subcommand pool is used for managing data pools. It uses some addi‐
978 tional subcommands.
979 Subcommand create creates pool.
981 Usage:
983 ceph osd pool create <poolname> {<int[0-]>} {<int[0-]>} {replicated|erasure}
985 {<erasure_code_profile>} {<rule>} {<int>} {--autoscale-mode=<on,off,warn>}
986 Subcommand delete deletes pool.
988 Usage:
990 ceph osd pool delete <poolname> {<poolname>} {--yes-i-really-really-mean-it}
992 Subcommand get gets pool parameter <var>.
994 Usage:
996 ceph osd pool get <poolname> size|min_size|pg_num|pgp_num|crush_rule|write_fadvise_dontneed
998 Only for tiered pools:
1000 ceph osd pool get <poolname> hit_set_type|hit_set_period|hit_set_count|hit_set_fpp|
1002 target_max_objects|target_max_bytes|cache_target_dirty_ratio|cache_target_dirty_high_ratio|
1003 cache_target_full_ratio|cache_min_flush_age|cache_min_evict_age|
1004 min_read_recency_for_promote|hit_set_grade_decay_rate|hit_set_search_last_n
1005 Only for erasure coded pools:
1007 ceph osd pool get <poolname> erasure_code_profile
1009 Use all to get all pool parameters that apply to the pool's type:
1011 ceph osd pool get <poolname> all
1013 Subcommand get-quota obtains object or byte limits for pool.
1015 Usage:
1017 ceph osd pool get-quota <poolname>
1019 Subcommand ls list pools
1021 Usage:
1023 ceph osd pool ls {detail}
1025 Subcommand mksnap makes snapshot <snap> in <pool>.
1027 Usage:
1029 ceph osd pool mksnap <poolname> <snap>
1031 Subcommand rename renames <srcpool> to <destpool>.
1033 Usage:
1035 ceph osd pool rename <poolname> <poolname>
1037 Subcommand rmsnap removes snapshot <snap> from <pool>.
1039 Usage:
1041 ceph osd pool rmsnap <poolname> <snap>
1043 Subcommand set sets pool parameter <var> to <val>.
1045 Usage:
1047 ceph osd pool set <poolname> size|min_size|pg_num|
1049 pgp_num|crush_rule|hashpspool|nodelete|nopgchange|nosizechange|
1050 hit_set_type|hit_set_period|hit_set_count|hit_set_fpp|debug_fake_ec_pool|
1051 target_max_bytes|target_max_objects|cache_target_dirty_ratio|
1052 cache_target_dirty_high_ratio|
1053 cache_target_full_ratio|cache_min_flush_age|cache_min_evict_age|
1054 min_read_recency_for_promote|write_fadvise_dontneed|hit_set_grade_decay_rate|
1055 hit_set_search_last_n
1056 <val> {--yes-i-really-mean-it}
1057 Subcommand set-quota sets object or byte limit on pool.
1059 Usage:
1061 ceph osd pool set-quota <poolname> max_objects|max_bytes <val>
1063 Subcommand stats obtain stats from all pools, or from specified pool.
1065 Usage:
1067 ceph osd pool stats {<name>}
1069 Subcommand application is used for adding an annotation to the given
1071 pool. By default, the possible applications are object, block, and file
1072 storage (corresponding app-names are "rgw", "rbd", and "cephfs"). How‐
1073 ever, there might be other applications as well. Based on the applica‐
1074 tion, there may or may not be some processing conducted.
1075 Subcommand disable disables the given application on the given pool.
1077 Usage:
1079 ceph osd pool application disable <pool-name> <app> {--yes-i-really-mean-it}
1081 Subcommand enable adds an annotation to the given pool for the men‐
1083 tioned application.
1084 Usage:
1086 ceph osd pool application enable <pool-name> <app> {--yes-i-really-mean-it}
1088 Subcommand get displays the value for the given key that is associated
1090 with the given application of the given pool. Not passing the optional
1091 arguments would display all key-value pairs for all applications for
1092 all pools.
1093 Usage:
1095 ceph osd pool application get {<pool-name>} {<app>} {<key>}
1097 Subcommand rm removes the key-value pair for the given key in the given
1099 application of the given pool.
1100 Usage:
1102 ceph osd pool application rm <pool-name> <app> <key>
1104 Subcommand set assosciates or updates, if it already exists, a
1106 key-value pair with the given application for the given pool.
1107 Usage:
1109 ceph osd pool application set <pool-name> <app> <key> <value>
1111 Subcommand primary-affinity adjust osd primary-affinity from 0.0
1113 <=<weight> <= 1.0
1114 Usage:
1116 ceph osd primary-affinity <osdname (id|osd.id)> <float[0.0-1.0]>
1118 Subcommand primary-temp sets primary_temp mapping pgid:<id>|-1 (devel‐
1120 opers only).
1121 Usage:
1123 ceph osd primary-temp <pgid> <id>
1125 Subcommand repair initiates repair on a specified osd.
1127 Usage:
1129 ceph osd repair <who>
1131 Subcommand reweight reweights osd to 0.0 < <weight> < 1.0.
1133 Usage:
1135 osd reweight <int[0-]> <float[0.0-1.0]>
1137 Subcommand reweight-by-pg reweight OSDs by PG distribution [over‐
1139 load-percentage-for-consideration, default 120].
1140 Usage:
1142 ceph osd reweight-by-pg {<int[100-]>} {<poolname> [<poolname...]}
1144 {--no-increasing}
1145 Subcommand reweight-by-utilization reweight OSDs by utilization [over‐
1147 load-percentage-for-consideration, default 120].
1148 Usage:
1150 ceph osd reweight-by-utilization {<int[100-]>}
1152 {--no-increasing}
1153 Subcommand rm removes osd(s) <id> [<id>...] from the OSD map.
1155 Usage:
1157 ceph osd rm <ids> [<ids>...]
1159 Subcommand destroy marks OSD id as destroyed, removing its cephx
1161 entity's keys and all of its dm-crypt and daemon-private config key
1162 entries.
1163 This command will not remove the OSD from crush, nor will it remove the
1165 OSD from the OSD map. Instead, once the command successfully completes,
1166 the OSD will show marked as destroyed.
1167 In order to mark an OSD as destroyed, the OSD must first be marked as
1169 lost.
1170 Usage:
1172 ceph osd destroy <id> {--yes-i-really-mean-it}
1174 Subcommand purge performs a combination of osd destroy, osd rm and osd
1176 crush remove.
1177 Usage:
1179 ceph osd purge <id> {--yes-i-really-mean-it}
1181 Subcommand safe-to-destroy checks whether it is safe to remove or
1183 destroy an OSD without reducing overall data redundancy or durability.
1184 It will return a success code if it is definitely safe, or an error
1185 code and informative message if it is not or if no conclusion can be
1186 drawn at the current time.
1187 Usage:
1189 ceph osd safe-to-destroy <id> [<ids>...]
1191 Subcommand scrub initiates scrub on specified osd.
1193 Usage:
1195 ceph osd scrub <who>
1197 Subcommand set sets cluster-wide <flag> by updating OSD map. The full
1199 flag is not honored anymore since the Mimic release, and ceph osd set
1200 full is not supported in the Octopus release.
1201 Usage:
1203 ceph osd set pause|noup|nodown|noout|noin|nobackfill|
1205 norebalance|norecover|noscrub|nodeep-scrub|notieragent
1206 Subcommand setcrushmap sets crush map from input file.
1208 Usage:
1210 ceph osd setcrushmap
1212 Subcommand setmaxosd sets new maximum osd value.
1214 Usage:
1216 ceph osd setmaxosd <int[0-]>
1218 Subcommand set-require-min-compat-client enforces the cluster to be
1220 backward compatible with the specified client version. This subcommand
1221 prevents you from making any changes (e.g., crush tunables, or using
1222 new features) that would violate the current setting. Please note, This
1223 subcommand will fail if any connected daemon or client is not compati‐
1224 ble with the features offered by the given <version>. To see the fea‐
1225 tures and releases of all clients connected to cluster, please see ceph
1226 features.
1227 Usage:
1229 ceph osd set-require-min-compat-client <version>
1231 Subcommand stat prints summary of OSD map.
1233 Usage:
1235 ceph osd stat
1237 Subcommand tier is used for managing tiers. It uses some additional
1239 subcommands.
1240 Subcommand add adds the tier <tierpool> (the second one) to base pool
1242 <pool> (the first one).
1243 Usage:
1245 ceph osd tier add <poolname> <poolname> {--force-nonempty}
1247 Subcommand add-cache adds a cache <tierpool> (the second one) of size
1249 <size> to existing pool <pool> (the first one).
1250 Usage:
1252 ceph osd tier add-cache <poolname> <poolname> <int[0-]>
1254 Subcommand cache-mode specifies the caching mode for cache tier <pool>.
1256 Usage:
1258 ceph osd tier cache-mode <poolname> writeback|readproxy|readonly|none
1260 Subcommand remove removes the tier <tierpool> (the second one) from
1262 base pool <pool> (the first one).
1263 Usage:
1265 ceph osd tier remove <poolname> <poolname>
1267 Subcommand remove-overlay removes the overlay pool for base pool
1269 <pool>.
1270 Usage:
1272 ceph osd tier remove-overlay <poolname>
1274 Subcommand set-overlay set the overlay pool for base pool <pool> to be
1276 <overlaypool>.
1277 Usage:
1279 ceph osd tier set-overlay <poolname> <poolname>
1281 Subcommand tree prints OSD tree.
1283 Usage:
1285 ceph osd tree {<int[0-]>}
1287 Subcommand unpause unpauses osd.
1289 Usage:
1291 ceph osd unpause
1293 Subcommand unset unsets cluster-wide <flag> by updating OSD map.
1295 Usage:
1297 ceph osd unset pause|noup|nodown|noout|noin|nobackfill|
1299 norebalance|norecover|noscrub|nodeep-scrub|notieragent
1300 pg
1302 It is used for managing the placement groups in OSDs. It uses some
1303 additional subcommands.
1304 Subcommand debug shows debug info about pgs.
1306 Usage:
1308 ceph pg debug unfound_objects_exist|degraded_pgs_exist
1310 Subcommand deep-scrub starts deep-scrub on <pgid>.
1312 Usage:
1314 ceph pg deep-scrub <pgid>
1316 Subcommand dump shows human-readable versions of pg map (only 'all'
1318 valid with plain).
1319 Usage:
1321 ceph pg dump {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]}
1323 Subcommand dump_json shows human-readable version of pg map in json
1325 only.
1326 Usage:
1328 ceph pg dump_json {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]}
1330 Subcommand dump_pools_json shows pg pools info in json only.
1332 Usage:
1334 ceph pg dump_pools_json
1336 Subcommand dump_stuck shows information about stuck pgs.
1338 Usage:
1340 ceph pg dump_stuck {inactive|unclean|stale|undersized|degraded [inactive|unclean|stale|undersized|degraded...]}
1342 {<int>}
1343 Subcommand getmap gets binary pg map to -o/stdout.
1345 Usage:
1347 ceph pg getmap
1349 Subcommand ls lists pg with specific pool, osd, state
1351 Usage:
1353 ceph pg ls {<int>} {<pg-state> [<pg-state>...]}
1355 Subcommand ls-by-osd lists pg on osd [osd]
1357 Usage:
1359 ceph pg ls-by-osd <osdname (id|osd.id)> {<int>}
1361 {<pg-state> [<pg-state>...]}
1362 Subcommand ls-by-pool lists pg with pool = [poolname]
1364 Usage:
1366 ceph pg ls-by-pool <poolstr> {<int>} {<pg-state> [<pg-state>...]}
1368 Subcommand ls-by-primary lists pg with primary = [osd]
1370 Usage:
1372 ceph pg ls-by-primary <osdname (id|osd.id)> {<int>}
1374 {<pg-state> [<pg-state>...]}
1375 Subcommand map shows mapping of pg to osds.
1377 Usage:
1379 ceph pg map <pgid>
1381 Subcommand repair starts repair on <pgid>.
1383 Usage:
1385 ceph pg repair <pgid>
1387 Subcommand scrub starts scrub on <pgid>.
1389 Usage:
1391 ceph pg scrub <pgid>
1393 Subcommand stat shows placement group status.
1395 Usage:
1397 ceph pg stat
1399 quorum
1401 Cause a specific MON to enter or exit quorum.
1402 Usage:
1404 ceph tell mon.<id> quorum enter|exit
1406 quorum_status
1408 Reports status of monitor quorum.
1409 Usage:
1411 ceph quorum_status
1413 report
1415 Reports full status of cluster, optional title tag strings.
1416 Usage:
1418 ceph report {<tags> [<tags>...]}
1420 status
1422 Shows cluster status.
1423 Usage:
1425 ceph status
1427 tell
1429 Sends a command to a specific daemon.
1430 Usage:
1432 ceph tell <name (type.id)> <command> [options...]
1434 List all available commands.
1436 Usage:
1438 ceph tell <name (type.id)> help
1440 version
1442 Show mon daemon version
1443 Usage:
1445 ceph version
1447
1449 -i infile
1450 will specify an input file to be passed along as a payload with
1451 the command to the monitor cluster. This is only used for spe‐
1452 cific monitor commands.
1453 -o outfile
1455 will write any payload returned by the monitor cluster with its
1456 reply to outfile. Only specific monitor commands (e.g. osd
1457 getmap) return a payload.
1458 --setuser user
1460 will apply the appropriate user ownership to the file specified
1461 by the option '-o'.
1462 --setgroup group
1464 will apply the appropriate group ownership to the file specified
1465 by the option '-o'.
1466 -c ceph.conf, --conf=ceph.conf
1468 Use ceph.conf configuration file instead of the default
1469 /etc/ceph/ceph.conf to determine monitor addresses during
1470 startup.
1471 --id CLIENT_ID, --user CLIENT_ID
1473 Client id for authentication.
1474 --name CLIENT_NAME, -n CLIENT_NAME
1476 Client name for authentication.
1477 --cluster CLUSTER
1479 Name of the Ceph cluster.
1480 --admin-daemon ADMIN_SOCKET, daemon DAEMON_NAME
1482 Submit admin-socket commands via admin sockets in /var/run/ceph.
1483 --admin-socket ADMIN_SOCKET_NOPE
1485 You probably mean --admin-daemon
1486 -s, --status
1488 Show cluster status.
1489 -w, --watch
1491 Watch live cluster changes on the default 'cluster' channel
1492 -W, --watch-channel
1494 Watch live cluster changes on any channel (cluster, audit,
1495 cephadm, or * for all)
1496 --watch-debug
1498 Watch debug events.
1499 --watch-info
1501 Watch info events.
1502 --watch-sec
1504 Watch security events.
1505 --watch-warn
1507 Watch warning events.
1508 --watch-error
1510 Watch error events.
1511 --version, -v
1513 Display version.
1514 --verbose
1516 Make verbose.
1517 --concise
1519 Make less verbose.
1520 -f {json,json-pretty,xml,xml-pretty,plain}, --format
1522 Format of output.
1523 --connect-timeout CLUSTER_TIMEOUT
1525 Set a timeout for connecting to the cluster.
1526 --no-increasing
1528 --no-increasing is off by default. So increasing the osd weight
1529 is allowed using the reweight-by-utilization or
1530 test-reweight-by-utilization commands. If this option is used
1531 with these commands, it will help not to increase osd weight
1532 even the osd is under utilized.
1533 --block
1535 block until completion (scrub and deep-scrub only)
1536
1538 ceph is part of Ceph, a massively scalable, open-source, distributed
1539 storage system. Please refer to the Ceph documentation at
1540 http://ceph.com/docs for more information.
1541
1543 ceph-mon(8), ceph-osd(8), ceph-mds(8)
1544
1546 2010-2021, Inktank Storage, Inc. and contributors. Licensed under Cre‐
1547 ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
1548dev Mar 18, 2021 CEPH(8)