src/ceph/src/mon/PGMonitorCommands.h

   1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
   2 // vim: ts=8 sw=2 smarttab
   3
   4 /* no guard; may be included multiple times */
   5
   6 COMMAND("pg stat", "show placement group status.",
   7         "pg", "r", "cli,rest")
   8 COMMAND("pg getmap", "get binary pg map to -o/stdout", "pg", "r", "cli,rest")
   9
  10 COMMAND("pg dump "                                                      \
  11         "name=dumpcontents,type=CephChoices,strings=all|summary|sum|delta|pools|osds|pgs|pgs_brief,n=N,req=false", \
  12         "show human-readable versions of pg map (only 'all' valid with plain)", "pg", "r", "cli,rest")
  13 COMMAND("pg dump_json "                                                 \
  14         "name=dumpcontents,type=CephChoices,strings=all|summary|sum|pools|osds|pgs,n=N,req=false", \
  15         "show human-readable version of pg map in json only",\
  16         "pg", "r", "cli,rest")
  17 COMMAND("pg dump_pools_json", "show pg pools info in json only",\
  18         "pg", "r", "cli,rest")
  19
  20 COMMAND("pg ls-by-pool "                \
  21         "name=poolstr,type=CephString " \
  22         "name=states,type=CephString,n=N,req=false", \
  23         "list pg with pool = [poolname]", "pg", "r", "cli,rest")
  24 COMMAND("pg ls-by-primary " \
  25         "name=osd,type=CephOsdName " \
  26         "name=pool,type=CephInt,req=false " \
  27         "name=states,type=CephString,n=N,req=false", \
  28         "list pg with primary = [osd]", "pg", "r", "cli,rest")
  29 COMMAND("pg ls-by-osd " \
  30         "name=osd,type=CephOsdName " \
  31         "name=pool,type=CephInt,req=false " \
  32         "name=states,type=CephString,n=N,req=false", \
  33         "list pg on osd [osd]", "pg", "r", "cli,rest")
  34 COMMAND("pg ls " \
  35         "name=pool,type=CephInt,req=false " \
  36         "name=states,type=CephString,n=N,req=false", \
  37         "list pg with specific pool, osd, state", "pg", "r", "cli,rest")
  38 COMMAND("pg dump_stuck " \
  39         "name=stuckops,type=CephChoices,strings=inactive|unclean|stale|undersized|degraded,n=N,req=false " \
  40         "name=threshold,type=CephInt,req=false",
  41         "show information about stuck pgs",\
  42         "pg", "r", "cli,rest")
  43 COMMAND("pg debug " \
  44         "name=debugop,type=CephChoices,strings=unfound_objects_exist|degraded_pgs_exist", \
  45         "show debug info about pgs", "pg", "r", "cli,rest")
  46
  47 COMMAND("pg scrub name=pgid,type=CephPgid", "start scrub on <pgid>", \
  48         "pg", "rw", "cli,rest")
  49 COMMAND("pg deep-scrub name=pgid,type=CephPgid", "start deep-scrub on <pgid>", \
  50         "pg", "rw", "cli,rest")
  51 COMMAND("pg repair name=pgid,type=CephPgid", "start repair on <pgid>", \
  52         "pg", "rw", "cli,rest")
  53
  54 // stuff in osd namespace
  55 COMMAND("osd perf", \
  56         "print dump of OSD perf summary stats", \
  57         "osd", \
  58         "r", \
  59         "cli,rest")
  60 COMMAND("osd df " \
  61         "name=output_method,type=CephChoices,strings=plain|tree,req=false", \
  62         "show OSD utilization", "osd", "r", "cli,rest")
  63 COMMAND("osd blocked-by", \
  64         "print histogram of which OSDs are blocking their peers", \
  65         "osd", "r", "cli,rest")
  66 COMMAND("osd pool stats " \
  67         "name=name,type=CephString,req=false",
  68         "obtain stats from all pools, or from specified pool",
  69         "osd", "r", "cli,rest")
  70 COMMAND("osd reweight-by-utilization " \
  71         "name=oload,type=CephInt,req=false " \
  72         "name=max_change,type=CephFloat,req=false "                     \
  73         "name=max_osds,type=CephInt,req=false "                 \
  74         "name=no_increasing,type=CephChoices,strings=--no-increasing,req=false",\
  75         "reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
  76         "osd", "rw", "cli,rest")
  77 COMMAND("osd test-reweight-by-utilization " \
  78         "name=oload,type=CephInt,req=false " \
  79         "name=max_change,type=CephFloat,req=false "                     \
  80         "name=max_osds,type=CephInt,req=false "                 \
  81         "name=no_increasing,type=CephChoices,strings=--no-increasing,req=false",\
  82         "dry run of reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
  83         "osd", "r", "cli,rest")
  84 COMMAND("osd reweight-by-pg " \
  85         "name=oload,type=CephInt,req=false " \
  86         "name=max_change,type=CephFloat,req=false "                     \
  87         "name=max_osds,type=CephInt,req=false "                 \
  88         "name=pools,type=CephPoolname,n=N,req=false",                   \
  89         "reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
  90         "osd", "rw", "cli,rest")
  91 COMMAND("osd test-reweight-by-pg " \
  92         "name=oload,type=CephInt,req=false " \
  93         "name=max_change,type=CephFloat,req=false "                     \
  94         "name=max_osds,type=CephInt,req=false "                 \
  95         "name=pools,type=CephPoolname,n=N,req=false",                   \
  96         "dry run of reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
  97         "osd", "r", "cli,rest")
  98
  99 COMMAND("osd scrub " \
 100         "name=who,type=CephString", \
 101         "initiate scrub on osd <who>, or use <all|any|*> to scrub all", \
 102         "osd", "rw", "cli,rest")
 103 COMMAND("osd deep-scrub " \
 104         "name=who,type=CephString", \
 105         "initiate deep scrub on osd <who>, or use <all|any|*> to deep scrub all", \
 106         "osd", "rw", "cli,rest")
 107 COMMAND("osd repair " \
 108         "name=who,type=CephString", \
 109         "initiate repair on osd <who>, or use <all|any|*> to repair all", \
 110         "osd", "rw", "cli,rest")
 111
 112 COMMAND("pg force_create_pg name=pgid,type=CephPgid", \
 113         "force creation of pg <pgid>", "pg", "rw", "cli,rest")
 114 COMMAND_WITH_FLAG("pg set_full_ratio name=ratio,type=CephFloat,range=0.0|1.0", \
 115                   "set ratio at which pgs are considered full", \
 116                   "pg", "rw", "cli,rest", FLAG(DEPRECATED))
 117 COMMAND_WITH_FLAG("pg set_nearfull_ratio "                              \
 118                   "name=ratio,type=CephFloat,range=0.0|1.0",            \
 119                   "set ratio at which pgs are considered nearly full",  \
 120                   "pg", "rw", "cli,rest", FLAG(DEPRECATED))