ceph(8) - c7

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 [ del | exists | get | list | put ] ...
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 | stats ] ...
28
29       ceph injectargs <injectedargs> [ <injectedargs>... ]
30
31       ceph log <logtext> [ <logtext>... ]
32
33       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 | stat | stop | tell ] ...
34
35       ceph mon [ add | dump | getmap | remove | stat ] ...
36
37       ceph mon_status
38
39       ceph osd [ blacklist | blocked-by | create | deep-scrub | df | down | dump | erasure-code-profile | find | getcrushmap | getmap | getmaxosd | in | lspools | map | metadata | out | pause | perf | pg-temp | primary-affinity | primary-temp | repair | reweight | reweight-by-pg | rm | scrub | set | setcrushmap | setmaxosd  | stat | thrash | 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 tier [ add | add-cache | cache-mode | remove | remove-overlay | set-overlay ] ...
46
47       ceph pg [ debug | deep-scrub | dump | dump_json | dump_pools_json | dump_stuck | force_create_pg | getmap | ls | ls-by-osd | ls-by-pool | ls-by-primary | map | repair | scrub | set_full_ratio | set_nearfull_ratio | stat ] ...
48
49       ceph quorum [ enter | exit ]
50
51       ceph quorum_status
52
53       ceph report { <tags> [ <tags>... ] }
54
55       ceph scrub
56
57       ceph status
58
59       ceph sync force {--yes-i-really-mean-it} {--i-know-what-i-am-doing}
60
61       ceph tell <name (type.id)> <args> [<args>...]
62
63       ceph version
64
65

DESCRIPTION

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

COMMANDS

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

OPTIONS

1261       -i infile
1262              will  specify an input file to be passed along as a payload with
1263              the command to the monitor cluster. This is only used  for  spe‐
1264              cific monitor commands.
1265
1266       -o outfile
1267              will  write any payload returned by the monitor cluster with its
1268              reply to outfile.  Only  specific  monitor  commands  (e.g.  osd
1269              getmap) return a payload.
1270
1271       -c ceph.conf, --conf=ceph.conf
1272              Use   ceph.conf   configuration  file  instead  of  the  default
1273              /etc/ceph/ceph.conf  to  determine  monitor   addresses   during
1274              startup.
1275
1276       --id CLIENT_ID, --user CLIENT_ID
1277              Client id for authentication.
1278
1279       --name CLIENT_NAME, -n CLIENT_NAME
1280              Client name for authentication.
1281
1282       --cluster CLUSTER
1283              Name of the Ceph cluster.
1284
1285       --admin-daemon ADMIN_SOCKET, daemon DAEMON_NAME
1286              Submit admin-socket commands via admin sockets in /var/run/ceph.
1287
1288       --admin-socket ADMIN_SOCKET_NOPE
1289              You probably mean --admin-daemon
1290
1291       -s, --status
1292              Show cluster status.
1293
1294       -w, --watch
1295              Watch live cluster changes.
1296
1297       --watch-debug
1298              Watch debug events.
1299
1300       --watch-info
1301              Watch info events.
1302
1303       --watch-sec
1304              Watch security events.
1305
1306       --watch-warn
1307              Watch warning events.
1308
1309       --watch-error
1310              Watch error events.
1311
1312       --version, -v
1313              Display version.
1314
1315       --verbose
1316              Make verbose.
1317
1318       --concise
1319              Make less verbose.
1320
1321       -f {json,json-pretty,xml,xml-pretty,plain}, --format
1322              Format of output.
1323
1324       --connect-timeout CLUSTER_TIMEOUT
1325              Set a timeout for connecting to the cluster.
1326

AVAILABILITY

1328       ceph  is  part  of Ceph, a massively scalable, open-source, distributed
1329       storage  system.  Please   refer   to   the   Ceph   documentation   at
1330       http://ceph.com/docs for more information.
1331

COPYRIGHT

1336       2010-2014,  Inktank Storage, Inc. and contributors. Licensed under Cre‐
1337       ative Commons BY-SA
1338
1339
1340
1341
1342dev                            October 30, 2018                        CEPH(8)