ceph(8) - f32

1CEPH(8)                              Ceph                              CEPH(8)
2
3
4

NAME

6       ceph - ceph administration tool
7

SYNOPSIS

9       ceph auth [ add | caps | del | export | get | get-key | get-or-create | get-or-create-key | import | list | print-key | print_key ] ...
10
11       ceph compact
12
13       ceph config-key [ rm | exists | get | ls | dump | set ] ...
14
15       ceph daemon <name> | <path> <command> ...
16
17       ceph daemonperf <name> | <path> [ interval [ count ] ]
18
19       ceph df {detail}
20
21       ceph fs [ ls | new | reset | rm ] ...
22
23       ceph fsid
24
25       ceph health {detail}
26
27       ceph heap [ dump | start_profiler | stop_profiler | release | get_release_rate | set_release_rate | stats ] ...
28
29       ceph injectargs <injectedargs> [ <injectedargs>... ]
30
31       ceph log <logtext> [ <logtext>... ]
32
33       ceph mds [ compat | fail | rm | rmfailed | set_state | stat | repaired ] ...
34
35       ceph mon [ add | dump | getmap | remove | stat ] ...
36
37       ceph mon_status
38
39       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 ] ...
40
41       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 ] ...
42
43       ceph osd pool [ create | delete | get | get-quota | ls | mksnap | rename | rmsnap | set | set-quota | stats ] ...
44
45       ceph osd pool application [ disable | enable | get | rm | set ] ...
46
47       ceph osd tier [ add | add-cache | cache-mode | remove | remove-overlay | set-overlay ] ...
48
49       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 ] ...
50
51       ceph quorum [ enter | exit ]
52
53       ceph quorum_status
54
55       ceph report { <tags> [ <tags>... ] }
56
57       ceph scrub
58
59       ceph status
60
61       ceph sync force {--yes-i-really-mean-it} {--i-know-what-i-am-doing}
62
63       ceph tell <name (type.id)> <command> [options...]
64
65       ceph version
66
67

DESCRIPTION

69       ceph is a control utility which is used for manual deployment and main‐
70       tenance of a Ceph cluster. It provides a diverse set of  commands  that
71       allows  deployment of monitors, OSDs, placement groups, MDS and overall
72       maintenance, administration of the cluster.
73

COMMANDS

75   auth
76       Manage authentication keys. It is used for adding, removing,  exporting
77       or  updating  of authentication keys for a particular  entity such as a
78       monitor or OSD. It uses some additional subcommands.
79
80       Subcommand add adds authentication info for a  particular  entity  from
81       input  file,  or random key if no input is given and/or any caps speci‐
82       fied in the command.
83
84       Usage:
85
86          ceph auth add <entity> {<caps> [<caps>...]}
87
88       Subcommand caps updates caps for name from caps specified in  the  com‐
89       mand.
90
91       Usage:
92
93          ceph auth caps <entity> <caps> [<caps>...]
94
95       Subcommand del deletes all caps for name.
96
97       Usage:
98
99          ceph auth del <entity>
100
101       Subcommand  export  writes  keyring  for  requested  entity,  or master
102       keyring if none given.
103
104       Usage:
105
106          ceph auth export {<entity>}
107
108       Subcommand get writes keyring file with requested key.
109
110       Usage:
111
112          ceph auth get <entity>
113
114       Subcommand get-key displays requested key.
115
116       Usage:
117
118          ceph auth get-key <entity>
119
120       Subcommand get-or-create adds  authentication  info  for  a  particular
121       entity from input file, or random key if no input given and/or any caps
122       specified in the command.
123
124       Usage:
125
126          ceph auth get-or-create <entity> {<caps> [<caps>...]}
127
128       Subcommand get-or-create-key gets or adds key for name from system/caps
129       pairs  specified in the command.  If key already exists, any given caps
130       must match the existing caps for that key.
131
132       Usage:
133
134          ceph auth get-or-create-key <entity> {<caps> [<caps>...]}
135
136       Subcommand import reads keyring from input file.
137
138       Usage:
139
140          ceph auth import
141
142       Subcommand ls lists authentication state.
143
144       Usage:
145
146          ceph auth ls
147
148       Subcommand print-key displays requested key.
149
150       Usage:
151
152          ceph auth print-key <entity>
153
154       Subcommand print_key displays requested key.
155
156       Usage:
157
158          ceph auth print_key <entity>
159
160   compact
161       Causes compaction of monitor's leveldb storage.
162
163       Usage:
164
165          ceph compact
166
167   config-key
168       Manage configuration key. It uses some additional subcommands.
169
170       Subcommand rm deletes configuration key.
171
172       Usage:
173
174          ceph config-key rm <key>
175
176       Subcommand exists checks for configuration keys existence.
177
178       Usage:
179
180          ceph config-key exists <key>
181
182       Subcommand get gets the configuration key.
183
184       Usage:
185
186          ceph config-key get <key>
187
188       Subcommand ls lists configuration keys.
189
190       Usage:
191
192          ceph config-key ls
193
194       Subcommand dump dumps configuration keys and values.
195
196       Usage:
197
198          ceph config-key dump
199
200       Subcommand set puts configuration key and value.
201
202       Usage:
203
204          ceph config-key set <key> {<val>}
205
206   daemon
207       Submit admin-socket commands.
208
209       Usage:
210
211          ceph daemon {daemon_name|socket_path} {command} ...
212
213       Example:
214
215          ceph daemon osd.0 help
216
217   daemonperf
218       Watch performance counters from a Ceph daemon.
219
220       Usage:
221
222          ceph daemonperf {daemon_name|socket_path} [{interval} [{count}]]
223
224   df
225       Show cluster's free space status.
226
227       Usage:
228
229          ceph df {detail}
230
231   features
232       Show the releases and features of all  connected  daemons  and  clients
233       connected to the cluster, along with the numbers of them in each bucket
234       grouped by the corresponding features/releases. Each  release  of  Ceph
235       supports  a  different  set of features, expressed by the features bit‐
236       mask. New cluster features require that clients support the feature, or
237       else they are not allowed to connect to these new features. As new fea‐
238       tures or capabilities are enabled after an upgrade, older  clients  are
239       prevented from connecting.
240
241       Usage:
242
243          ceph features
244
245   fs
246       Manage cephfs filesystems. It uses some additional subcommands.
247
248       Subcommand ls to list filesystems
249
250       Usage:
251
252          ceph fs ls
253
254       Subcommand  new  to  make a new filesystem using named pools <metadata>
255       and <data>
256
257       Usage:
258
259          ceph fs new <fs_name> <metadata> <data>
260
261       Subcommand reset is used for disaster recovery only: reset  to  a  sin‐
262       gle-MDS map
263
264       Usage:
265
266          ceph fs reset <fs_name> {--yes-i-really-mean-it}
267
268       Subcommand rm to disable the named filesystem
269
270       Usage:
271
272          ceph fs rm <fs_name> {--yes-i-really-mean-it}
273
274   fsid
275       Show cluster's FSID/UUID.
276
277       Usage:
278
279          ceph fsid
280
281   health
282       Show cluster's health.
283
284       Usage:
285
286          ceph health {detail}
287
288   heap
289       Show heap usage info (available only if compiled with tcmalloc)
290
291       Usage:
292
293          ceph heap dump|start_profiler|stop_profiler|stats
294
295       Subcommand  release  to make TCMalloc to releases no-longer-used memory
296       back to the kernel at once.
297
298       Usage:
299
300          ceph heap release
301
302       Subcommand  (get|set)_release_rate  get  or  set  the  TCMalloc  memory
303       release  rate. TCMalloc releases no-longer-used memory back to the ker‐
304       nel gradually. the rate controls how quickly  this  happens.   Increase
305       this  setting to make TCMalloc to return unused memory more frequently.
306       0 means never return memory to system, 1  means  wait  for  1000  pages
307       after releasing a page to system. It is 1.0 by default..
308
309       Usage:
310
311          ceph heap get_release_rate|set_release_rate {<val>}
312
313   injectargs
314       Inject configuration arguments into monitor.
315
316       Usage:
317
318          ceph injectargs <injected_args> [<injected_args>...]
319
320   log
321       Log supplied text to the monitor log.
322
323       Usage:
324
325          ceph log <logtext> [<logtext>...]
326
327   mds
328       Manage  metadata  server configuration and administration. It uses some
329       additional subcommands.
330
331       Subcommand compat manages compatible features. It uses some  additional
332       subcommands.
333
334       Subcommand rm_compat removes compatible feature.
335
336       Usage:
337
338          ceph mds compat rm_compat <int[0-]>
339
340       Subcommand rm_incompat removes incompatible feature.
341
342       Usage:
343
344          ceph mds compat rm_incompat <int[0-]>
345
346       Subcommand show shows mds compatibility settings.
347
348       Usage:
349
350          ceph mds compat show
351
352       Subcommand fail forces mds to status fail.
353
354       Usage:
355
356          ceph mds fail <role|gid>
357
358       Subcommand rm removes inactive mds.
359
360       Usage:
361
362          ceph mds rm <int[0-]> <name> (type.id)>
363
364       Subcommand rmfailed removes failed mds.
365
366       Usage:
367
368          ceph mds rmfailed <int[0-]>
369
370       Subcommand set_state sets mds state of <gid> to <numeric-state>.
371
372       Usage:
373
374          ceph mds set_state <int[0-]> <int[0-20]>
375
376       Subcommand stat shows MDS status.
377
378       Usage:
379
380          ceph mds stat
381
382       Subcommand repaired mark a damaged MDS rank as no longer damaged.
383
384       Usage:
385
386          ceph mds repaired <role>
387
388   mon
389       Manage  monitor  configuration  and  administration. It uses some addi‐
390       tional subcommands.
391
392       Subcommand add adds new monitor named <name> at <addr>.
393
394       Usage:
395
396          ceph mon add <name> <IPaddr[:port]>
397
398       Subcommand dump dumps formatted monmap (optionally from epoch)
399
400       Usage:
401
402          ceph mon dump {<int[0-]>}
403
404       Subcommand getmap gets monmap.
405
406       Usage:
407
408          ceph mon getmap {<int[0-]>}
409
410       Subcommand remove removes monitor named <name>.
411
412       Usage:
413
414          ceph mon remove <name>
415
416       Subcommand stat summarizes monitor status.
417
418       Usage:
419
420          ceph mon stat
421
422   mon_status
423       Reports status of monitors.
424
425       Usage:
426
427          ceph mon_status
428
429   mgr
430       Ceph manager daemon configuration and management.
431
432       Subcommand dump dumps the latest MgrMap, which describes the active and
433       standby manager daemons.
434
435       Usage:
436
437          ceph mgr dump
438
439       Subcommand  fail will mark a manager daemon as failed, removing it from
440       the manager map.  If it is the active manager  daemon  a  standby  will
441       take its place.
442
443       Usage:
444
445          ceph mgr fail <name>
446
447       Subcommand module ls will list currently enabled manager modules (plug‐
448       ins).
449
450       Usage:
451
452          ceph mgr module ls
453
454       Subcommand module enable will enable a manager module.  Available  mod‐
455       ules are included in MgrMap and visible via mgr dump.
456
457       Usage:
458
459          ceph mgr module enable <module>
460
461       Subcommand module disable will disable an active manager module.
462
463       Usage:
464
465          ceph mgr module disable <module>
466
467       Subcommand  metadata will report metadata about all manager daemons or,
468       if the name is specified, a single manager daemon.
469
470       Usage:
471
472          ceph mgr metadata [name]
473
474       Subcommand versions will report a count of running daemon versions.
475
476       Usage:
477
478          ceph mgr versions
479
480       Subcommand count-metadata will report a count of  any  daemon  metadata
481       field.
482
483       Usage:
484
485          ceph mgr count-metadata <field>
486
487   osd
488       Manage  OSD  configuration  and administration. It uses some additional
489       subcommands.
490
491       Subcommand blacklist manage blacklisted clients.  It  uses  some  addi‐
492       tional subcommands.
493
494       Subcommand  add add <addr> to blacklist (optionally until <expire> sec‐
495       onds from now)
496
497       Usage:
498
499          ceph osd blacklist add <EntityAddr> {<float[0.0-]>}
500
501       Subcommand ls show blacklisted clients
502
503       Usage:
504
505          ceph osd blacklist ls
506
507       Subcommand rm remove <addr> from blacklist
508
509       Usage:
510
511          ceph osd blacklist rm <EntityAddr>
512
513       Subcommand blocked-by prints a histogram of  which  OSDs  are  blocking
514       their peers
515
516       Usage:
517
518          ceph osd blocked-by
519
520       Subcommand create creates new osd (with optional UUID and ID).
521
522       This  command  is  DEPRECATED  as  of the Luminous release, and will be
523       removed in a future release.
524
525       Subcommand new should instead be used.
526
527       Usage:
528
529          ceph osd create {<uuid>} {<id>}
530
531       Subcommand new can be used to create a new OSD or to recreate a  previ‐
532       ously destroyed OSD with a specific id. The new OSD will have the spec‐
533       ified uuid, and the command expects a JSON file containing  the  base64
534       cephx  key  for auth entity client.osd.<id>, as well as optional base64
535       cepx key for dm-crypt lockbox access and a dm-crypt key.  Specifying  a
536       dm-crypt requires specifying the accompanying lockbox cephx key.
537
538       Usage:
539
540          ceph osd new {<uuid>} {<id>} -i {<params.json>}
541
542       The  parameters  JSON  file is optional but if provided, is expected to
543       maintain a form of the following format:
544
545          {
546              "cephx_secret": "AQBWtwhZdBO5ExAAIDyjK2Bh16ZXylmzgYYEjg==",
547              "crush_device_class": "myclass"
548          }
549
550       Or:
551
552          {
553              "cephx_secret": "AQBWtwhZdBO5ExAAIDyjK2Bh16ZXylmzgYYEjg==",
554              "cephx_lockbox_secret": "AQDNCglZuaeVCRAAYr76PzR1Anh7A0jswkODIQ==",
555              "dmcrypt_key": "<dm-crypt key>",
556              "crush_device_class": "myclass"
557          }
558
559       Or:
560
561          {
562              "crush_device_class": "myclass"
563          }
564
565       The "crush_device_class" property is optional. If  specified,  it  will
566       set the initial CRUSH device class for the new OSD.
567
568       Subcommand  crush is used for CRUSH management. It uses some additional
569       subcommands.
570
571       Subcommand add adds or updates crushmap position and weight for  <name>
572       with <weight> and location <args>.
573
574       Usage:
575
576          ceph osd crush add <osdname (id|osd.id)> <float[0.0-]> <args> [<args>...]
577
578       Subcommand  add-bucket  adds  no-parent  (probably  root)  crush bucket
579       <name> of type <type>.
580
581       Usage:
582
583          ceph osd crush add-bucket <name> <type>
584
585       Subcommand create-or-move creates entry or  moves  existing  entry  for
586       <name> <weight> at/to location <args>.
587
588       Usage:
589
590          ceph osd crush create-or-move <osdname (id|osd.id)> <float[0.0-]> <args>
591          [<args>...]
592
593       Subcommand dump dumps crush map.
594
595       Usage:
596
597          ceph osd crush dump
598
599       Subcommand get-tunable get crush tunable straw_calc_version
600
601       Usage:
602
603          ceph osd crush get-tunable straw_calc_version
604
605       Subcommand link links existing entry for <name> under location <args>.
606
607       Usage:
608
609          ceph osd crush link <name> <args> [<args>...]
610
611       Subcommand move moves existing entry for <name> to location <args>.
612
613       Usage:
614
615          ceph osd crush move <name> <args> [<args>...]
616
617       Subcommand remove removes <name> from crush map (everywhere, or just at
618       <ancestor>).
619
620       Usage:
621
622          ceph osd crush remove <name> {<ancestor>}
623
624       Subcommand rename-bucket renames bucket <srcname> to <dstname>
625
626       Usage:
627
628          ceph osd crush rename-bucket <srcname> <dstname>
629
630       Subcommand reweight change <name>'s weight to <weight> in crush map.
631
632       Usage:
633
634          ceph osd crush reweight <name> <float[0.0-]>
635
636       Subcommand reweight-all recalculate the weights for the tree to  ensure
637       they sum correctly
638
639       Usage:
640
641          ceph osd crush reweight-all
642
643       Subcommand  reweight-subtree  changes  all leaf items beneath <name> to
644       <weight> in crush map
645
646       Usage:
647
648          ceph osd crush reweight-subtree <name> <weight>
649
650       Subcommand rm removes <name> from crush map  (everywhere,  or  just  at
651       <ancestor>).
652
653       Usage:
654
655          ceph osd crush rm <name> {<ancestor>}
656
657       Subcommand  rule  is  used for creating crush rules. It uses some addi‐
658       tional subcommands.
659
660       Subcommand create-erasure creates crush rule <name> for  erasure  coded
661       pool created with <profile> (default default).
662
663       Usage:
664
665          ceph osd crush rule create-erasure <name> {<profile>}
666
667       Subcommand  create-simple  creates  crush  rule  <name>  to  start from
668       <root>, replicate across buckets of type <type>, using a choose mode of
669       <firstn|indep> (default firstn; indep best for erasure pools).
670
671       Usage:
672
673          ceph osd crush rule create-simple <name> <root> <type> {firstn|indep}
674
675       Subcommand dump dumps crush rule <name> (default all).
676
677       Usage:
678
679          ceph osd crush rule dump {<name>}
680
681       Subcommand ls lists crush rules.
682
683       Usage:
684
685          ceph osd crush rule ls
686
687       Subcommand rm removes crush rule <name>.
688
689       Usage:
690
691          ceph osd crush rule rm <name>
692
693       Subcommand set used alone, sets crush map from input file.
694
695       Usage:
696
697          ceph osd crush set
698
699       Subcommand  set with osdname/osd.id update crushmap position and weight
700       for <name> to <weight> with location <args>.
701
702       Usage:
703
704          ceph osd crush set <osdname (id|osd.id)> <float[0.0-]> <args> [<args>...]
705
706       Subcommand set-tunable set crush tunable  <tunable>  to  <value>.   The
707       only tunable that can be set is straw_calc_version.
708
709       Usage:
710
711          ceph osd crush set-tunable straw_calc_version <value>
712
713       Subcommand show-tunables shows current crush tunables.
714
715       Usage:
716
717          ceph osd crush show-tunables
718
719       Subcommand tree shows the crush buckets and items in a tree view.
720
721       Usage:
722
723          ceph osd crush tree
724
725       Subcommand tunables sets crush tunables values to <profile>.
726
727       Usage:
728
729          ceph osd crush tunables legacy|argonaut|bobtail|firefly|hammer|optimal|default
730
731       Subcommand unlink unlinks <name> from crush map (everywhere, or just at
732       <ancestor>).
733
734       Usage:
735
736          ceph osd crush unlink <name> {<ancestor>}
737
738       Subcommand df shows OSD utilization
739
740       Usage:
741
742          ceph osd df {plain|tree}
743
744       Subcommand deep-scrub initiates deep scrub on specified osd.
745
746       Usage:
747
748          ceph osd deep-scrub <who>
749
750       Subcommand down sets osd(s) <id> [<id>...] down.
751
752       Usage:
753
754          ceph osd down <ids> [<ids>...]
755
756       Subcommand dump prints summary of OSD map.
757
758       Usage:
759
760          ceph osd dump {<int[0-]>}
761
762       Subcommand erasure-code-profile is used for managing the  erasure  code
763       profiles. It uses some additional subcommands.
764
765       Subcommand get gets erasure code profile <name>.
766
767       Usage:
768
769          ceph osd erasure-code-profile get <name>
770
771       Subcommand ls lists all erasure code profiles.
772
773       Usage:
774
775          ceph osd erasure-code-profile ls
776
777       Subcommand rm removes erasure code profile <name>.
778
779       Usage:
780
781          ceph osd erasure-code-profile rm <name>
782
783       Subcommand  set creates erasure code profile <name> with [<key[=value]>
784       ...]  pairs. Add a --force at the end to override an  existing  profile
785       (IT IS RISKY).
786
787       Usage:
788
789          ceph osd erasure-code-profile set <name> {<profile> [<profile>...]}
790
791       Subcommand find find osd <id> in the CRUSH map and shows its location.
792
793       Usage:
794
795          ceph osd find <int[0-]>
796
797       Subcommand getcrushmap gets CRUSH map.
798
799       Usage:
800
801          ceph osd getcrushmap {<int[0-]>}
802
803       Subcommand getmap gets OSD map.
804
805       Usage:
806
807          ceph osd getmap {<int[0-]>}
808
809       Subcommand getmaxosd shows largest OSD id.
810
811       Usage:
812
813          ceph osd getmaxosd
814
815       Subcommand in sets osd(s) <id> [<id>...] in.
816
817       Usage:
818
819          ceph osd in <ids> [<ids>...]
820
821       Subcommand lost marks osd as permanently lost. THIS DESTROYS DATA IF NO
822       MORE REPLICAS EXIST, BE CAREFUL.
823
824       Usage:
825
826          ceph osd lost <int[0-]> {--yes-i-really-mean-it}
827
828       Subcommand ls shows all OSD ids.
829
830       Usage:
831
832          ceph osd ls {<int[0-]>}
833
834       Subcommand lspools lists pools.
835
836       Usage:
837
838          ceph osd lspools {<int>}
839
840       Subcommand map finds pg for <object> in <pool>.
841
842       Usage:
843
844          ceph osd map <poolname> <objectname>
845
846       Subcommand metadata fetches metadata for osd <id>.
847
848       Usage:
849
850          ceph osd metadata {int[0-]} (default all)
851
852       Subcommand out sets osd(s) <id> [<id>...] out.
853
854       Usage:
855
856          ceph osd out <ids> [<ids>...]
857
858       Subcommand ok-to-stop checks whether the list of OSD(s) can be  stopped
859       without  immediately making data unavailable.  That is, all data should
860       remain readable and writeable, although data redundancy may be  reduced
861       as  some  PGs  may  end  up  in a degraded (but active) state.  It will
862       return a success code if it is okay to stop the  OSD(s),  or  an  error
863       code  and  informative  message if it is not or if no conclusion can be
864       drawn at the current time.
865
866       Usage:
867
868          ceph osd ok-to-stop <id> [<ids>...]
869
870       Subcommand pause pauses osd.
871
872       Usage:
873
874          ceph osd pause
875
876       Subcommand perf prints dump of OSD perf summary stats.
877
878       Usage:
879
880          ceph osd perf
881
882       Subcommand pg-temp set pg_temp mapping pgid:[<id> [<id>...]]  (develop‐
883       ers only).
884
885       Usage:
886
887          ceph osd pg-temp <pgid> {<id> [<id>...]}
888
889       Subcommand force-create-pg forces creation of pg <pgid>.
890
891       Usage:
892
893          ceph osd force-create-pg <pgid>
894
895       Subcommand  pool  is  used  for managing data pools. It uses some addi‐
896       tional subcommands.
897
898       Subcommand create creates pool.
899
900       Usage:
901
902          ceph osd pool create <poolname> <int[0-]> {<int[0-]>} {replicated|erasure}
903          {<erasure_code_profile>} {<rule>} {<int>}
904
905       Subcommand delete deletes pool.
906
907       Usage:
908
909          ceph osd pool delete <poolname> {<poolname>} {--yes-i-really-really-mean-it}
910
911       Subcommand get gets pool parameter <var>.
912
913       Usage:
914
915          ceph osd pool get <poolname> size|min_size|pg_num|pgp_num|crush_rule|write_fadvise_dontneed
916
917       Only for tiered pools:
918
919          ceph osd pool get <poolname> hit_set_type|hit_set_period|hit_set_count|hit_set_fpp|
920          target_max_objects|target_max_bytes|cache_target_dirty_ratio|cache_target_dirty_high_ratio|
921          cache_target_full_ratio|cache_min_flush_age|cache_min_evict_age|
922          min_read_recency_for_promote|hit_set_grade_decay_rate|hit_set_search_last_n
923
924       Only for erasure coded pools:
925
926          ceph osd pool get <poolname> erasure_code_profile
927
928       Use all to get all pool parameters that apply to the pool's type:
929
930          ceph osd pool get <poolname> all
931
932       Subcommand get-quota obtains object or byte limits for pool.
933
934       Usage:
935
936          ceph osd pool get-quota <poolname>
937
938       Subcommand ls list pools
939
940       Usage:
941
942          ceph osd pool ls {detail}
943
944       Subcommand mksnap makes snapshot <snap> in <pool>.
945
946       Usage:
947
948          ceph osd pool mksnap <poolname> <snap>
949
950       Subcommand rename renames <srcpool> to <destpool>.
951
952       Usage:
953
954          ceph osd pool rename <poolname> <poolname>
955
956       Subcommand rmsnap removes snapshot <snap> from <pool>.
957
958       Usage:
959
960          ceph osd pool rmsnap <poolname> <snap>
961
962       Subcommand set sets pool parameter <var> to <val>.
963
964       Usage:
965
966          ceph osd pool set <poolname> size|min_size|pg_num|
967          pgp_num|crush_rule|hashpspool|nodelete|nopgchange|nosizechange|
968          hit_set_type|hit_set_period|hit_set_count|hit_set_fpp|debug_fake_ec_pool|
969          target_max_bytes|target_max_objects|cache_target_dirty_ratio|
970          cache_target_dirty_high_ratio|
971          cache_target_full_ratio|cache_min_flush_age|cache_min_evict_age|
972          min_read_recency_for_promote|write_fadvise_dontneed|hit_set_grade_decay_rate|
973          hit_set_search_last_n
974          <val> {--yes-i-really-mean-it}
975
976       Subcommand set-quota sets object or byte limit on pool.
977
978       Usage:
979
980          ceph osd pool set-quota <poolname> max_objects|max_bytes <val>
981
982       Subcommand stats obtain stats from all pools, or from specified pool.
983
984       Usage:
985
986          ceph osd pool stats {<name>}
987
988       Subcommand application is used for adding an annotation  to  the  given
989       pool. By default, the possible applications are object, block, and file
990       storage (corresponding app-names are "rgw", "rbd", and "cephfs").  How‐
991       ever,  there might be other applications as well. Based on the applica‐
992       tion, there may or may not be some processing conducted.
993
994       Subcommand disable disables the given application on the given pool.
995
996       Usage:
997
998          ceph osd pool application disable <pool-name> <app> {--yes-i-really-mean-it}
999
1000       Subcommand enable adds an annotation to the given  pool  for  the  men‐
1001       tioned application.
1002
1003       Usage:
1004
1005          ceph osd pool application enable <pool-name> <app> {--yes-i-really-mean-it}
1006
1007       Subcommand get displays the value for the given key that is assosciated
1008       with the given application of the given pool. Not passing the  optional
1009       arguments  would  display  all key-value pairs for all applications for
1010       all pools.
1011
1012       Usage:
1013
1014          ceph osd pool application get {<pool-name>} {<app>} {<key>}
1015
1016       Subcommand rm removes the key-value pair for the given key in the given
1017       application of the given pool.
1018
1019       Usage:
1020
1021          ceph osd pool application rm <pool-name> <app> <key>
1022
1023       Subcommand  set  assosciates  or  updates,  if  it  already  exists,  a
1024       key-value pair with the given application for the given pool.
1025
1026       Usage:
1027
1028          ceph osd pool application set <pool-name> <app> <key> <value>
1029
1030       Subcommand  primary-affinity  adjust  osd  primary-affinity  from   0.0
1031       <=<weight> <= 1.0
1032
1033       Usage:
1034
1035          ceph osd primary-affinity <osdname (id|osd.id)> <float[0.0-1.0]>
1036
1037       Subcommand  primary-temp sets primary_temp mapping pgid:<id>|-1 (devel‐
1038       opers only).
1039
1040       Usage:
1041
1042          ceph osd primary-temp <pgid> <id>
1043
1044       Subcommand repair initiates repair on a specified osd.
1045
1046       Usage:
1047
1048          ceph osd repair <who>
1049
1050       Subcommand reweight reweights osd to 0.0 < <weight> < 1.0.
1051
1052       Usage:
1053
1054          osd reweight <int[0-]> <float[0.0-1.0]>
1055
1056       Subcommand reweight-by-pg  reweight  OSDs  by  PG  distribution  [over‐
1057       load-percentage-for-consideration, default 120].
1058
1059       Usage:
1060
1061          ceph osd reweight-by-pg {<int[100-]>} {<poolname> [<poolname...]}
1062          {--no-increasing}
1063
1064       Subcommand  reweight-by-utilization reweight OSDs by utilization [over‐
1065       load-percentage-for-consideration, default 120].
1066
1067       Usage:
1068
1069          ceph osd reweight-by-utilization {<int[100-]>}
1070          {--no-increasing}
1071
1072       Subcommand rm removes osd(s) <id> [<id>...] from the OSD map.
1073
1074       Usage:
1075
1076          ceph osd rm <ids> [<ids>...]
1077
1078       Subcommand destroy marks  OSD  id  as  destroyed,  removing  its  cephx
1079       entity's  keys  and  all  of its dm-crypt and daemon-private config key
1080       entries.
1081
1082       This command will not remove the OSD from crush, nor will it remove the
1083       OSD from the OSD map. Instead, once the command successfully completes,
1084       the OSD will show marked as destroyed.
1085
1086       In order to mark an OSD as destroyed, the OSD must first be  marked  as
1087       lost.
1088
1089       Usage:
1090
1091          ceph osd destroy <id> {--yes-i-really-mean-it}
1092
1093       Subcommand  purge performs a combination of osd destroy, osd rm and osd
1094       crush remove.
1095
1096       Usage:
1097
1098          ceph osd purge <id> {--yes-i-really-mean-it}
1099
1100       Subcommand safe-to-destroy checks whether  it  is  safe  to  remove  or
1101       destroy  an OSD without reducing overall data redundancy or durability.
1102       It will return a success code if it is definitely  safe,  or  an  error
1103       code  and  informative  message if it is not or if no conclusion can be
1104       drawn at the current time.
1105
1106       Usage:
1107
1108          ceph osd safe-to-destroy <id> [<ids>...]
1109
1110       Subcommand scrub initiates scrub on specified osd.
1111
1112       Usage:
1113
1114          ceph osd scrub <who>
1115
1116       Subcommand set sets <key>.
1117
1118       Usage:
1119
1120          ceph osd set full|pause|noup|nodown|noout|noin|nobackfill|
1121          norebalance|norecover|noscrub|nodeep-scrub|notieragent
1122
1123       Subcommand setcrushmap sets crush map from input file.
1124
1125       Usage:
1126
1127          ceph osd setcrushmap
1128
1129       Subcommand setmaxosd sets new maximum osd value.
1130
1131       Usage:
1132
1133          ceph osd setmaxosd <int[0-]>
1134
1135       Subcommand set-require-min-compat-client enforces  the  cluster  to  be
1136       backward  compatible with the specified client version. This subcommand
1137       prevents you from making any changes (e.g., crush  tunables,  or  using
1138       new features) that would violate the current setting. Please note, This
1139       subcommand will fail if any connected daemon or client is not  compati‐
1140       ble  with  the features offered by the given <version>. To see the fea‐
1141       tures and releases of all clients connected to cluster, please see ceph
1142       features.
1143
1144       Usage:
1145
1146          ceph osd set-require-min-compat-client <version>
1147
1148       Subcommand stat prints summary of OSD map.
1149
1150       Usage:
1151
1152          ceph osd stat
1153
1154       Subcommand  tier  is  used  for managing tiers. It uses some additional
1155       subcommands.
1156
1157       Subcommand add adds the tier <tierpool> (the second one) to  base  pool
1158       <pool> (the first one).
1159
1160       Usage:
1161
1162          ceph osd tier add <poolname> <poolname> {--force-nonempty}
1163
1164       Subcommand  add-cache  adds a cache <tierpool> (the second one) of size
1165       <size> to existing pool <pool> (the first one).
1166
1167       Usage:
1168
1169          ceph osd tier add-cache <poolname> <poolname> <int[0-]>
1170
1171       Subcommand cache-mode specifies the caching mode for cache tier <pool>.
1172
1173       Usage:
1174
1175          ceph osd tier cache-mode <poolname> none|writeback|forward|readonly|
1176          readforward|readproxy
1177
1178       Subcommand remove removes the tier <tierpool>  (the  second  one)  from
1179       base pool <pool> (the first one).
1180
1181       Usage:
1182
1183          ceph osd tier remove <poolname> <poolname>
1184
1185       Subcommand  remove-overlay  removes  the  overlay  pool  for  base pool
1186       <pool>.
1187
1188       Usage:
1189
1190          ceph osd tier remove-overlay <poolname>
1191
1192       Subcommand set-overlay set the overlay pool for base pool <pool> to  be
1193       <overlaypool>.
1194
1195       Usage:
1196
1197          ceph osd tier set-overlay <poolname> <poolname>
1198
1199       Subcommand tree prints OSD tree.
1200
1201       Usage:
1202
1203          ceph osd tree {<int[0-]>}
1204
1205       Subcommand unpause unpauses osd.
1206
1207       Usage:
1208
1209          ceph osd unpause
1210
1211       Subcommand unset unsets <key>.
1212
1213       Usage:
1214
1215          ceph osd unset full|pause|noup|nodown|noout|noin|nobackfill|
1216          norebalance|norecover|noscrub|nodeep-scrub|notieragent
1217
1218   pg
1219       It  is  used  for  managing  the placement groups in OSDs. It uses some
1220       additional subcommands.
1221
1222       Subcommand debug shows debug info about pgs.
1223
1224       Usage:
1225
1226          ceph pg debug unfound_objects_exist|degraded_pgs_exist
1227
1228       Subcommand deep-scrub starts deep-scrub on <pgid>.
1229
1230       Usage:
1231
1232          ceph pg deep-scrub <pgid>
1233
1234       Subcommand dump shows human-readable versions of  pg  map  (only  'all'
1235       valid with plain).
1236
1237       Usage:
1238
1239          ceph pg dump {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]}
1240
1241       Subcommand  dump_json  shows  human-readable  version of pg map in json
1242       only.
1243
1244       Usage:
1245
1246          ceph pg dump_json {all|summary|sum|delta|pools|osds|pgs|pgs_brief} [{all|summary|sum|delta|pools|osds|pgs|pgs_brief...]}
1247
1248       Subcommand dump_pools_json shows pg pools info in json only.
1249
1250       Usage:
1251
1252          ceph pg dump_pools_json
1253
1254       Subcommand dump_stuck shows information about stuck pgs.
1255
1256       Usage:
1257
1258          ceph pg dump_stuck {inactive|unclean|stale|undersized|degraded [inactive|unclean|stale|undersized|degraded...]}
1259          {<int>}
1260
1261       Subcommand getmap gets binary pg map to -o/stdout.
1262
1263       Usage:
1264
1265          ceph pg getmap
1266
1267       Subcommand ls lists pg with specific pool, osd, state
1268
1269       Usage:
1270
1271          ceph pg ls {<int>} {<pg-state> [<pg-state>...]}
1272
1273       Subcommand ls-by-osd lists pg on osd [osd]
1274
1275       Usage:
1276
1277          ceph pg ls-by-osd <osdname (id|osd.id)> {<int>}
1278          {<pg-state> [<pg-state>...]}
1279
1280       Subcommand ls-by-pool lists pg with pool = [poolname]
1281
1282       Usage:
1283
1284          ceph pg ls-by-pool <poolstr> {<int>} {<pg-state> [<pg-state>...]}
1285
1286       Subcommand ls-by-primary lists pg with primary = [osd]
1287
1288       Usage:
1289
1290          ceph pg ls-by-primary <osdname (id|osd.id)> {<int>}
1291          {<pg-state> [<pg-state>...]}
1292
1293       Subcommand map shows mapping of pg to osds.
1294
1295       Usage:
1296
1297          ceph pg map <pgid>
1298
1299       Subcommand repair starts repair on <pgid>.
1300
1301       Usage:
1302
1303          ceph pg repair <pgid>
1304
1305       Subcommand scrub starts scrub on <pgid>.
1306
1307       Usage:
1308
1309          ceph pg scrub <pgid>
1310
1311       Subcommand stat shows placement group status.
1312
1313       Usage:
1314
1315          ceph pg stat
1316
1317   quorum
1318       Cause MON to enter or exit quorum.
1319
1320       Usage:
1321
1322          ceph quorum enter|exit
1323
1324       Note: this only works on the MON to which  the  ceph  command  is  con‐
1325       nected.   If  you want a specific MON to enter or exit quorum, use this
1326       syntax:
1327
1328          ceph tell mon.<id> quorum enter|exit
1329
1330   quorum_status
1331       Reports status of monitor quorum.
1332
1333       Usage:
1334
1335          ceph quorum_status
1336
1337   report
1338       Reports full status of cluster, optional title tag strings.
1339
1340       Usage:
1341
1342          ceph report {<tags> [<tags>...]}
1343
1344   scrub
1345       Scrubs the monitor stores.
1346
1347       Usage:
1348
1349          ceph scrub
1350
1351   status
1352       Shows cluster status.
1353
1354       Usage:
1355
1356          ceph status
1357
1358   sync force
1359       Forces sync of and clear monitor store.
1360
1361       Usage:
1362
1363          ceph sync force {--yes-i-really-mean-it} {--i-know-what-i-am-doing}
1364
1365   tell
1366       Sends a command to a specific daemon.
1367
1368       Usage:
1369
1370          ceph tell <name (type.id)> <command> [options...]
1371
1372       List all available commands.
1373
1374       Usage:
1375
1376          ceph tell <name (type.id)> help
1377
1378   version
1379       Show mon daemon version
1380
1381       Usage:
1382
1383          ceph version
1384

OPTIONS

1386       -i infile
1387              will specify an input file to be passed along as a payload  with
1388              the  command  to the monitor cluster. This is only used for spe‐
1389              cific monitor commands.
1390
1391       -o outfile
1392              will write any payload returned by the monitor cluster with  its
1393              reply  to  outfile.   Only  specific  monitor commands (e.g. osd
1394              getmap) return a payload.
1395
1396       --setuser user
1397              will apply the appropriate user ownership to the file  specified
1398              by the option '-o'.
1399
1400       --setgroup group
1401              will apply the appropriate group ownership to the file specified
1402              by the option '-o'.
1403
1404       -c ceph.conf, --conf=ceph.conf
1405              Use  ceph.conf  configuration  file  instead  of   the   default
1406              /etc/ceph/ceph.conf   to   determine  monitor  addresses  during
1407              startup.
1408
1409       --id CLIENT_ID, --user CLIENT_ID
1410              Client id for authentication.
1411
1412       --name CLIENT_NAME, -n CLIENT_NAME
1413              Client name for authentication.
1414
1415       --cluster CLUSTER
1416              Name of the Ceph cluster.
1417
1418       --admin-daemon ADMIN_SOCKET, daemon DAEMON_NAME
1419              Submit admin-socket commands via admin sockets in /var/run/ceph.
1420
1421       --admin-socket ADMIN_SOCKET_NOPE
1422              You probably mean --admin-daemon
1423
1424       -s, --status
1425              Show cluster status.
1426
1427       -w, --watch
1428              Watch live cluster changes.
1429
1430       --watch-debug
1431              Watch debug events.
1432
1433       --watch-info
1434              Watch info events.
1435
1436       --watch-sec
1437              Watch security events.
1438
1439       --watch-warn
1440              Watch warning events.
1441
1442       --watch-error
1443              Watch error events.
1444
1445       --version, -v
1446              Display version.
1447
1448       --verbose
1449              Make verbose.
1450
1451       --concise
1452              Make less verbose.
1453
1454       -f {json,json-pretty,xml,xml-pretty,plain}, --format
1455              Format of output.
1456
1457       --connect-timeout CLUSTER_TIMEOUT
1458              Set a timeout for connecting to the cluster.
1459
1460       --no-increasing
1461              --no-increasing is off by default. So increasing the osd  weight
1462              is     allowed     using    the    reweight-by-utilization    or
1463              test-reweight-by-utilization commands.  If this option  is  used
1464              with  these  commands,  it  will help not to increase osd weight
1465              even the osd is under utilized.
1466
1467       --block
1468              block until completion (scrub and deep-scrub only)
1469

AVAILABILITY

1471       ceph is part of Ceph, a massively  scalable,  open-source,  distributed
1472       storage   system.   Please   refer   to   the   Ceph  documentation  at
1473       http://ceph.com/docs for more information.
1474

COPYRIGHT

1479       2010-2020, Inktank Storage, Inc. and contributors. Licensed under  Cre‐
1480       ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
1481
1482
1483
1484
1485dev                              Apr 21, 2020                          CEPH(8)