src/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=CephString,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=CephString,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=CephString,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=CephString,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 COMMAND("pg force-recovery name=pgid,type=CephPgid,n=N", "force recovery of <pgid> first", \
  57         "pg", "rw", "cli,rest")
  58 COMMAND("pg force-backfill name=pgid,type=CephPgid,n=N", "force backfill of <pgid> first", \
  59         "pg", "rw", "cli,rest")
  60 COMMAND("pg cancel-force-recovery name=pgid,type=CephPgid,n=N", "restore normal recovery priority of <pgid>", \
  61         "pg", "rw", "cli,rest")
  62 COMMAND("pg cancel-force-backfill name=pgid,type=CephPgid,n=N", "restore normal backfill priority of <pgid>", \
  63         "pg", "rw", "cli,rest")
  64
  65 // stuff in osd namespace
  66 COMMAND("osd perf", \
  67         "print dump of OSD perf summary stats", \
  68         "osd", \
  69         "r", \
  70         "cli,rest")
  71 COMMAND("osd df " \
  72         "name=output_method,type=CephChoices,strings=plain|tree,req=false", \
  73         "show OSD utilization", "osd", "r", "cli,rest")
  74 COMMAND("osd blocked-by", \
  75         "print histogram of which OSDs are blocking their peers", \
  76         "osd", "r", "cli,rest")
  77 COMMAND("osd pool stats " \
  78         "name=name,type=CephString,req=false",
  79         "obtain stats from all pools, or from specified pool",
  80         "osd", "r", "cli,rest")
  81 COMMAND("osd reweight-by-utilization " \
  82         "name=oload,type=CephInt,req=false " \
  83         "name=max_change,type=CephFloat,req=false "                     \
  84         "name=max_osds,type=CephInt,req=false "                 \
  85         "name=no_increasing,type=CephChoices,strings=--no-increasing,req=false",\
  86         "reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
  87         "osd", "rw", "cli,rest")
  88 COMMAND("osd test-reweight-by-utilization " \
  89         "name=oload,type=CephInt,req=false " \
  90         "name=max_change,type=CephFloat,req=false "                     \
  91         "name=max_osds,type=CephInt,req=false "                 \
  92         "name=no_increasing,type=CephChoices,strings=--no-increasing,req=false",\
  93         "dry run of reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
  94         "osd", "r", "cli,rest")
  95 COMMAND("osd reweight-by-pg " \
  96         "name=oload,type=CephInt,req=false " \
  97         "name=max_change,type=CephFloat,req=false "                     \
  98         "name=max_osds,type=CephInt,req=false "                 \
  99         "name=pools,type=CephPoolname,n=N,req=false",                   \
 100         "reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
 101         "osd", "rw", "cli,rest")
 102 COMMAND("osd test-reweight-by-pg " \
 103         "name=oload,type=CephInt,req=false " \
 104         "name=max_change,type=CephFloat,req=false "                     \
 105         "name=max_osds,type=CephInt,req=false "                 \
 106         "name=pools,type=CephPoolname,n=N,req=false",                   \
 107         "dry run of reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
 108         "osd", "r", "cli,rest")
 109
 110 COMMAND("osd safe-to-destroy name=ids,type=CephString,n=N",
 111         "check whether osd(s) can be safely destroyed without reducing data durability",
 112         "osd", "r", "cli,rest")
 113 COMMAND("osd ok-to-stop name=ids,type=CephString,n=N",
 114         "check whether osd(s) can be safely stopped without reducing immediate"\
 115         " data availability", "osd", "r", "cli,rest")
 116
 117 COMMAND("osd scrub " \
 118         "name=who,type=CephString", \
 119         "initiate scrub on osd <who>, or use <all|any|*> to scrub all", \
 120         "osd", "rw", "cli,rest")
 121 COMMAND("osd deep-scrub " \
 122         "name=who,type=CephString", \
 123         "initiate deep scrub on osd <who>, or use <all|any|*> to deep scrub all", \
 124         "osd", "rw", "cli,rest")
 125 COMMAND("osd repair " \
 126         "name=who,type=CephString", \
 127         "initiate repair on osd <who>, or use <all|any|*> to repair all", \
 128         "osd", "rw", "cli,rest")
 129
 130 COMMAND("service dump",
 131         "dump service map", "service", "r", "cli,rest")
 132 COMMAND("service status",
 133         "dump service state", "service", "r", "cli,rest")
 134
 135 COMMAND("config set " \
 136         "name=key,type=CephString name=value,type=CephString",
 137         "Set a configuration option at runtime (not persistent)",
 138         "mgr", "rw", "cli,rest")