ceph/src/mgr/MgrCommands.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 // see MonCommands.h
   7
   8 COMMAND("pg stat", "show placement group status.",
   9         "pg", "r", "cli,rest")
  10 COMMAND("pg getmap", "get binary pg map to -o/stdout", "pg", "r", "cli,rest")
  11
  12 COMMAND("pg dump "                                                      \
  13         "name=dumpcontents,type=CephChoices,strings=all|summary|sum|delta|pools|osds|pgs|pgs_brief,n=N,req=false", \
  14         "show human-readable versions of pg map (only 'all' valid with plain)", "pg", "r", "cli,rest")
  15 COMMAND("pg dump_json "                                                 \
  16         "name=dumpcontents,type=CephChoices,strings=all|summary|sum|pools|osds|pgs,n=N,req=false", \
  17         "show human-readable version of pg map in json only",\
  18         "pg", "r", "cli,rest")
  19 COMMAND("pg dump_pools_json", "show pg pools info in json only",\
  20         "pg", "r", "cli,rest")
  21
  22 COMMAND("pg ls-by-pool "                \
  23         "name=poolstr,type=CephString " \
  24         "name=states,type=CephChoices,strings=active|clean|down|scrubbing|degraded|inconsistent|peering|repair|recovering|backfill_wait|incomplete|stale|remapped|deep_scrub|backfill|backfill_toofull|recovery_wait|undersized|activating|peered,n=N,req=false ", \
  25         "list pg with pool = [poolname]", "pg", "r", "cli,rest")
  26 COMMAND("pg ls-by-primary " \
  27         "name=osd,type=CephOsdName " \
  28         "name=pool,type=CephInt,req=false " \
  29         "name=states,type=CephChoices,strings=active|clean|down|scrubbing|degraded|inconsistent|peering|repair|recovering|backfill_wait|incomplete|stale|remapped|deep_scrub|backfill|backfill_toofull|recovery_wait|undersized|activating|peered,n=N,req=false ", \
  30         "list pg with primary = [osd]", "pg", "r", "cli,rest")
  31 COMMAND("pg ls-by-osd " \
  32         "name=osd,type=CephOsdName " \
  33         "name=pool,type=CephInt,req=false " \
  34         "name=states,type=CephChoices,strings=active|clean|down|scrubbing|degraded|inconsistent|peering|repair|recovering|backfill_wait|incomplete|stale|remapped|deep_scrub|backfill|backfill_toofull|recovery_wait|undersized|activating|peered,n=N,req=false ", \
  35         "list pg on osd [osd]", "pg", "r", "cli,rest")
  36 COMMAND("pg ls " \
  37         "name=pool,type=CephInt,req=false " \
  38         "name=states,type=CephChoices,strings=active|clean|down|scrubbing|degraded|inconsistent|peering|repair|recovering|backfill_wait|incomplete|stale|remapped|deep_scrub|backfill|backfill_toofull|recovery_wait|undersized|activating|peered,n=N,req=false ", \
  39         "list pg with specific pool, osd, state", "pg", "r", "cli,rest")
  40 COMMAND("pg dump_stuck " \
  41         "name=stuckops,type=CephChoices,strings=inactive|unclean|stale|undersized|degraded,n=N,req=false " \
  42         "name=threshold,type=CephInt,req=false",
  43         "show information about stuck pgs",\
  44         "pg", "r", "cli,rest")
  45 COMMAND("pg debug " \
  46         "name=debugop,type=CephChoices,strings=unfound_objects_exist|degraded_pgs_exist", \
  47         "show debug info about pgs", "pg", "r", "cli,rest")
  48
  49 COMMAND("pg scrub name=pgid,type=CephPgid", "start scrub on <pgid>", \
  50         "pg", "rw", "cli,rest")
  51 COMMAND("pg deep-scrub name=pgid,type=CephPgid", "start deep-scrub on <pgid>", \
  52         "pg", "rw", "cli,rest")
  53 COMMAND("pg repair name=pgid,type=CephPgid", "start repair on <pgid>", \
  54         "pg", "rw", "cli,rest")
  55
  56 // stuff in osd namespace
  57 COMMAND("osd perf", \
  58         "print dump of OSD perf summary stats", \
  59         "osd", \
  60         "r", \
  61         "cli,rest")
  62 COMMAND("osd df " \
  63         "name=output_method,type=CephChoices,strings=plain|tree,req=false", \
  64         "show OSD utilization", "osd", "r", "cli,rest")
  65 COMMAND("osd blocked-by", \
  66         "print histogram of which OSDs are blocking their peers", \
  67         "osd", "r", "cli,rest")
  68 COMMAND("osd pool stats " \
  69         "name=name,type=CephString,req=false",
  70         "obtain stats from all pools, or from specified pool",
  71         "osd", "r", "cli,rest")
  72 COMMAND("osd reweight-by-utilization " \
  73         "name=oload,type=CephInt,req=false " \
  74         "name=max_change,type=CephFloat,req=false "                     \
  75         "name=max_osds,type=CephInt,req=false "                 \
  76         "name=no_increasing,type=CephChoices,strings=--no-increasing,req=false",\
  77         "reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
  78         "osd", "rw", "cli,rest")
  79 COMMAND("osd test-reweight-by-utilization " \
  80         "name=oload,type=CephInt,req=false " \
  81         "name=max_change,type=CephFloat,req=false "                     \
  82         "name=max_osds,type=CephInt,req=false "                 \
  83         "name=no_increasing,type=CephChoices,strings=--no-increasing,req=false",\
  84         "dry run of reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
  85         "osd", "rw", "cli,rest")
  86 COMMAND("osd reweight-by-pg " \
  87         "name=oload,type=CephInt,req=false " \
  88         "name=max_change,type=CephFloat,req=false "                     \
  89         "name=max_osds,type=CephInt,req=false "                 \
  90         "name=pools,type=CephPoolname,n=N,req=false",                   \
  91         "reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
  92         "osd", "rw", "cli,rest")
  93 COMMAND("osd test-reweight-by-pg " \
  94         "name=oload,type=CephInt,req=false " \
  95         "name=max_change,type=CephFloat,req=false "                     \
  96         "name=max_osds,type=CephInt,req=false "                 \
  97         "name=pools,type=CephPoolname,n=N,req=false",                   \
  98         "dry run of reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
  99         "osd", "rw", "cli,rest")
 100
 101 COMMAND("osd scrub " \
 102         "name=who,type=CephString", \
 103         "initiate scrub on osd <who>, or use <all|any|*> to scrub all", \
 104         "osd", "rw", "cli,rest")
 105 COMMAND("osd deep-scrub " \
 106         "name=who,type=CephString", \
 107         "initiate deep scrub on osd <who>, or use <all|any|*> to deep scrub all", \
 108         "osd", "rw", "cli,rest")
 109 COMMAND("osd repair " \
 110         "name=who,type=CephString", \
 111         "initiate repair on osd <who>, or use <all|any|*> to repair all", \
 112         "osd", "rw", "cli,rest")
 113
 114 COMMAND("service dump",
 115         "dump service map", "service", "r", "cli,rest")
 116 COMMAND("service status",
 117         "dump service state", "service", "r", "cli,rest")