]> git.proxmox.com Git - ceph.git/blobdiff - ceph/src/mon/MonCommands.h
update sources to v12.1.3
[ceph.git] / ceph / src / mon / MonCommands.h
index bd255fe5b2e5470774f7876893f801ee825f4a69..ef3c094b2339e83749eccfcdb6d01d06a504e767 100644 (file)
  */
 
 // note: this should be replaced shortly!
-COMMAND("pg force_create_pg name=pgid,type=CephPgid", \
-       "force creation of pg <pgid>", "pg", "rw", "cli,rest")
+COMMAND_WITH_FLAG("pg force_create_pg name=pgid,type=CephPgid", \
+                 "force creation of pg <pgid>", "pg", "rw", "cli,rest",
+                 FLAG(DEPRECATED))
 COMMAND_WITH_FLAG("pg set_full_ratio name=ratio,type=CephFloat,range=0.0|1.0", \
                  "set ratio at which pgs are considered full", \
                  "pg", "rw", "cli,rest", FLAG(DEPRECATED))
@@ -154,7 +155,9 @@ COMMAND("auth print-key name=entity,type=CephString", "display requested key", \
        "auth", "rx", "cli,rest")
 COMMAND("auth print_key name=entity,type=CephString", "display requested key", \
        "auth", "rx", "cli,rest")
-COMMAND("auth list", "list authentication state", "auth", "rx", "cli,rest")
+COMMAND_WITH_FLAG("auth list", "list authentication state", "auth", "rx", "cli,rest",
+                 FLAG(DEPRECATED))
+COMMAND("auth ls", "list authentication state", "auth", "rx", "cli,rest")
 COMMAND("auth import", "auth import: read keyring file from -i <file>", \
        "auth", "rwx", "cli,rest")
 COMMAND("auth add " \
@@ -173,6 +176,12 @@ COMMAND("auth get-or-create " \
        "name=caps,type=CephString,n=N,req=false", \
        "add auth info for <entity> from input file, or random key if no input given, and/or any caps specified in the command", \
        "auth", "rwx", "cli,rest")
+COMMAND("fs authorize " \
+   "name=filesystem,type=CephString " \
+   "name=entity,type=CephString " \
+       "name=caps,type=CephString,n=N", \
+       "add auth for <entity> to access file system <filesystem> based on following directory and permissions pairs", \
+       "auth", "rwx", "cli,rest")
 COMMAND("auth caps " \
        "name=entity,type=CephString " \
        "name=caps,type=CephString,n=N", \
@@ -204,11 +213,15 @@ COMMAND("log last "
         "name=level,type=CephChoices,strings=debug|info|sec|warn|error,req=false "
         "name=channel,type=CephChoices,strings=*|cluster|audit,req=false", \
        "print last few lines of the cluster log", \
-       "mon", "rw", "cli,rest")
+       "mon", "r", "cli,rest")
 COMMAND_WITH_FLAG("injectargs " \
             "name=injected_args,type=CephString,n=N",                  \
             "inject config arguments into monitor", "mon", "rw", "cli,rest",
             FLAG(NOFORWARD))
+COMMAND("config set " \
+       "name=key,type=CephString name=value,type=CephString",
+       "Set a configuration option at runtime (not persistent)",
+       "mon", "rw", "cli,rest")
 COMMAND("status", "show cluster status", "mon", "r", "cli,rest")
 COMMAND("health name=detail,type=CephChoices,strings=detail,req=false", \
        "show cluster health", "mon", "r", "cli,rest")
@@ -273,6 +286,10 @@ COMMAND("mon count-metadata name=property,type=CephString",
 COMMAND("mon versions",
        "check running versions of monitors",
        "mon", "r", "cli,rest")
+COMMAND("versions",
+       "check running versions of ceph daemons",
+       "mon", "r", "cli,rest")
+
 
 
 /*
@@ -450,7 +467,7 @@ COMMAND("osd dump " \
        "print summary of OSD map", "osd", "r", "cli,rest")
 COMMAND("osd tree " \
        "name=epoch,type=CephInt,range=0,req=false " \
-       "name=states,type=CephChoices,strings=up|down|in|out,n=N,req=false", \
+       "name=states,type=CephChoices,strings=up|down|in|out|destroyed,n=N,req=false", \
        "print OSD tree", "osd", "r", "cli,rest")
 COMMAND("osd ls " \
        "name=epoch,type=CephInt,range=0,req=false", \
@@ -489,10 +506,8 @@ COMMAND("osd map " \
 COMMAND("osd lspools " \
        "name=auid,type=CephInt,req=false", \
        "list pools", "osd", "r", "cli,rest")
-COMMAND("osd blacklist ls", "show blacklisted clients", "osd", "r", "cli,rest")
-COMMAND("osd blacklist clear", "clear all blacklisted clients", "osd", "rw",
-        "cli,rest")
-COMMAND("osd crush rule list", "list crush rules", "osd", "r", "cli,rest")
+COMMAND_WITH_FLAG("osd crush rule list", "list crush rules", "osd", "r", "cli,rest",
+                 FLAG(DEPRECATED))
 COMMAND("osd crush rule ls", "list crush rules", "osd", "r", "cli,rest")
 COMMAND("osd crush rule dump " \
        "name=name,type=CephString,goodchars=[A-Za-z0-9-_.],req=false", \
@@ -535,6 +550,11 @@ COMMAND("osd crush set-device-class " \
        "set the <class> of the osd(s) <id> [<id>...]," \
         "or use <all|any|*> to set all.", \
        "osd", "rw", "cli,rest")
+COMMAND("osd crush rm-device-class " \
+        "name=ids,type=CephString,n=N", \
+        "remove class of the osd(s) <id> [<id>...]," \
+        "or use <all|any|*> to remove all.", \
+        "osd", "rw", "cli,rest")
 COMMAND("osd crush create-or-move " \
        "name=id,type=CephOsdName " \
        "name=weight,type=CephFloat,range=0.0 " \
@@ -596,7 +616,7 @@ COMMAND("osd crush set-tunable "                                \
 COMMAND("osd crush get-tunable "                             \
        "name=tunable,type=CephChoices,strings=straw_calc_version",
        "get crush tunable <tunable>",
-       "osd", "rw", "cli,rest")
+       "osd", "r", "cli,rest")
 COMMAND("osd crush show-tunables", \
        "show current crush tunables", "osd", "r", "cli,rest")
 COMMAND("osd crush rule create-simple " \
@@ -621,22 +641,13 @@ COMMAND("osd crush rule create-erasure " \
 COMMAND("osd crush rule rm " \
        "name=name,type=CephString,goodchars=[A-Za-z0-9-_.] ",  \
        "remove crush rule <name>", "osd", "rw", "cli,rest")
-COMMAND("osd crush tree",
+COMMAND("osd crush tree "
+        "name=shadow,type=CephChoices,strings=--show-shadow,req=false", \
        "dump crush buckets and items in a tree view",
        "osd", "r", "cli,rest")
-COMMAND("osd crush class create " \
-       "name=class,type=CephString,goodchars=[A-Za-z0-9-_]", \
-       "create crush device class <class>", \
-       "osd", "rw", "cli,rest")
-COMMAND("osd crush class rm " \
-       "name=class,type=CephString,goodchars=[A-Za-z0-9-_]", \
-       "remove crush device class <class>", \
-       "osd", "rw", "cli,rest")
-COMMAND("osd crush class rename " \
-        "name=srcname,type=CephString,goodchars=[A-Za-z0-9-_] " \
-        "name=dstname,type=CephString,goodchars=[A-Za-z0-9-_]", \
-        "rename crush device class <srcname> to <dstname>", \
-        "osd", "rw", "cli,rest")
+COMMAND("osd crush ls name=node,type=CephString,goodchars=goodchars=[A-Za-z0-9-_.]",
+       "list items beneath a node in the CRUSH tree",
+       "osd", "r", "cli,rest")
 COMMAND("osd crush class ls", \
        "list all crush device classes", \
        "osd", "r", "cli,rest")
@@ -644,6 +655,37 @@ COMMAND("osd crush class ls-osd " \
         "name=class,type=CephString,goodchars=[A-Za-z0-9-_]", \
         "list all osds belonging to the specific <class>", \
         "osd", "r", "cli,rest")
+COMMAND("osd crush weight-set ls",
+       "list crush weight sets",
+       "osd", "r", "cli,rest")
+COMMAND("osd crush weight-set dump",
+       "dump crush weight sets",
+       "osd", "r", "cli,rest")
+COMMAND("osd crush weight-set create-compat",
+       "create a default backward-compatible weight-set",
+       "osd", "rw", "cli,rest")
+COMMAND("osd crush weight-set create "         \
+        "name=pool,type=CephPoolname "\
+        "name=mode,type=CephChoices,strings=flat|positional",
+       "create a weight-set for a given pool",
+       "osd", "rw", "cli,rest")
+COMMAND("osd crush weight-set rm name=pool,type=CephPoolname",
+       "remove the weight-set for a given pool",
+       "osd", "rw", "cli,rest")
+COMMAND("osd crush weight-set rm-compat",
+       "remove the backward-compatible weight-set",
+       "osd", "rw", "cli,rest")
+COMMAND("osd crush weight-set reweight "               \
+        "name=pool,type=CephPoolname "                 \
+       "name=item,type=CephString "                    \
+        "name=weight,type=CephFloat,range=0.0,n=N",
+       "set weight for an item (bucket or osd) in a pool's weight-set",
+       "osd", "rw", "cli,rest")
+COMMAND("osd crush weight-set reweight-compat "                \
+       "name=item,type=CephString "                    \
+        "name=weight,type=CephFloat,range=0.0,n=N",
+       "set weight for an item (bucket or osd) in the backward-compatible weight-set",
+       "osd", "rw", "cli,rest")
 COMMAND("osd setmaxosd " \
        "name=newmax,type=CephInt,range=0", \
        "set new maximum osd value", "osd", "rw", "cli,rest")
@@ -683,7 +725,7 @@ COMMAND("osd erasure-code-profile ls", \
        "list all erasure code profiles", \
        "osd", "r", "cli,rest")
 COMMAND("osd set " \
-       "name=key,type=CephChoices,strings=full|pause|noup|nodown|noout|noin|nobackfill|norebalance|norecover|noscrub|nodeep-scrub|notieragent|sortbitwise|require_jewel_osds|require_kraken_osds", \
+       "name=key,type=CephChoices,strings=full|pause|noup|nodown|noout|noin|nobackfill|norebalance|norecover|noscrub|nodeep-scrub|notieragent|sortbitwise|recovery_deletes|require_jewel_osds|require_kraken_osds", \
        "set <key>", "osd", "rw", "cli,rest")
 COMMAND("osd unset " \
        "name=key,type=CephChoices,strings=full|pause|noup|nodown|noout|noin|nobackfill|norebalance|norecover|noscrub|nodeep-scrub|notieragent", \
@@ -766,6 +808,10 @@ COMMAND("osd reweightn " \
        "name=weights,type=CephString",
        "reweight osds with {<id>: <weight>,...})",
        "osd", "rw", "cli,rest")
+COMMAND("osd force-create-pg " \
+       "name=pgid,type=CephPgid ",
+       "force creation of pg <pgid>",
+        "osd", "rw", "cli,rest")
 COMMAND("osd pg-temp " \
        "name=pgid,type=CephPgid " \
        "name=id,type=CephOsdName,n=N,req=false", \
@@ -835,6 +881,9 @@ COMMAND("osd blacklist " \
        "name=expire,type=CephFloat,range=0.0,req=false", \
        "add (optionally until <expire> seconds from now) or remove <addr> from blacklist", \
        "osd", "rw", "cli,rest")
+COMMAND("osd blacklist ls", "show blacklisted clients", "osd", "r", "cli,rest")
+COMMAND("osd blacklist clear", "clear all blacklisted clients", "osd", "rw",
+        "cli,rest")
 COMMAND("osd pool mksnap " \
        "name=pool,type=CephPoolname " \
        "name=snap,type=CephString", \
@@ -893,6 +942,31 @@ COMMAND("osd pool get-quota " \
         "name=pool,type=CephPoolname ",
         "obtain object or byte limits for pool",
         "osd", "r", "cli,rest")
+COMMAND("osd pool application enable " \
+        "name=pool,type=CephPoolname " \
+        "name=app,type=CephString,goodchars=[A-Za-z0-9-_.] " \
+       "name=force,type=CephChoices,strings=--yes-i-really-mean-it,req=false", \
+        "enable use of an application <app> [cephfs,rbd,rgw] on pool <poolname>",
+        "osd", "rw", "cli,rest")
+COMMAND("osd pool application disable " \
+        "name=pool,type=CephPoolname " \
+        "name=app,type=CephString " \
+       "name=force,type=CephChoices,strings=--yes-i-really-mean-it,req=false", \
+        "disables use of an application <app> on pool <poolname>",
+        "osd", "rw", "cli,rest")
+COMMAND("osd pool application set " \
+        "name=pool,type=CephPoolname " \
+        "name=app,type=CephString " \
+        "name=key,type=CephString,goodchars=[A-Za-z0-9-_.] " \
+        "name=value,type=CephString,goodchars=[A-Za-z0-9-_.=]",
+        "sets application <app> metadata key <key> to <value> on pool <poolname>",
+        "osd", "rw", "cli,rest")
+COMMAND("osd pool application rm " \
+        "name=pool,type=CephPoolname " \
+        "name=app,type=CephString " \
+        "name=key,type=CephString",
+        "removes application <app> metadata key <key> on pool <poolname>",
+        "osd", "rw", "cli,rest")
 COMMAND("osd utilization",
        "get basic pg distribution stats",
        "osd", "r", "cli,rest")
@@ -944,10 +1018,15 @@ COMMAND("osd tier add-cache " \
 COMMAND("config-key get " \
        "name=key,type=CephString", \
        "get <key>", "config-key", "r", "cli,rest")
-COMMAND("config-key put " \
+COMMAND("config-key set " \
        "name=key,type=CephString " \
        "name=val,type=CephString,req=false", \
-       "put <key>, value <val>", "config-key", "rw", "cli,rest")
+       "set <key> to value <val>", "config-key", "rw", "cli,rest")
+COMMAND_WITH_FLAG("config-key put " \
+                 "name=key,type=CephString " \
+                 "name=val,type=CephString,req=false",                 \
+                 "put <key>, value <val>", "config-key", "rw", "cli,rest",
+                 FLAG(DEPRECATED))
 COMMAND("config-key del " \
        "name=key,type=CephString", \
        "delete <key>", "config-key", "rw", "cli,rest")
@@ -957,7 +1036,9 @@ COMMAND("config-key rm " \
 COMMAND("config-key exists " \
        "name=key,type=CephString", \
        "check for <key>'s existence", "config-key", "r", "cli,rest")
-COMMAND("config-key list ", "list keys", "config-key", "r", "cli,rest")
+COMMAND_WITH_FLAG("config-key list ", "list keys", "config-key", "r", "cli,rest",
+                 FLAG(DEPRECATED))
+COMMAND("config-key ls ", "list keys", "config-key", "r", "cli,rest")
 COMMAND("config-key dump", "dump keys and values", "config-key", "r", "cli,rest")
 
 
@@ -979,3 +1060,12 @@ COMMAND("mgr module enable "                                              \
 COMMAND("mgr module disable "                                          \
        "name=module,type=CephString",
        "disable mgr module", "mgr", "rw", "cli,rest")
+COMMAND("mgr metadata name=id,type=CephString,req=false",
+       "dump metadata for all daemons or a specific daemon",
+       "mgr", "r", "cli,rest")
+COMMAND("mgr count-metadata name=property,type=CephString",
+       "count ceph-mgr daemons by metadata field property",
+       "mgr", "r", "cli,rest")
+COMMAND("mgr versions", \
+       "check running versions of ceph-mgr daemons",
+       "mgr", "r", "cli,rest")