[ceph.git] / ceph / src / mgr / MgrCommands.h

// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab

/* no guard; may be included multiple times */

// see MonCommands.h

COMMAND("pg stat", "show placement group status.",
	"pg", "r")
COMMAND("pg getmap", "get binary pg map to -o/stdout", "pg", "r")

COMMAND("pg dump "							\
	"name=dumpcontents,type=CephChoices,strings=all|summary|sum|delta|pools|osds|pgs|pgs_brief,n=N,req=false", \
	"show human-readable versions of pg map (only 'all' valid with plain)", "pg", "r")
COMMAND("pg dump_json "							\
	"name=dumpcontents,type=CephChoices,strings=all|summary|sum|pools|osds|pgs,n=N,req=false", \
	"show human-readable version of pg map in json only",\
	"pg", "r")
COMMAND("pg dump_pools_json", "show pg pools info in json only",\
	"pg", "r")

COMMAND("pg ls-by-pool "		\
        "name=poolstr,type=CephString " \
	"name=states,type=CephString,n=N,req=false", \
	"list pg with pool = [poolname]", "pg", "r")
COMMAND("pg ls-by-primary " \
        "name=osd,type=CephOsdName " \
        "name=pool,type=CephInt,req=false " \
	"name=states,type=CephString,n=N,req=false", \
	"list pg with primary = [osd]", "pg", "r")
COMMAND("pg ls-by-osd " \
        "name=osd,type=CephOsdName " \
        "name=pool,type=CephInt,req=false " \
	"name=states,type=CephString,n=N,req=false", \
	"list pg on osd [osd]", "pg", "r")
COMMAND("pg ls " \
        "name=pool,type=CephInt,req=false " \
	"name=states,type=CephString,n=N,req=false", \
	"list pg with specific pool, osd, state", "pg", "r")
COMMAND("pg dump_stuck " \
	"name=stuckops,type=CephChoices,strings=inactive|unclean|stale|undersized|degraded,n=N,req=false " \
	"name=threshold,type=CephInt,req=false",
	"show information about stuck pgs",\
	"pg", "r")
COMMAND("pg debug " \
	"name=debugop,type=CephChoices,strings=unfound_objects_exist|degraded_pgs_exist", \
	"show debug info about pgs", "pg", "r")

COMMAND("pg scrub name=pgid,type=CephPgid", "start scrub on <pgid>", \
	"pg", "rw")
COMMAND("pg deep-scrub name=pgid,type=CephPgid", "start deep-scrub on <pgid>", \
	"pg", "rw")
COMMAND("pg repair name=pgid,type=CephPgid", "start repair on <pgid>", \
	"pg", "rw")

COMMAND("pg force-recovery name=pgid,type=CephPgid,n=N", "force recovery of <pgid> first", \
	"pg", "rw")
COMMAND("pg force-backfill name=pgid,type=CephPgid,n=N", "force backfill of <pgid> first", \
	"pg", "rw")
COMMAND("pg cancel-force-recovery name=pgid,type=CephPgid,n=N", "restore normal recovery priority of <pgid>", \
	"pg", "rw")
COMMAND("pg cancel-force-backfill name=pgid,type=CephPgid,n=N", "restore normal backfill priority of <pgid>", \
	"pg", "rw")

// stuff in osd namespace
COMMAND("osd perf", \
        "print dump of OSD perf summary stats", \
        "osd", \
        "r")
COMMAND("osd df " \
        "name=output_method,type=CephChoices,strings=plain|tree,req=false " \
        "name=filter_by,type=CephChoices,strings=class|name,req=false " \
        "name=filter,type=CephString,req=false", \
	"show OSD utilization", "osd", "r")
COMMAND("osd blocked-by", \
	"print histogram of which OSDs are blocking their peers", \
	"osd", "r")
COMMAND("osd pool stats " \
        "name=pool_name,type=CephPoolname,req=false",
        "obtain stats from all pools, or from specified pool",
        "osd", "r")
COMMAND("osd pool scrub " \
        "name=who,type=CephPoolname,n=N", \
        "initiate scrub on pool <who>", \
        "osd", "rw")
COMMAND("osd pool deep-scrub " \
        "name=who,type=CephPoolname,n=N", \
        "initiate deep-scrub on pool <who>", \
        "osd", "rw")
COMMAND("osd pool repair " \
        "name=who,type=CephPoolname,n=N", \
        "initiate repair on pool <who>", \
        "osd", "rw")
COMMAND("osd pool force-recovery " \
        "name=who,type=CephPoolname,n=N", \
        "force recovery of specified pool <who> first", \
        "osd", "rw")
COMMAND("osd pool force-backfill " \
        "name=who,type=CephPoolname,n=N", \
        "force backfill of specified pool <who> first", \
        "osd", "rw")
COMMAND("osd pool cancel-force-recovery " \
        "name=who,type=CephPoolname,n=N", \
        "restore normal recovery priority of specified pool <who>", \
        "osd", "rw")
COMMAND("osd pool cancel-force-backfill " \
        "name=who,type=CephPoolname,n=N", \
        "restore normal recovery priority of specified pool <who>", \
        "osd", "rw")
COMMAND("osd reweight-by-utilization " \
	"name=oload,type=CephInt,req=false " \
	"name=max_change,type=CephFloat,req=false "			\
	"name=max_osds,type=CephInt,req=false "			\
	"name=no_increasing,type=CephBool,req=false",\
	"reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
	"osd", "rw")
COMMAND("osd test-reweight-by-utilization " \
	"name=oload,type=CephInt,req=false " \
	"name=max_change,type=CephFloat,req=false "			\
	"name=max_osds,type=CephInt,req=false "			\
	"name=no_increasing,type=CephBool,req=false",\
	"dry run of reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
	"osd", "r")
COMMAND("osd reweight-by-pg " \
	"name=oload,type=CephInt,req=false " \
	"name=max_change,type=CephFloat,req=false "			\
	"name=max_osds,type=CephInt,req=false "			\
	"name=pools,type=CephPoolname,n=N,req=false",			\
	"reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
	"osd", "rw")
COMMAND("osd test-reweight-by-pg " \
	"name=oload,type=CephInt,req=false " \
	"name=max_change,type=CephFloat,req=false "			\
	"name=max_osds,type=CephInt,req=false "			\
	"name=pools,type=CephPoolname,n=N,req=false",			\
	"dry run of reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
	"osd", "r")

COMMAND("osd destroy "	    \
        "name=id,type=CephOsdName " \
	"name=force,type=CephBool,req=false "
        // backward compat synonym for --force
	"name=yes_i_really_mean_it,type=CephBool,req=false", \
        "mark osd as being destroyed. Keeps the ID intact (allowing reuse), " \
        "but removes cephx keys, config-key data and lockbox keys, "\
        "rendering data permanently unreadable.", \
        "osd", "rw")
COMMAND("osd purge " \
        "name=id,type=CephOsdName " \
	"name=force,type=CephBool,req=false "
        // backward compat synonym for --force
	"name=yes_i_really_mean_it,type=CephBool,req=false", \
        "purge all osd data from the monitors including the OSD id " \
	"and CRUSH position",					     \
	"osd", "rw")

COMMAND("osd safe-to-destroy name=ids,type=CephString,n=N",
	"check whether osd(s) can be safely destroyed without reducing data durability",
	"osd", "r")
COMMAND("osd ok-to-stop name=ids,type=CephString,n=N "\
	"name=max,type=CephInt,req=false",
	"check whether osd(s) can be safely stopped without reducing immediate"\
	" data availability", "osd", "r")

COMMAND("osd scrub " \
	"name=who,type=CephString", \
	"initiate scrub on osd <who>, or use <all|any> to scrub all", \
        "osd", "rw")
COMMAND("osd deep-scrub " \
	"name=who,type=CephString", \
	"initiate deep scrub on osd <who>, or use <all|any> to deep scrub all", \
        "osd", "rw")
COMMAND("osd repair " \
	"name=who,type=CephString", \
	"initiate repair on osd <who>, or use <all|any> to repair all", \
        "osd", "rw")

COMMAND("service dump",
        "dump service map", "service", "r")
COMMAND("service status",
        "dump service state", "service", "r")

COMMAND("config show " \
	"name=who,type=CephString name=key,type=CephString,req=false",
	"Show running configuration",
	"mgr", "r")
COMMAND("config show-with-defaults " \
	"name=who,type=CephString",
	"Show running configuration (including compiled-in defaults)",
	"mgr", "r")

COMMAND("device ls",
	"Show devices",
	"mgr", "r")
COMMAND("device info name=devid,type=CephString",
	"Show information about a device",
	"mgr", "r")
COMMAND("device ls-by-daemon name=who,type=CephString",
	"Show devices associated with a daemon",
	"mgr", "r")
COMMAND("device ls-by-host name=host,type=CephString",
	"Show devices on a host",
	"mgr", "r")
COMMAND("device set-life-expectancy name=devid,type=CephString "\
	"name=from,type=CephString "\
	"name=to,type=CephString,req=false",
	"Set predicted device life expectancy",
	"mgr", "rw")
COMMAND("device rm-life-expectancy name=devid,type=CephString",
	"Clear predicted device life expectancy",
	"mgr", "rw")
Commit	Line	Data
7c673cae FG	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.",
11fdf7f2 TL	9	"pg", "r")
11fdf7f2 TL	10	COMMAND("pg getmap", "get binary pg map to -o/stdout", "pg", "r")
7c673cae FG	11
	12	COMMAND("pg dump " \
	13	"name=dumpcontents,type=CephChoices,strings=all\|summary\|sum\|delta\|pools\|osds\|pgs\|pgs_brief,n=N,req=false", \
11fdf7f2	14	"show human-readable versions of pg map (only 'all' valid with plain)", "pg", "r")
7c673cae FG	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",\
11fdf7f2	18	"pg", "r")
7c673cae	19	COMMAND("pg dump_pools_json", "show pg pools info in json only",\
11fdf7f2	20	"pg", "r")
7c673cae FG	21
	22	COMMAND("pg ls-by-pool " \
	23	"name=poolstr,type=CephString " \
c07f9fc5	24	"name=states,type=CephString,n=N,req=false", \
11fdf7f2	25	"list pg with pool = [poolname]", "pg", "r")
7c673cae FG	26	COMMAND("pg ls-by-primary " \
	27	"name=osd,type=CephOsdName " \
	28	"name=pool,type=CephInt,req=false " \
c07f9fc5	29	"name=states,type=CephString,n=N,req=false", \
11fdf7f2	30	"list pg with primary = [osd]", "pg", "r")
7c673cae FG	31	COMMAND("pg ls-by-osd " \
	32	"name=osd,type=CephOsdName " \
	33	"name=pool,type=CephInt,req=false " \
c07f9fc5	34	"name=states,type=CephString,n=N,req=false", \
11fdf7f2	35	"list pg on osd [osd]", "pg", "r")
7c673cae FG	36	COMMAND("pg ls " \
7c673cae FG	37	"name=pool,type=CephInt,req=false " \
c07f9fc5	38	"name=states,type=CephString,n=N,req=false", \
11fdf7f2	39	"list pg with specific pool, osd, state", "pg", "r")
7c673cae FG	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",\
11fdf7f2	44	"pg", "r")
7c673cae FG	45	COMMAND("pg debug " \
7c673cae FG	46	"name=debugop,type=CephChoices,strings=unfound_objects_exist\|degraded_pgs_exist", \
11fdf7f2	47	"show debug info about pgs", "pg", "r")
7c673cae FG	48
7c673cae FG	49	COMMAND("pg scrub name=pgid,type=CephPgid", "start scrub on <pgid>", \
11fdf7f2	50	"pg", "rw")
7c673cae	51	COMMAND("pg deep-scrub name=pgid,type=CephPgid", "start deep-scrub on <pgid>", \
11fdf7f2	52	"pg", "rw")
7c673cae	53	COMMAND("pg repair name=pgid,type=CephPgid", "start repair on <pgid>", \
11fdf7f2	54	"pg", "rw")
7c673cae	55
c07f9fc5	56	COMMAND("pg force-recovery name=pgid,type=CephPgid,n=N", "force recovery of <pgid> first", \
11fdf7f2	57	"pg", "rw")
c07f9fc5	58	COMMAND("pg force-backfill name=pgid,type=CephPgid,n=N", "force backfill of <pgid> first", \
11fdf7f2	59	"pg", "rw")
c07f9fc5	60	COMMAND("pg cancel-force-recovery name=pgid,type=CephPgid,n=N", "restore normal recovery priority of <pgid>", \
11fdf7f2	61	"pg", "rw")
c07f9fc5	62	COMMAND("pg cancel-force-backfill name=pgid,type=CephPgid,n=N", "restore normal backfill priority of <pgid>", \
11fdf7f2	63	"pg", "rw")
c07f9fc5	64
7c673cae FG	65	// stuff in osd namespace
	66	COMMAND("osd perf", \
	67	"print dump of OSD perf summary stats", \
	68	"osd", \
11fdf7f2	69	"r")
31f18b77	70	COMMAND("osd df " \
11fdf7f2 TL	71	"name=output_method,type=CephChoices,strings=plain\|tree,req=false " \
	72	"name=filter_by,type=CephChoices,strings=class\|name,req=false " \
	73	"name=filter,type=CephString,req=false", \
	74	"show OSD utilization", "osd", "r")
7c673cae FG	75	COMMAND("osd blocked-by", \
7c673cae FG	76	"print histogram of which OSDs are blocking their peers", \
11fdf7f2	77	"osd", "r")
7c673cae	78	COMMAND("osd pool stats " \
11fdf7f2	79	"name=pool_name,type=CephPoolname,req=false",
7c673cae	80	"obtain stats from all pools, or from specified pool",
11fdf7f2 TL	81	"osd", "r")
	82	COMMAND("osd pool scrub " \
	83	"name=who,type=CephPoolname,n=N", \
	84	"initiate scrub on pool <who>", \
	85	"osd", "rw")
	86	COMMAND("osd pool deep-scrub " \
	87	"name=who,type=CephPoolname,n=N", \
	88	"initiate deep-scrub on pool <who>", \
	89	"osd", "rw")
	90	COMMAND("osd pool repair " \
	91	"name=who,type=CephPoolname,n=N", \
	92	"initiate repair on pool <who>", \
	93	"osd", "rw")
	94	COMMAND("osd pool force-recovery " \
	95	"name=who,type=CephPoolname,n=N", \
	96	"force recovery of specified pool <who> first", \
	97	"osd", "rw")
	98	COMMAND("osd pool force-backfill " \
	99	"name=who,type=CephPoolname,n=N", \
	100	"force backfill of specified pool <who> first", \
	101	"osd", "rw")
	102	COMMAND("osd pool cancel-force-recovery " \
	103	"name=who,type=CephPoolname,n=N", \
	104	"restore normal recovery priority of specified pool <who>", \
	105	"osd", "rw")
	106	COMMAND("osd pool cancel-force-backfill " \
	107	"name=who,type=CephPoolname,n=N", \
	108	"restore normal recovery priority of specified pool <who>", \
	109	"osd", "rw")
7c673cae FG	110	COMMAND("osd reweight-by-utilization " \
	111	"name=oload,type=CephInt,req=false " \
	112	"name=max_change,type=CephFloat,req=false " \
	113	"name=max_osds,type=CephInt,req=false " \
20effc67	114	"name=no_increasing,type=CephBool,req=false",\
7c673cae	115	"reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
11fdf7f2	116	"osd", "rw")
7c673cae FG	117	COMMAND("osd test-reweight-by-utilization " \
	118	"name=oload,type=CephInt,req=false " \
	119	"name=max_change,type=CephFloat,req=false " \
	120	"name=max_osds,type=CephInt,req=false " \
11fdf7f2	121	"name=no_increasing,type=CephBool,req=false",\
7c673cae	122	"dry run of reweight OSDs by utilization [overload-percentage-for-consideration, default 120]", \
11fdf7f2	123	"osd", "r")
7c673cae FG	124	COMMAND("osd reweight-by-pg " \
	125	"name=oload,type=CephInt,req=false " \
	126	"name=max_change,type=CephFloat,req=false " \
	127	"name=max_osds,type=CephInt,req=false " \
	128	"name=pools,type=CephPoolname,n=N,req=false", \
	129	"reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
11fdf7f2	130	"osd", "rw")
7c673cae FG	131	COMMAND("osd test-reweight-by-pg " \
	132	"name=oload,type=CephInt,req=false " \
	133	"name=max_change,type=CephFloat,req=false " \
	134	"name=max_osds,type=CephInt,req=false " \
	135	"name=pools,type=CephPoolname,n=N,req=false", \
	136	"dry run of reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]", \
11fdf7f2 TL	137	"osd", "r")
	138
	139	COMMAND("osd destroy " \
	140	"name=id,type=CephOsdName " \
	141	"name=force,type=CephBool,req=false "
	142	// backward compat synonym for --force
	143	"name=yes_i_really_mean_it,type=CephBool,req=false", \
	144	"mark osd as being destroyed. Keeps the ID intact (allowing reuse), " \
	145	"but removes cephx keys, config-key data and lockbox keys, "\
	146	"rendering data permanently unreadable.", \
	147	"osd", "rw")
	148	COMMAND("osd purge " \
	149	"name=id,type=CephOsdName " \
	150	"name=force,type=CephBool,req=false "
	151	// backward compat synonym for --force
	152	"name=yes_i_really_mean_it,type=CephBool,req=false", \
	153	"purge all osd data from the monitors including the OSD id " \
	154	"and CRUSH position", \
	155	"osd", "rw")
31f18b77	156
35e4c445 FG	157	COMMAND("osd safe-to-destroy name=ids,type=CephString,n=N",
35e4c445 FG	158	"check whether osd(s) can be safely destroyed without reducing data durability",
11fdf7f2	159	"osd", "r")
f67539c2 TL	160	COMMAND("osd ok-to-stop name=ids,type=CephString,n=N "\
f67539c2 TL	161	"name=max,type=CephInt,req=false",
35e4c445	162	"check whether osd(s) can be safely stopped without reducing immediate"\
11fdf7f2	163	" data availability", "osd", "r")
35e4c445	164
31f18b77 FG	165	COMMAND("osd scrub " \
31f18b77 FG	166	"name=who,type=CephString", \
11fdf7f2 TL	167	"initiate scrub on osd <who>, or use <all\|any> to scrub all", \
11fdf7f2 TL	168	"osd", "rw")
31f18b77 FG	169	COMMAND("osd deep-scrub " \
31f18b77 FG	170	"name=who,type=CephString", \
11fdf7f2 TL	171	"initiate deep scrub on osd <who>, or use <all\|any> to deep scrub all", \
11fdf7f2 TL	172	"osd", "rw")
31f18b77 FG	173	COMMAND("osd repair " \
31f18b77 FG	174	"name=who,type=CephString", \
11fdf7f2 TL	175	"initiate repair on osd <who>, or use <all\|any> to repair all", \
11fdf7f2 TL	176	"osd", "rw")
224ce89b WB	177
224ce89b WB	178	COMMAND("service dump",
11fdf7f2	179	"dump service map", "service", "r")
224ce89b	180	COMMAND("service status",
11fdf7f2 TL	181	"dump service state", "service", "r")
	182
	183	COMMAND("config show " \
20effc67	184	"name=who,type=CephString name=key,type=CephString,req=false",
11fdf7f2 TL	185	"Show running configuration",
	186	"mgr", "r")
	187	COMMAND("config show-with-defaults " \
	188	"name=who,type=CephString",
	189	"Show running configuration (including compiled-in defaults)",
	190	"mgr", "r")
3efd9988	191
11fdf7f2 TL	192	COMMAND("device ls",
	193	"Show devices",
	194	"mgr", "r")
	195	COMMAND("device info name=devid,type=CephString",
	196	"Show information about a device",
	197	"mgr", "r")
	198	COMMAND("device ls-by-daemon name=who,type=CephString",
	199	"Show devices associated with a daemon",
	200	"mgr", "r")
	201	COMMAND("device ls-by-host name=host,type=CephString",
	202	"Show devices on a host",
	203	"mgr", "r")
	204	COMMAND("device set-life-expectancy name=devid,type=CephString "\
	205	"name=from,type=CephString "\
20effc67	206	"name=to,type=CephString,req=false",
11fdf7f2 TL	207	"Set predicted device life expectancy",
	208	"mgr", "rw")
	209	COMMAND("device rm-life-expectancy name=devid,type=CephString",
	210	"Clear predicted device life expectancy",
	211	"mgr", "rw")