learning_go/ceph/commands.txt
a.pivkin c5bc4da2c3 sdf
2025-09-08 07:26:27 +03:00

14890 lines
245 KiB
Plaintext

{
"cmd000": {
"flags": 8,
"help": "show placement group status.",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"stat"
]
},
"cmd001": {
"flags": 8,
"help": "get binary pg map to -o/stdout",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"getmap"
]
},
"cmd002": {
"flags": 8,
"help": "show human-readable versions of pg map (only 'all' valid with plain)",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"dump",
{
"n": "N",
"name": "dumpcontents",
"req": false,
"strings": "all|summary|sum|delta|pools|osds|pgs|pgs_brief",
"type": "CephChoices"
}
]
},
"cmd003": {
"flags": 8,
"help": "show human-readable version of pg map in json only",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"dump_json",
{
"n": "N",
"name": "dumpcontents",
"req": false,
"strings": "all|summary|sum|pools|osds|pgs",
"type": "CephChoices"
}
]
},
"cmd004": {
"flags": 8,
"help": "show pg pools info in json only",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"dump_pools_json"
]
},
"cmd005": {
"flags": 8,
"help": "list pg with pool = [poolname]",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"ls-by-pool",
{
"name": "poolstr",
"type": "CephString"
},
{
"n": "N",
"name": "states",
"req": false,
"type": "CephString"
}
]
},
"cmd006": {
"flags": 8,
"help": "list pg with primary = [osd]",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"ls-by-primary",
{
"name": "osd",
"type": "CephOsdName"
},
{
"name": "pool",
"req": false,
"type": "CephInt"
},
{
"n": "N",
"name": "states",
"req": false,
"type": "CephString"
}
]
},
"cmd007": {
"flags": 8,
"help": "list pg on osd [osd]",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"ls-by-osd",
{
"name": "osd",
"type": "CephOsdName"
},
{
"name": "pool",
"req": false,
"type": "CephInt"
},
{
"n": "N",
"name": "states",
"req": false,
"type": "CephString"
}
]
},
"cmd008": {
"flags": 8,
"help": "list pg with specific pool, osd, state",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"ls",
{
"name": "pool",
"req": false,
"type": "CephInt"
},
{
"n": "N",
"name": "states",
"req": false,
"type": "CephString"
}
]
},
"cmd009": {
"flags": 8,
"help": "show information about stuck pgs",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"dump_stuck",
{
"n": "N",
"name": "stuckops",
"req": false,
"strings": "inactive|unclean|stale|undersized|degraded",
"type": "CephChoices"
},
{
"name": "threshold",
"req": false,
"type": "CephInt"
}
]
},
"cmd010": {
"flags": 8,
"help": "show debug info about pgs",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"debug",
{
"name": "debugop",
"strings": "unfound_objects_exist|degraded_pgs_exist",
"type": "CephChoices"
}
]
},
"cmd011": {
"flags": 8,
"help": "start scrub on \u003cpgid\u003e",
"module": "pg",
"perm": "rw",
"sig": [
"pg",
"scrub",
{
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd012": {
"flags": 8,
"help": "start deep-scrub on \u003cpgid\u003e",
"module": "pg",
"perm": "rw",
"sig": [
"pg",
"deep-scrub",
{
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd013": {
"flags": 8,
"help": "start repair on \u003cpgid\u003e",
"module": "pg",
"perm": "rw",
"sig": [
"pg",
"repair",
{
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd014": {
"flags": 8,
"help": "force recovery of \u003cpgid\u003e first",
"module": "pg",
"perm": "rw",
"sig": [
"pg",
"force-recovery",
{
"n": "N",
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd015": {
"flags": 8,
"help": "force backfill of \u003cpgid\u003e first",
"module": "pg",
"perm": "rw",
"sig": [
"pg",
"force-backfill",
{
"n": "N",
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd016": {
"flags": 8,
"help": "restore normal recovery priority of \u003cpgid\u003e",
"module": "pg",
"perm": "rw",
"sig": [
"pg",
"cancel-force-recovery",
{
"n": "N",
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd017": {
"flags": 8,
"help": "restore normal backfill priority of \u003cpgid\u003e",
"module": "pg",
"perm": "rw",
"sig": [
"pg",
"cancel-force-backfill",
{
"n": "N",
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd018": {
"flags": 8,
"help": "print dump of OSD perf summary stats",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"perf"
]
},
"cmd019": {
"flags": 8,
"help": "show OSD utilization",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"df",
{
"name": "output_method",
"req": false,
"strings": "plain|tree",
"type": "CephChoices"
},
{
"name": "filter_by",
"req": false,
"strings": "class|name",
"type": "CephChoices"
},
{
"name": "filter",
"req": false,
"type": "CephString"
}
]
},
"cmd020": {
"flags": 8,
"help": "print histogram of which OSDs are blocking their peers",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"blocked-by"
]
},
"cmd021": {
"flags": 8,
"help": "obtain stats from all pools, or from specified pool",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"pool",
"stats",
{
"name": "pool_name",
"req": false,
"type": "CephPoolname"
}
]
},
"cmd022": {
"flags": 8,
"help": "initiate scrub on pool \u003cwho\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"scrub",
{
"n": "N",
"name": "who",
"type": "CephPoolname"
}
]
},
"cmd023": {
"flags": 8,
"help": "initiate deep-scrub on pool \u003cwho\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"deep-scrub",
{
"n": "N",
"name": "who",
"type": "CephPoolname"
}
]
},
"cmd024": {
"flags": 8,
"help": "initiate repair on pool \u003cwho\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"repair",
{
"n": "N",
"name": "who",
"type": "CephPoolname"
}
]
},
"cmd025": {
"flags": 8,
"help": "force recovery of specified pool \u003cwho\u003e first",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"force-recovery",
{
"n": "N",
"name": "who",
"type": "CephPoolname"
}
]
},
"cmd026": {
"flags": 8,
"help": "force backfill of specified pool \u003cwho\u003e first",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"force-backfill",
{
"n": "N",
"name": "who",
"type": "CephPoolname"
}
]
},
"cmd027": {
"flags": 8,
"help": "restore normal recovery priority of specified pool \u003cwho\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"cancel-force-recovery",
{
"n": "N",
"name": "who",
"type": "CephPoolname"
}
]
},
"cmd028": {
"flags": 8,
"help": "restore normal recovery priority of specified pool \u003cwho\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"cancel-force-backfill",
{
"n": "N",
"name": "who",
"type": "CephPoolname"
}
]
},
"cmd029": {
"flags": 8,
"help": "reweight OSDs by utilization [overload-percentage-for-consideration, default 120]",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"reweight-by-utilization",
{
"name": "oload",
"req": false,
"type": "CephInt"
},
{
"name": "max_change",
"req": false,
"type": "CephFloat"
},
{
"name": "max_osds",
"req": false,
"type": "CephInt"
},
{
"name": "no_increasing",
"req": false,
"type": "CephBool"
}
]
},
"cmd030": {
"flags": 8,
"help": "dry run of reweight OSDs by utilization [overload-percentage-for-consideration, default 120]",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"test-reweight-by-utilization",
{
"name": "oload",
"req": false,
"type": "CephInt"
},
{
"name": "max_change",
"req": false,
"type": "CephFloat"
},
{
"name": "max_osds",
"req": false,
"type": "CephInt"
},
{
"name": "no_increasing",
"req": false,
"type": "CephBool"
}
]
},
"cmd031": {
"flags": 8,
"help": "reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"reweight-by-pg",
{
"name": "oload",
"req": false,
"type": "CephInt"
},
{
"name": "max_change",
"req": false,
"type": "CephFloat"
},
{
"name": "max_osds",
"req": false,
"type": "CephInt"
},
{
"n": "N",
"name": "pools",
"req": false,
"type": "CephPoolname"
}
]
},
"cmd032": {
"flags": 8,
"help": "dry run of reweight OSDs by PG distribution [overload-percentage-for-consideration, default 120]",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"test-reweight-by-pg",
{
"name": "oload",
"req": false,
"type": "CephInt"
},
{
"name": "max_change",
"req": false,
"type": "CephFloat"
},
{
"name": "max_osds",
"req": false,
"type": "CephInt"
},
{
"n": "N",
"name": "pools",
"req": false,
"type": "CephPoolname"
}
]
},
"cmd033": {
"flags": 8,
"help": "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.",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"destroy",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "force",
"req": false,
"type": "CephBool"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd034": {
"flags": 8,
"help": "purge all osd data from the monitors including the OSD id and CRUSH position",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"purge",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "force",
"req": false,
"type": "CephBool"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd035": {
"flags": 8,
"help": "check whether osd(s) can be safely destroyed without reducing data durability",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"safe-to-destroy",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd036": {
"flags": 8,
"help": "check whether osd(s) can be safely stopped without reducing immediate data availability",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"ok-to-stop",
{
"n": "N",
"name": "ids",
"type": "CephString"
},
{
"name": "max",
"req": false,
"type": "CephInt"
}
]
},
"cmd037": {
"flags": 8,
"help": "initiate scrub on osd \u003cwho\u003e, or use \u003call|any\u003e to scrub all",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"scrub",
{
"name": "who",
"type": "CephString"
}
]
},
"cmd038": {
"flags": 8,
"help": "initiate deep scrub on osd \u003cwho\u003e, or use \u003call|any\u003e to deep scrub all",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"deep-scrub",
{
"name": "who",
"type": "CephString"
}
]
},
"cmd039": {
"flags": 8,
"help": "initiate repair on osd \u003cwho\u003e, or use \u003call|any\u003e to repair all",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"repair",
{
"name": "who",
"type": "CephString"
}
]
},
"cmd040": {
"flags": 8,
"help": "dump service map",
"module": "service",
"perm": "r",
"sig": [
"service",
"dump"
]
},
"cmd041": {
"flags": 8,
"help": "dump service state",
"module": "service",
"perm": "r",
"sig": [
"service",
"status"
]
},
"cmd042": {
"flags": 8,
"help": "Show running configuration",
"module": "mgr",
"perm": "r",
"sig": [
"config",
"show",
{
"name": "who",
"type": "CephString"
},
{
"name": "key",
"req": false,
"type": "CephString"
}
]
},
"cmd043": {
"flags": 8,
"help": "Show running configuration (including compiled-in defaults)",
"module": "mgr",
"perm": "r",
"sig": [
"config",
"show-with-defaults",
{
"name": "who",
"type": "CephString"
}
]
},
"cmd044": {
"flags": 8,
"help": "Show devices",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"ls"
]
},
"cmd045": {
"flags": 8,
"help": "Show information about a device",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"info",
{
"name": "devid",
"type": "CephString"
}
]
},
"cmd046": {
"flags": 8,
"help": "Show devices associated with a daemon",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"ls-by-daemon",
{
"name": "who",
"type": "CephString"
}
]
},
"cmd047": {
"flags": 8,
"help": "Show devices on a host",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"ls-by-host",
{
"name": "host",
"type": "CephString"
}
]
},
"cmd048": {
"flags": 8,
"help": "Set predicted device life expectancy",
"module": "mgr",
"perm": "rw",
"sig": [
"device",
"set-life-expectancy",
{
"name": "devid",
"type": "CephString"
},
{
"name": "from",
"type": "CephString"
},
{
"name": "to",
"req": false,
"type": "CephString"
}
]
},
"cmd049": {
"flags": 8,
"help": "Clear predicted device life expectancy",
"module": "mgr",
"perm": "rw",
"sig": [
"device",
"rm-life-expectancy",
{
"name": "devid",
"type": "CephString"
}
]
},
"cmd050": {
"flags": 8,
"help": "(re)send alerts immediately",
"module": "mgr",
"perm": "r",
"sig": [
"alerts",
"send"
]
},
"cmd051": {
"flags": 8,
"help": "Show balancer status",
"module": "mgr",
"perm": "r",
"sig": [
"balancer",
"status"
]
},
"cmd052": {
"flags": 8,
"help": "Set balancer mode",
"module": "mgr",
"perm": "rw",
"sig": [
"balancer",
"mode",
{
"name": "mode",
"strings": "none|crush-compat|upmap",
"type": "CephChoices"
}
]
},
"cmd053": {
"flags": 8,
"help": "Enable automatic balancing",
"module": "mgr",
"perm": "rw",
"sig": [
"balancer",
"on"
]
},
"cmd054": {
"flags": 8,
"help": "Disable automatic balancing",
"module": "mgr",
"perm": "rw",
"sig": [
"balancer",
"off"
]
},
"cmd055": {
"flags": 8,
"help": "List automatic balancing pools Note that empty list means all existing pools will be automatic balancing targets, which is the default behaviour of balancer.",
"module": "mgr",
"perm": "r",
"sig": [
"balancer",
"pool",
"ls"
]
},
"cmd056": {
"flags": 8,
"help": "Enable automatic balancing for specific pools",
"module": "mgr",
"perm": "rw",
"sig": [
"balancer",
"pool",
"add",
{
"n": "N",
"name": "pools",
"type": "CephString"
}
]
},
"cmd057": {
"flags": 8,
"help": "Disable automatic balancing for specific pools",
"module": "mgr",
"perm": "rw",
"sig": [
"balancer",
"pool",
"rm",
{
"n": "N",
"name": "pools",
"type": "CephString"
}
]
},
"cmd058": {
"flags": 8,
"help": "Evaluate data distribution for the current cluster or specific pool or specific plan (verbosely)",
"module": "mgr",
"perm": "r",
"sig": [
"balancer",
"eval-verbose",
{
"name": "option",
"req": false,
"type": "CephString"
}
]
},
"cmd059": {
"flags": 8,
"help": "Evaluate data distribution for the current cluster or specific pool or specific plan",
"module": "mgr",
"perm": "r",
"sig": [
"balancer",
"eval",
{
"name": "option",
"req": false,
"type": "CephString"
}
]
},
"cmd060": {
"flags": 8,
"help": "Run optimizer to create a new plan",
"module": "mgr",
"perm": "r",
"sig": [
"balancer",
"optimize",
{
"name": "plan",
"type": "CephString"
},
{
"n": "N",
"name": "pools",
"req": false,
"type": "CephString"
}
]
},
"cmd061": {
"flags": 8,
"help": "Show details of an optimization plan",
"module": "mgr",
"perm": "r",
"sig": [
"balancer",
"show",
{
"name": "plan",
"type": "CephString"
}
]
},
"cmd062": {
"flags": 8,
"help": "Discard an optimization plan",
"module": "mgr",
"perm": "rw",
"sig": [
"balancer",
"rm",
{
"name": "plan",
"type": "CephString"
}
]
},
"cmd063": {
"flags": 8,
"help": "Discard all optimization plans",
"module": "mgr",
"perm": "rw",
"sig": [
"balancer",
"reset"
]
},
"cmd064": {
"flags": 8,
"help": "Show an optimization plan",
"module": "mgr",
"perm": "r",
"sig": [
"balancer",
"dump",
{
"name": "plan",
"type": "CephString"
}
]
},
"cmd065": {
"flags": 8,
"help": "List all plans",
"module": "mgr",
"perm": "r",
"sig": [
"balancer",
"ls"
]
},
"cmd066": {
"flags": 8,
"help": "Execute an optimization plan",
"module": "mgr",
"perm": "r",
"sig": [
"balancer",
"execute",
{
"name": "plan",
"type": "CephString"
}
]
},
"cmd067": {
"flags": 8,
"help": "Set the ssh_config file (use -i \u003cssh_config\u003e)",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"set-ssh-config"
]
},
"cmd068": {
"flags": 8,
"help": "Clear the ssh_config file",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"clear-ssh-config"
]
},
"cmd069": {
"flags": 8,
"help": "Returns the ssh config as used by cephadm",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"get-ssh-config"
]
},
"cmd070": {
"flags": 8,
"help": "Generate a cluster SSH key (if not present)",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"generate-key"
]
},
"cmd071": {
"flags": 8,
"help": "Set cluster SSH private key (use -i \u003cprivate_key\u003e)",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"set-priv-key"
]
},
"cmd072": {
"flags": 8,
"help": "Set cluster SSH public key (use -i \u003cpublic_key\u003e)",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"set-pub-key"
]
},
"cmd073": {
"flags": 8,
"help": "Set a signed cert if CA signed keys are being used (use -i \u003ccert_filename\u003e)",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"set-signed-cert"
]
},
"cmd074": {
"flags": 8,
"help": "Clear cluster SSH key",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"clear-key"
]
},
"cmd075": {
"flags": 8,
"help": "Show SSH public key for connecting to cluster hosts",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"get-pub-key"
]
},
"cmd076": {
"flags": 8,
"help": "Show SSH signed cert for connecting to cluster hosts using CA signed keys",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"get-signed-cert"
]
},
"cmd077": {
"flags": 8,
"help": "Show user for SSHing to cluster hosts",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"get-user"
]
},
"cmd078": {
"flags": 8,
"help": "Set user for SSHing to cluster hosts, passwordless sudo will be needed for non-root users",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"set-user",
{
"name": "user",
"type": "CephString"
}
]
},
"cmd079": {
"flags": 8,
"help": "Set custom registry login info by providing url, username and password or json file with login info (-i \u003cfile\u003e)",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"registry-login",
{
"name": "url",
"req": false,
"type": "CephString"
},
{
"name": "username",
"req": false,
"type": "CephString"
},
{
"name": "password",
"req": false,
"type": "CephString"
}
]
},
"cmd080": {
"flags": 8,
"help": "Check whether we can access and manage a remote host",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"check-host",
{
"name": "host",
"type": "CephString"
},
{
"name": "addr",
"req": false,
"type": "CephString"
}
]
},
"cmd081": {
"flags": 8,
"help": "Prepare a remote host for use with cephadm",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"prepare-host",
{
"name": "host",
"type": "CephString"
},
{
"name": "addr",
"req": false,
"type": "CephString"
}
]
},
"cmd082": {
"flags": 8,
"help": "Text that is appended to all daemon's ceph.conf. Mainly a workaround, till `config generate-minimal-conf` generates a complete ceph.conf. Warning: this is a dangerous operation.",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"set-extra-ceph-conf"
]
},
"cmd083": {
"flags": 8,
"help": "Get extra ceph conf that is appended",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"get-extra-ceph-conf"
]
},
"cmd084": {
"flags": 8,
"help": "List the available configuration checks and their current state",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"config-check",
"ls",
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
}
]
},
"cmd085": {
"flags": 8,
"help": "Show whether the configuration checker feature is enabled/disabled",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"config-check",
"status"
]
},
"cmd086": {
"flags": 8,
"help": "Enable a specific configuration check",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"config-check",
"enable",
{
"name": "check_name",
"type": "CephString"
}
]
},
"cmd087": {
"flags": 8,
"help": "Disable a specific configuration check",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"config-check",
"disable",
{
"name": "check_name",
"type": "CephString"
}
]
},
"cmd088": {
"flags": 8,
"help": "Start OSD containers for existing OSDs",
"module": "mgr",
"perm": "rw",
"sig": [
"cephadm",
"osd",
"activate",
{
"n": "N",
"name": "host",
"type": "CephString"
}
]
},
"cmd089": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "r",
"sig": [
"cephadm",
"systemd-unit",
"ls",
{
"name": "hostname",
"req": false,
"type": "CephString"
},
{
"name": "daemon_type",
"req": false,
"type": "CephString"
},
{
"name": "daemon_id",
"req": false,
"type": "CephString"
}
]
},
"cmd090": {
"flags": 8,
"help": "List client keyrings under cephadm management",
"module": "mgr",
"perm": "r",
"sig": [
"orch",
"client-keyring",
"ls",
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
}
]
},
"cmd091": {
"flags": 8,
"help": "Add or update client keyring under cephadm management",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"client-keyring",
"set",
{
"name": "entity",
"type": "CephString"
},
{
"name": "placement",
"type": "CephString"
},
{
"name": "owner",
"req": false,
"type": "CephString"
},
{
"name": "mode",
"req": false,
"type": "CephString"
},
{
"name": "no_ceph_conf",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd092": {
"flags": 8,
"help": "Remove client keyring from cephadm management",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"client-keyring",
"rm",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd093": {
"flags": 8,
"help": "show crash dump metadata",
"module": "mgr",
"perm": "r",
"sig": [
"crash",
"info",
{
"name": "id",
"type": "CephString"
}
]
},
"cmd094": {
"flags": 8,
"help": "Add a crash dump (use -i \u003cjsonfile\u003e)",
"module": "mgr",
"perm": "rw",
"sig": [
"crash",
"post"
]
},
"cmd095": {
"flags": 8,
"help": "Show new and archived crash dumps",
"module": "mgr",
"perm": "r",
"sig": [
"crash",
"ls",
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd096": {
"flags": 8,
"help": "Show new crash dumps",
"module": "mgr",
"perm": "r",
"sig": [
"crash",
"ls-new",
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd097": {
"flags": 8,
"help": "Remove a saved crash \u003cid\u003e",
"module": "mgr",
"perm": "rw",
"sig": [
"crash",
"rm",
{
"name": "id",
"type": "CephString"
}
]
},
"cmd098": {
"flags": 8,
"help": "Remove crashes older than \u003ckeep\u003e days",
"module": "mgr",
"perm": "rw",
"sig": [
"crash",
"prune",
{
"name": "keep",
"type": "CephInt"
}
]
},
"cmd099": {
"flags": 8,
"help": "Acknowledge a crash and silence health warning(s)",
"module": "mgr",
"perm": "w",
"sig": [
"crash",
"archive",
{
"name": "id",
"type": "CephString"
}
]
},
"cmd100": {
"flags": 8,
"help": "Acknowledge all new crashes and silence health warning(s)",
"module": "mgr",
"perm": "w",
"sig": [
"crash",
"archive-all"
]
},
"cmd101": {
"flags": 8,
"help": "Summarize recorded crashes",
"module": "mgr",
"perm": "r",
"sig": [
"crash",
"stat"
]
},
"cmd102": {
"flags": 8,
"help": "Crashes in the last \u003chours\u003e hours",
"module": "mgr",
"perm": "r",
"sig": [
"crash",
"json_report",
{
"name": "hours",
"type": "CephInt"
}
]
},
"cmd103": {
"flags": 8,
"help": "Set the JWT token TTL in seconds",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-jwt-token-ttl",
{
"name": "seconds",
"type": "CephInt"
}
]
},
"cmd104": {
"flags": 8,
"help": "Get the JWT token TTL in seconds",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-jwt-token-ttl"
]
},
"cmd105": {
"flags": 8,
"help": "Create self signed certificate",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"create-self-signed-cert"
]
},
"cmd106": {
"flags": 8,
"help": "Push dashboards to Grafana",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"grafana",
"dashboards",
"update"
]
},
"cmd107": {
"flags": 8,
"help": "Get the ACCOUNT_LOCKOUT_ATTEMPTS option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-account-lockout-attempts"
]
},
"cmd108": {
"flags": 8,
"help": "Set the ACCOUNT_LOCKOUT_ATTEMPTS option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-account-lockout-attempts",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd109": {
"flags": 8,
"help": "Reset the ACCOUNT_LOCKOUT_ATTEMPTS option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-account-lockout-attempts"
]
},
"cmd110": {
"flags": 8,
"help": "Get the ALERTMANAGER_API_HOST option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-alertmanager-api-host"
]
},
"cmd111": {
"flags": 8,
"help": "Set the ALERTMANAGER_API_HOST option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-alertmanager-api-host",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd112": {
"flags": 8,
"help": "Reset the ALERTMANAGER_API_HOST option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-alertmanager-api-host"
]
},
"cmd113": {
"flags": 8,
"help": "Get the ALERTMANAGER_API_SSL_VERIFY option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-alertmanager-api-ssl-verify"
]
},
"cmd114": {
"flags": 8,
"help": "Set the ALERTMANAGER_API_SSL_VERIFY option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-alertmanager-api-ssl-verify",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd115": {
"flags": 8,
"help": "Reset the ALERTMANAGER_API_SSL_VERIFY option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-alertmanager-api-ssl-verify"
]
},
"cmd116": {
"flags": 8,
"help": "Get the AUDIT_API_ENABLED option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-audit-api-enabled"
]
},
"cmd117": {
"flags": 8,
"help": "Set the AUDIT_API_ENABLED option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-audit-api-enabled",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd118": {
"flags": 8,
"help": "Reset the AUDIT_API_ENABLED option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-audit-api-enabled"
]
},
"cmd119": {
"flags": 8,
"help": "Get the AUDIT_API_LOG_PAYLOAD option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-audit-api-log-payload"
]
},
"cmd120": {
"flags": 8,
"help": "Set the AUDIT_API_LOG_PAYLOAD option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-audit-api-log-payload",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd121": {
"flags": 8,
"help": "Reset the AUDIT_API_LOG_PAYLOAD option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-audit-api-log-payload"
]
},
"cmd122": {
"flags": 8,
"help": "Get the ENABLE_BROWSABLE_API option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-enable-browsable-api"
]
},
"cmd123": {
"flags": 8,
"help": "Set the ENABLE_BROWSABLE_API option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-enable-browsable-api",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd124": {
"flags": 8,
"help": "Reset the ENABLE_BROWSABLE_API option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-enable-browsable-api"
]
},
"cmd125": {
"flags": 8,
"help": "Get the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-ganesha-clusters-rados-pool-namespace"
]
},
"cmd126": {
"flags": 8,
"help": "Set the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-ganesha-clusters-rados-pool-namespace",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd127": {
"flags": 8,
"help": "Reset the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-ganesha-clusters-rados-pool-namespace"
]
},
"cmd128": {
"flags": 8,
"help": "Get the GRAFANA_API_PASSWORD option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-grafana-api-password"
]
},
"cmd129": {
"flags": 8,
"help": "Set the GRAFANA_API_PASSWORD option value read from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-grafana-api-password"
]
},
"cmd130": {
"flags": 8,
"help": "Reset the GRAFANA_API_PASSWORD option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-grafana-api-password"
]
},
"cmd131": {
"flags": 8,
"help": "Get the GRAFANA_API_SSL_VERIFY option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-grafana-api-ssl-verify"
]
},
"cmd132": {
"flags": 8,
"help": "Set the GRAFANA_API_SSL_VERIFY option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-grafana-api-ssl-verify",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd133": {
"flags": 8,
"help": "Reset the GRAFANA_API_SSL_VERIFY option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-grafana-api-ssl-verify"
]
},
"cmd134": {
"flags": 8,
"help": "Get the GRAFANA_API_URL option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-grafana-api-url"
]
},
"cmd135": {
"flags": 8,
"help": "Set the GRAFANA_API_URL option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-grafana-api-url",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd136": {
"flags": 8,
"help": "Reset the GRAFANA_API_URL option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-grafana-api-url"
]
},
"cmd137": {
"flags": 8,
"help": "Get the GRAFANA_API_USERNAME option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-grafana-api-username"
]
},
"cmd138": {
"flags": 8,
"help": "Set the GRAFANA_API_USERNAME option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-grafana-api-username",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd139": {
"flags": 8,
"help": "Reset the GRAFANA_API_USERNAME option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-grafana-api-username"
]
},
"cmd140": {
"flags": 8,
"help": "Get the GRAFANA_FRONTEND_API_URL option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-grafana-frontend-api-url"
]
},
"cmd141": {
"flags": 8,
"help": "Set the GRAFANA_FRONTEND_API_URL option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-grafana-frontend-api-url",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd142": {
"flags": 8,
"help": "Reset the GRAFANA_FRONTEND_API_URL option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-grafana-frontend-api-url"
]
},
"cmd143": {
"flags": 8,
"help": "Get the GRAFANA_UPDATE_DASHBOARDS option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-grafana-update-dashboards"
]
},
"cmd144": {
"flags": 8,
"help": "Set the GRAFANA_UPDATE_DASHBOARDS option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-grafana-update-dashboards",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd145": {
"flags": 8,
"help": "Reset the GRAFANA_UPDATE_DASHBOARDS option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-grafana-update-dashboards"
]
},
"cmd146": {
"flags": 8,
"help": "Get the ISCSI_API_SSL_VERIFICATION option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-iscsi-api-ssl-verification"
]
},
"cmd147": {
"flags": 8,
"help": "Set the ISCSI_API_SSL_VERIFICATION option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-iscsi-api-ssl-verification",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd148": {
"flags": 8,
"help": "Reset the ISCSI_API_SSL_VERIFICATION option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-iscsi-api-ssl-verification"
]
},
"cmd149": {
"flags": 8,
"help": "Get the ISSUE_TRACKER_API_KEY option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-issue-tracker-api-key"
]
},
"cmd150": {
"flags": 8,
"help": "Set the ISSUE_TRACKER_API_KEY option value read from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-issue-tracker-api-key"
]
},
"cmd151": {
"flags": 8,
"help": "Reset the ISSUE_TRACKER_API_KEY option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-issue-tracker-api-key"
]
},
"cmd152": {
"flags": 8,
"help": "Get the PROMETHEUS_API_HOST option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-prometheus-api-host"
]
},
"cmd153": {
"flags": 8,
"help": "Set the PROMETHEUS_API_HOST option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-prometheus-api-host",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd154": {
"flags": 8,
"help": "Reset the PROMETHEUS_API_HOST option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-prometheus-api-host"
]
},
"cmd155": {
"flags": 8,
"help": "Get the PROMETHEUS_API_SSL_VERIFY option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-prometheus-api-ssl-verify"
]
},
"cmd156": {
"flags": 8,
"help": "Set the PROMETHEUS_API_SSL_VERIFY option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-prometheus-api-ssl-verify",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd157": {
"flags": 8,
"help": "Reset the PROMETHEUS_API_SSL_VERIFY option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-prometheus-api-ssl-verify"
]
},
"cmd158": {
"flags": 8,
"help": "Get the PWD_POLICY_CHECK_COMPLEXITY_ENABLED option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-check-complexity-enabled"
]
},
"cmd159": {
"flags": 8,
"help": "Set the PWD_POLICY_CHECK_COMPLEXITY_ENABLED option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-check-complexity-enabled",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd160": {
"flags": 8,
"help": "Reset the PWD_POLICY_CHECK_COMPLEXITY_ENABLED option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-check-complexity-enabled"
]
},
"cmd161": {
"flags": 8,
"help": "Get the PWD_POLICY_CHECK_EXCLUSION_LIST_ENABLED option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-check-exclusion-list-enabled"
]
},
"cmd162": {
"flags": 8,
"help": "Set the PWD_POLICY_CHECK_EXCLUSION_LIST_ENABLED option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-check-exclusion-list-enabled",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd163": {
"flags": 8,
"help": "Reset the PWD_POLICY_CHECK_EXCLUSION_LIST_ENABLED option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-check-exclusion-list-enabled"
]
},
"cmd164": {
"flags": 8,
"help": "Get the PWD_POLICY_CHECK_LENGTH_ENABLED option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-check-length-enabled"
]
},
"cmd165": {
"flags": 8,
"help": "Set the PWD_POLICY_CHECK_LENGTH_ENABLED option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-check-length-enabled",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd166": {
"flags": 8,
"help": "Reset the PWD_POLICY_CHECK_LENGTH_ENABLED option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-check-length-enabled"
]
},
"cmd167": {
"flags": 8,
"help": "Get the PWD_POLICY_CHECK_OLDPWD_ENABLED option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-check-oldpwd-enabled"
]
},
"cmd168": {
"flags": 8,
"help": "Set the PWD_POLICY_CHECK_OLDPWD_ENABLED option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-check-oldpwd-enabled",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd169": {
"flags": 8,
"help": "Reset the PWD_POLICY_CHECK_OLDPWD_ENABLED option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-check-oldpwd-enabled"
]
},
"cmd170": {
"flags": 8,
"help": "Get the PWD_POLICY_CHECK_REPETITIVE_CHARS_ENABLED option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-check-repetitive-chars-enabled"
]
},
"cmd171": {
"flags": 8,
"help": "Set the PWD_POLICY_CHECK_REPETITIVE_CHARS_ENABLED option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-check-repetitive-chars-enabled",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd172": {
"flags": 8,
"help": "Reset the PWD_POLICY_CHECK_REPETITIVE_CHARS_ENABLED option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-check-repetitive-chars-enabled"
]
},
"cmd173": {
"flags": 8,
"help": "Get the PWD_POLICY_CHECK_SEQUENTIAL_CHARS_ENABLED option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-check-sequential-chars-enabled"
]
},
"cmd174": {
"flags": 8,
"help": "Set the PWD_POLICY_CHECK_SEQUENTIAL_CHARS_ENABLED option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-check-sequential-chars-enabled",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd175": {
"flags": 8,
"help": "Reset the PWD_POLICY_CHECK_SEQUENTIAL_CHARS_ENABLED option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-check-sequential-chars-enabled"
]
},
"cmd176": {
"flags": 8,
"help": "Get the PWD_POLICY_CHECK_USERNAME_ENABLED option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-check-username-enabled"
]
},
"cmd177": {
"flags": 8,
"help": "Set the PWD_POLICY_CHECK_USERNAME_ENABLED option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-check-username-enabled",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd178": {
"flags": 8,
"help": "Reset the PWD_POLICY_CHECK_USERNAME_ENABLED option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-check-username-enabled"
]
},
"cmd179": {
"flags": 8,
"help": "Get the PWD_POLICY_ENABLED option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-enabled"
]
},
"cmd180": {
"flags": 8,
"help": "Set the PWD_POLICY_ENABLED option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-enabled",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd181": {
"flags": 8,
"help": "Reset the PWD_POLICY_ENABLED option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-enabled"
]
},
"cmd182": {
"flags": 8,
"help": "Get the PWD_POLICY_EXCLUSION_LIST option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-exclusion-list"
]
},
"cmd183": {
"flags": 8,
"help": "Set the PWD_POLICY_EXCLUSION_LIST option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-exclusion-list",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd184": {
"flags": 8,
"help": "Reset the PWD_POLICY_EXCLUSION_LIST option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-exclusion-list"
]
},
"cmd185": {
"flags": 8,
"help": "Get the PWD_POLICY_MIN_COMPLEXITY option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-min-complexity"
]
},
"cmd186": {
"flags": 8,
"help": "Set the PWD_POLICY_MIN_COMPLEXITY option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-min-complexity",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd187": {
"flags": 8,
"help": "Reset the PWD_POLICY_MIN_COMPLEXITY option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-min-complexity"
]
},
"cmd188": {
"flags": 8,
"help": "Get the PWD_POLICY_MIN_LENGTH option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-pwd-policy-min-length"
]
},
"cmd189": {
"flags": 8,
"help": "Set the PWD_POLICY_MIN_LENGTH option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-pwd-policy-min-length",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd190": {
"flags": 8,
"help": "Reset the PWD_POLICY_MIN_LENGTH option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-pwd-policy-min-length"
]
},
"cmd191": {
"flags": 8,
"help": "Get the REST_REQUESTS_TIMEOUT option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-rest-requests-timeout"
]
},
"cmd192": {
"flags": 8,
"help": "Set the REST_REQUESTS_TIMEOUT option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-rest-requests-timeout",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd193": {
"flags": 8,
"help": "Reset the REST_REQUESTS_TIMEOUT option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-rest-requests-timeout"
]
},
"cmd194": {
"flags": 8,
"help": "Get the RGW_API_ACCESS_KEY option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-rgw-api-access-key"
]
},
"cmd195": {
"flags": 8,
"help": "Set the RGW_API_ACCESS_KEY option value read from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-rgw-api-access-key"
]
},
"cmd196": {
"flags": 8,
"help": "Reset the RGW_API_ACCESS_KEY option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-rgw-api-access-key"
]
},
"cmd197": {
"flags": 8,
"help": "Get the RGW_API_ADMIN_RESOURCE option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-rgw-api-admin-resource"
]
},
"cmd198": {
"flags": 8,
"help": "Set the RGW_API_ADMIN_RESOURCE option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-rgw-api-admin-resource",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd199": {
"flags": 8,
"help": "Reset the RGW_API_ADMIN_RESOURCE option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-rgw-api-admin-resource"
]
},
"cmd200": {
"flags": 8,
"help": "Get the RGW_API_SECRET_KEY option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-rgw-api-secret-key"
]
},
"cmd201": {
"flags": 8,
"help": "Set the RGW_API_SECRET_KEY option value read from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-rgw-api-secret-key"
]
},
"cmd202": {
"flags": 8,
"help": "Reset the RGW_API_SECRET_KEY option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-rgw-api-secret-key"
]
},
"cmd203": {
"flags": 8,
"help": "Get the RGW_API_SSL_VERIFY option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-rgw-api-ssl-verify"
]
},
"cmd204": {
"flags": 8,
"help": "Set the RGW_API_SSL_VERIFY option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-rgw-api-ssl-verify",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd205": {
"flags": 8,
"help": "Reset the RGW_API_SSL_VERIFY option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-rgw-api-ssl-verify"
]
},
"cmd206": {
"flags": 8,
"help": "Get the UNSAFE_TLS_v1_2 option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-unsafe-tls-v1-2"
]
},
"cmd207": {
"flags": 8,
"help": "Set the UNSAFE_TLS_v1_2 option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-unsafe-tls-v1-2",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd208": {
"flags": 8,
"help": "Reset the UNSAFE_TLS_v1_2 option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-unsafe-tls-v1-2"
]
},
"cmd209": {
"flags": 8,
"help": "Get the USER_PWD_EXPIRATION_SPAN option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-user-pwd-expiration-span"
]
},
"cmd210": {
"flags": 8,
"help": "Set the USER_PWD_EXPIRATION_SPAN option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-user-pwd-expiration-span",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd211": {
"flags": 8,
"help": "Reset the USER_PWD_EXPIRATION_SPAN option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-user-pwd-expiration-span"
]
},
"cmd212": {
"flags": 8,
"help": "Get the USER_PWD_EXPIRATION_WARNING_1 option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-user-pwd-expiration-warning-1"
]
},
"cmd213": {
"flags": 8,
"help": "Set the USER_PWD_EXPIRATION_WARNING_1 option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-user-pwd-expiration-warning-1",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd214": {
"flags": 8,
"help": "Reset the USER_PWD_EXPIRATION_WARNING_1 option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-user-pwd-expiration-warning-1"
]
},
"cmd215": {
"flags": 8,
"help": "Get the USER_PWD_EXPIRATION_WARNING_2 option value",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-user-pwd-expiration-warning-2"
]
},
"cmd216": {
"flags": 8,
"help": "Set the USER_PWD_EXPIRATION_WARNING_2 option value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-user-pwd-expiration-warning-2",
{
"name": "value",
"type": "CephString"
}
]
},
"cmd217": {
"flags": 8,
"help": "Reset the USER_PWD_EXPIRATION_WARNING_2 option to its default value",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"reset-user-pwd-expiration-warning-2"
]
},
"cmd218": {
"flags": 8,
"help": "Enable SAML2 Single Sign-On",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"sso",
"enable",
"saml2"
]
},
"cmd219": {
"flags": 8,
"help": "Disable Single Sign-On",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"sso",
"disable"
]
},
"cmd220": {
"flags": 8,
"help": "Get Single Sign-On status",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"sso",
"status"
]
},
"cmd221": {
"flags": 8,
"help": "Show SAML2 configuration",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"sso",
"show",
"saml2"
]
},
"cmd222": {
"flags": 8,
"help": "Setup SAML2 Single Sign-On",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"sso",
"setup",
"saml2",
{
"name": "ceph_dashboard_base_url",
"type": "CephString"
},
{
"name": "idp_metadata",
"type": "CephString"
},
{
"name": "idp_username_attribute",
"req": false,
"type": "CephString"
},
{
"name": "idp_entity_id",
"req": false,
"type": "CephString"
},
{
"name": "sp_x_509_cert",
"req": false,
"type": "CephFilepath"
},
{
"name": "sp_private_key",
"req": false,
"type": "CephFilepath"
}
]
},
"cmd223": {
"flags": 8,
"help": "Set the login credentials. Password read from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-login-credentials",
{
"name": "username",
"type": "CephString"
}
]
},
"cmd224": {
"flags": 8,
"help": "Show role info",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"ac-role-show",
{
"name": "rolename",
"req": false,
"type": "CephString"
}
]
},
"cmd225": {
"flags": 8,
"help": "Create a new access control role",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-role-create",
{
"name": "rolename",
"req": false,
"type": "CephString"
},
{
"name": "description",
"req": false,
"type": "CephString"
}
]
},
"cmd226": {
"flags": 8,
"help": "Delete an access control role",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-role-delete",
{
"name": "rolename",
"req": false,
"type": "CephString"
}
]
},
"cmd227": {
"flags": 8,
"help": "Add the scope permissions for a role",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-role-add-scope-perms",
{
"name": "rolename",
"type": "CephString"
},
{
"name": "scopename",
"type": "CephString"
},
{
"n": "N",
"name": "permissions",
"req": false,
"type": "CephString"
}
]
},
"cmd228": {
"flags": 8,
"help": "Delete the scope permissions for a role",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-role-del-scope-perms",
{
"name": "rolename",
"type": "CephString"
},
{
"name": "scopename",
"req": false,
"type": "CephString"
}
]
},
"cmd229": {
"flags": 8,
"help": "Show user info",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"ac-user-show",
{
"name": "username",
"req": false,
"type": "CephString"
}
]
},
"cmd230": {
"flags": 8,
"help": "Create a user. Password read from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-create",
{
"name": "username",
"type": "CephString"
},
{
"name": "rolename",
"req": false,
"type": "CephString"
},
{
"name": "name",
"req": false,
"type": "CephString"
},
{
"name": "email",
"req": false,
"type": "CephString"
},
{
"name": "enabled",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "force_password",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "pwd_expiration_date",
"positional": false,
"req": false,
"type": "CephInt"
},
{
"name": "pwd_update_required",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd231": {
"flags": 8,
"help": "Enable a user",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-enable",
{
"name": "username",
"req": false,
"type": "CephString"
}
]
},
"cmd232": {
"flags": 8,
"help": "Disable a user",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-disable",
{
"name": "username",
"req": false,
"type": "CephString"
}
]
},
"cmd233": {
"flags": 8,
"help": "Delete user",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-delete",
{
"name": "username",
"req": false,
"type": "CephString"
}
]
},
"cmd234": {
"flags": 8,
"help": "Set user roles",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-set-roles",
{
"name": "username",
"type": "CephString"
},
{
"n": "N",
"name": "roles",
"req": false,
"type": "CephString"
}
]
},
"cmd235": {
"flags": 8,
"help": "Add roles to user",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-add-roles",
{
"name": "username",
"type": "CephString"
},
{
"n": "N",
"name": "roles",
"req": false,
"type": "CephString"
}
]
},
"cmd236": {
"flags": 8,
"help": "Delete roles from user",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-del-roles",
{
"name": "username",
"type": "CephString"
},
{
"n": "N",
"name": "roles",
"req": false,
"type": "CephString"
}
]
},
"cmd237": {
"flags": 8,
"help": "Set user password from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-set-password",
{
"name": "username",
"type": "CephString"
},
{
"name": "force_password",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd238": {
"flags": 8,
"help": "Set user password bcrypt hash from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-set-password-hash",
{
"name": "username",
"type": "CephString"
}
]
},
"cmd239": {
"flags": 8,
"help": "Set user info",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"ac-user-set-info",
{
"name": "username",
"type": "CephString"
},
{
"name": "name",
"type": "CephString"
},
{
"name": "email",
"req": false,
"type": "CephString"
}
]
},
"cmd240": {
"flags": 8,
"help": "List iSCSI gateways",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"iscsi-gateway-list"
]
},
"cmd241": {
"flags": 8,
"help": "Add iSCSI gateway configuration. Gateway URL read from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"iscsi-gateway-add",
{
"name": "name",
"req": false,
"type": "CephString"
}
]
},
"cmd242": {
"flags": 8,
"help": "Remove iSCSI gateway configuration",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"iscsi-gateway-rm",
{
"name": "name",
"req": false,
"type": "CephString"
}
]
},
"cmd243": {
"flags": 8,
"help": "Control and report debug status in Ceph-Dashboard",
"module": "mgr",
"perm": "rw",
"sig": [
"dashboard",
"debug",
{
"name": "action",
"req": false,
"strings": "enable|disable|status",
"type": "CephChoices"
}
]
},
"cmd244": {
"flags": 8,
"help": "Enable or disable features in Ceph-Mgr Dashboard",
"module": "mgr",
"perm": "rw",
"sig": [
"dashboard",
"feature",
{
"name": "action",
"req": false,
"strings": "enable|disable|status",
"type": "CephChoices"
},
{
"n": "N",
"name": "features",
"req": false,
"strings": "rbd|mirroring|iscsi|cephfs|rgw|nfs|dashboard",
"type": "CephChoices"
}
]
},
"cmd245": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"dashboard",
"motd",
"get"
]
},
"cmd246": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"dashboard",
"motd",
"set",
{
"name": "severity",
"strings": "info|warning|danger",
"type": "CephChoices"
},
{
"name": "expires",
"type": "CephString"
},
{
"name": "message",
"req": false,
"type": "CephString"
}
]
},
"cmd247": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"dashboard",
"motd",
"clear"
]
},
"cmd248": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-ssl-certificate",
{
"name": "mgr_id",
"req": false,
"type": "CephString"
}
]
},
"cmd249": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-ssl-certificate-key",
{
"name": "mgr_id",
"req": false,
"type": "CephString"
}
]
},
"cmd250": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"create-self-signed-cert"
]
},
"cmd251": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-rgw-credentials"
]
},
"cmd252": {
"flags": 8,
"help": "Set the custom login banner read from -i \u003cfile\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"set-login-banner"
]
},
"cmd253": {
"flags": 8,
"help": "Get the custom login banner text",
"module": "mgr",
"perm": "r",
"sig": [
"dashboard",
"get-login-banner"
]
},
"cmd254": {
"flags": 8,
"help": "Unset the custom login banner",
"module": "mgr",
"perm": "w",
"sig": [
"dashboard",
"unset-login-banner"
]
},
"cmd255": {
"flags": 8,
"help": "Get device health metrics for a given daemon",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"query-daemon-health-metrics",
{
"name": "who",
"type": "CephString"
}
]
},
"cmd256": {
"flags": 8,
"help": "Scrape and store device health metrics for a given daemon",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"scrape-daemon-health-metrics",
{
"name": "who",
"type": "CephString"
}
]
},
"cmd257": {
"flags": 8,
"help": "Scrape and store device health metrics",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"scrape-health-metrics",
{
"name": "devid",
"req": false,
"type": "CephString"
}
]
},
"cmd258": {
"flags": 8,
"help": "Show stored device metrics for the device",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"get-health-metrics",
{
"name": "devid",
"type": "CephString"
},
{
"name": "sample",
"req": false,
"type": "CephString"
}
]
},
"cmd259": {
"flags": 8,
"help": "Check life expectancy of devices",
"module": "mgr",
"perm": "rw",
"sig": [
"device",
"check-health"
]
},
"cmd260": {
"flags": 8,
"help": "Enable device health monitoring",
"module": "mgr",
"perm": "rw",
"sig": [
"device",
"monitoring",
"on"
]
},
"cmd261": {
"flags": 8,
"help": "Disable device health monitoring",
"module": "mgr",
"perm": "rw",
"sig": [
"device",
"monitoring",
"off"
]
},
"cmd262": {
"flags": 8,
"help": "Predict life expectancy with local predictor",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"predict-life-expectancy",
{
"name": "devid",
"type": "CephString"
}
]
},
"cmd263": {
"flags": 8,
"help": "Set a configuration value",
"module": "mgr",
"perm": "rw",
"sig": [
"influx",
"config-set",
{
"name": "key",
"type": "CephString"
},
{
"name": "value",
"type": "CephString"
}
]
},
"cmd264": {
"flags": 8,
"help": "Show current configuration",
"module": "mgr",
"perm": "r",
"sig": [
"influx",
"config-show"
]
},
"cmd265": {
"flags": 8,
"help": "Force sending data to Influx",
"module": "mgr",
"perm": "rw",
"sig": [
"influx",
"send"
]
},
"cmd266": {
"flags": 8,
"help": "Show current configuration",
"module": "mgr",
"perm": "r",
"sig": [
"influx",
"config-show"
]
},
"cmd267": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "w",
"sig": [
"influx",
"config-set",
{
"name": "key",
"type": "CephString"
},
{
"name": "value",
"type": "CephString"
}
]
},
"cmd268": {
"flags": 8,
"help": "Force sending data to Influx",
"module": "mgr",
"perm": "rw",
"sig": [
"influx",
"send"
]
},
"cmd269": {
"flags": 8,
"help": "Retrieve insights report",
"module": "mgr",
"perm": "r",
"sig": [
"insights"
]
},
"cmd270": {
"flags": 8,
"help": "Remove health history older than \u003chours\u003e hours",
"module": "mgr",
"perm": "rw",
"sig": [
"insights",
"prune-health",
{
"name": "hours",
"req": false,
"type": "CephInt"
}
]
},
"cmd271": {
"flags": 24,
"help": "Get IO rates",
"module": "mgr",
"perm": "r",
"sig": [
"iostat",
{
"name": "width",
"req": false,
"type": "CephInt"
},
{
"name": "print_header",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd272": {
"flags": 8,
"help": "Show the status of the data gathering threads",
"module": "mgr",
"perm": "r",
"sig": [
"k8sevents",
"status"
]
},
"cmd273": {
"flags": 8,
"help": "List all current Kuberenetes events from the Ceph namespace",
"module": "mgr",
"perm": "r",
"sig": [
"k8sevents",
"ls"
]
},
"cmd274": {
"flags": 8,
"help": "List Ceph events tracked \u0026 sent to the kubernetes cluster",
"module": "mgr",
"perm": "r",
"sig": [
"k8sevents",
"ceph"
]
},
"cmd275": {
"flags": 8,
"help": "Set kubernetes access credentials. \u003ckey\u003e must be cacrt or token and use -i \u003cfilename\u003e syntax (e.g., ceph k8sevents set-access cacrt -i /root/ca.crt).",
"module": "mgr",
"perm": "rw",
"sig": [
"k8sevents",
"set-access",
{
"name": "key",
"type": "CephString"
}
]
},
"cmd276": {
"flags": 8,
"help": "Set kubernetes config paramters. \u003ckey\u003e must be server or namespace (e.g., ceph k8sevents set-config server https://localhost:30433).",
"module": "mgr",
"perm": "rw",
"sig": [
"k8sevents",
"set-config",
{
"name": "key",
"type": "CephString"
},
{
"name": "value",
"type": "CephString"
}
]
},
"cmd277": {
"flags": 8,
"help": "Clear external kubernetes configuration settings",
"module": "mgr",
"perm": "rw",
"sig": [
"k8sevents",
"clear-config"
]
},
"cmd278": {
"flags": 8,
"help": "Enable snapshot mirroring for a filesystem",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snapshot",
"mirror",
"enable",
{
"name": "fs_name",
"req": false,
"type": "CephString"
}
]
},
"cmd279": {
"flags": 8,
"help": "Disable snapshot mirroring for a filesystem",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snapshot",
"mirror",
"disable",
{
"name": "fs_name",
"req": false,
"type": "CephString"
}
]
},
"cmd280": {
"flags": 8,
"help": "Add a remote filesystem peer",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snapshot",
"mirror",
"peer_add",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "remote_cluster_spec",
"req": false,
"type": "CephString"
},
{
"name": "remote_fs_name",
"req": false,
"type": "CephString"
},
{
"name": "remote_mon_host",
"req": false,
"type": "CephString"
},
{
"name": "cephx_key",
"req": false,
"type": "CephString"
}
]
},
"cmd281": {
"flags": 8,
"help": "List configured peers for a file system",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"snapshot",
"mirror",
"peer_list",
{
"name": "fs_name",
"req": false,
"type": "CephString"
}
]
},
"cmd282": {
"flags": 8,
"help": "Remove a filesystem peer",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snapshot",
"mirror",
"peer_remove",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "peer_uuid",
"req": false,
"type": "CephString"
}
]
},
"cmd283": {
"flags": 8,
"help": "Bootstrap a filesystem peer",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snapshot",
"mirror",
"peer_bootstrap",
"create",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "client_name",
"type": "CephString"
},
{
"name": "site_name",
"req": false,
"type": "CephString"
}
]
},
"cmd284": {
"flags": 8,
"help": "Import a bootstrap token",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snapshot",
"mirror",
"peer_bootstrap",
"import",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "token",
"req": false,
"type": "CephString"
}
]
},
"cmd285": {
"flags": 8,
"help": "Add a directory for snapshot mirroring",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snapshot",
"mirror",
"add",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "path",
"req": false,
"type": "CephString"
}
]
},
"cmd286": {
"flags": 8,
"help": "Remove a snapshot mirrored directory",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snapshot",
"mirror",
"remove",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "path",
"req": false,
"type": "CephString"
}
]
},
"cmd287": {
"flags": 8,
"help": "List the snapshot mirrored directories",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snapshot",
"mirror",
"ls",
{
"name": "fs_name",
"req": false,
"type": "CephString"
}
]
},
"cmd288": {
"flags": 8,
"help": "Get current mirror instance map for a directory",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"snapshot",
"mirror",
"dirmap",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "path",
"req": false,
"type": "CephString"
}
]
},
"cmd289": {
"flags": 8,
"help": "Get current instance to directory map for a filesystem",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"snapshot",
"mirror",
"show",
"distribution",
{
"name": "fs_name",
"req": false,
"type": "CephString"
}
]
},
"cmd290": {
"flags": 8,
"help": "Get mirror daemon status",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"snapshot",
"mirror",
"daemon",
"status"
]
},
"cmd291": {
"flags": 8,
"help": "Create a CephFS export",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"create",
"cephfs",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
},
{
"name": "fsname",
"type": "CephString"
},
{
"name": "path",
"req": false,
"type": "CephString"
},
{
"name": "readonly",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"n": "N",
"name": "client_addr",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "squash",
"positional": false,
"req": false,
"type": "CephString"
},
{
"n": "N",
"name": "sectype",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd292": {
"flags": 8,
"help": "Create an RGW export",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"create",
"rgw",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
},
{
"name": "bucket",
"req": false,
"type": "CephString"
},
{
"name": "user_id",
"req": false,
"type": "CephString"
},
{
"name": "readonly",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"n": "N",
"name": "client_addr",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "squash",
"positional": false,
"req": false,
"type": "CephString"
},
{
"n": "N",
"name": "sectype",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd293": {
"flags": 8,
"help": "Remove a cephfs export",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"rm",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
}
]
},
"cmd294": {
"flags": 8,
"help": "Delete a cephfs export (DEPRECATED)",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"delete",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
}
]
},
"cmd295": {
"flags": 8,
"help": "List exports of a NFS cluster",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"export",
"ls",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "detailed",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd296": {
"flags": 8,
"help": "Fetch a export of a NFS cluster given the pseudo path/binding",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"export",
"info",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd297": {
"flags": 8,
"help": "Fetch a export of a NFS cluster given the pseudo path/binding (DEPRECATED)",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"export",
"get",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd298": {
"flags": 8,
"help": "Create or update an export by `-i \u003cjson_or_ganesha_export_file\u003e`",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"apply",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd299": {
"flags": 8,
"help": "Create an NFS Cluster",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"create",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "ingress",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "virtual_ip",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "ingress_mode",
"positional": false,
"req": false,
"strings": "default|keepalive-only|haproxy-standard|haproxy-protocol",
"type": "CephChoices"
},
{
"name": "port",
"positional": false,
"req": false,
"type": "CephInt"
}
]
},
"cmd300": {
"flags": 8,
"help": "Removes an NFS Cluster",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"rm",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd301": {
"flags": 8,
"help": "Removes an NFS Cluster (DEPRECATED)",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"delete",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd302": {
"flags": 8,
"help": "List NFS Clusters",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"cluster",
"ls",
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd303": {
"flags": 8,
"help": "Displays NFS Cluster info",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"cluster",
"info",
{
"name": "cluster_id",
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd304": {
"flags": 8,
"help": "Fetch NFS-Ganesha config",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"cluster",
"config",
"get",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd305": {
"flags": 8,
"help": "Set NFS-Ganesha config by `-i \u003cconfig_file\u003e`",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"config",
"set",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd306": {
"flags": 8,
"help": "Reset NFS-Ganesha Config to default",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"config",
"reset",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd307": {
"flags": 8,
"help": "List currently active device indicator lights",
"module": "mgr",
"perm": "r",
"sig": [
"device",
"ls-lights"
]
},
"cmd308": {
"flags": 8,
"help": "Enable or disable the device light. Default type is `ident` 'Usage: device light (on|off) \u003cdevid\u003e [ident|fault] [--force]'",
"module": "mgr",
"perm": "rw",
"sig": [
"device",
"light",
{
"name": "enable",
"strings": "on|off",
"type": "CephChoices"
},
{
"name": "devid",
"type": "CephString"
},
{
"name": "light_type",
"req": false,
"strings": "ident|fault",
"type": "CephChoices"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd309": {
"flags": 8,
"help": "Add a host",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"add",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "addr",
"req": false,
"type": "CephString"
},
{
"n": "N",
"name": "labels",
"req": false,
"type": "CephString"
},
{
"name": "maintenance",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd310": {
"flags": 8,
"help": "Display hardware status summary :param hostname: hostname",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"hardware",
"status",
{
"name": "hostname",
"req": false,
"type": "CephString"
},
{
"name": "category",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
}
]
},
"cmd311": {
"flags": 8,
"help": "Enable or Disable a device or chassis LED",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"hardware",
"light",
{
"name": "light_type",
"strings": "chassis|drive",
"type": "CephChoices"
},
{
"name": "action",
"strings": "on|off|get",
"type": "CephChoices"
},
{
"name": "hostname",
"type": "CephString"
},
{
"name": "device",
"req": false,
"type": "CephString"
}
]
},
"cmd312": {
"flags": 8,
"help": "Reboot a host",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"hardware",
"powercycle",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd313": {
"flags": 8,
"help": "Shutdown a host",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"hardware",
"shutdown",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "yes_i_really_mean_it",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd314": {
"flags": 8,
"help": "Remove a host",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"rm",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "offline",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "rm_crush_entry",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd315": {
"flags": 8,
"help": "drain all daemons from a host",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"drain",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "keep_conf_keyring",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "zap_osd_devices",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd316": {
"flags": 8,
"help": "Update a host address",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"set-addr",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "addr",
"type": "CephString"
}
]
},
"cmd317": {
"flags": 8,
"help": "List high level host information",
"module": "mgr",
"perm": "r",
"sig": [
"orch",
"host",
"ls",
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "host_pattern",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "label",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "host_status",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "detail",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd318": {
"flags": 8,
"help": "Add a host label",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"label",
"add",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "label",
"type": "CephString"
}
]
},
"cmd319": {
"flags": 8,
"help": "Remove a host label",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"label",
"rm",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "label",
"type": "CephString"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd320": {
"flags": 8,
"help": "Check if the specified host can be safely stopped without reducing availability",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"ok-to-stop",
{
"name": "hostname",
"type": "CephString"
}
]
},
"cmd321": {
"flags": 8,
"help": "Prepare a host for maintenance by shutting down and disabling all Ceph daemons (cephadm only)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"maintenance",
"enter",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "yes_i_really_mean_it",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd322": {
"flags": 8,
"help": "Return a host from maintenance, restarting all Ceph daemons (cephadm only)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"maintenance",
"exit",
{
"name": "hostname",
"type": "CephString"
}
]
},
"cmd323": {
"flags": 8,
"help": "Perform a disk rescan on a host",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"host",
"rescan",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "with_summary",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd324": {
"flags": 8,
"help": "List devices on a host",
"module": "mgr",
"perm": "r",
"sig": [
"orch",
"device",
"ls",
{
"n": "N",
"name": "hostname",
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "refresh",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "wide",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "summary",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd325": {
"flags": 8,
"help": "Zap (erase!) a device so it can be re-used",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"device",
"zap",
{
"name": "hostname",
"type": "CephString"
},
{
"name": "path",
"type": "CephString"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd326": {
"flags": 8,
"help": "Returns service discovery server root certificate",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"sd",
"dump",
"cert"
]
},
"cmd327": {
"flags": 8,
"help": "List services known to orchestrator",
"module": "mgr",
"perm": "r",
"sig": [
"orch",
"ls",
{
"name": "service_type",
"req": false,
"type": "CephString"
},
{
"name": "service_name",
"req": false,
"type": "CephString"
},
{
"name": "export",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "refresh",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd328": {
"flags": 8,
"help": "List daemons known to orchestrator",
"module": "mgr",
"perm": "r",
"sig": [
"orch",
"ps",
{
"name": "hostname",
"req": false,
"type": "CephString"
},
{
"name": "service_name",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "daemon_type",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "daemon_id",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "sort_by",
"positional": false,
"req": false,
"strings": "service_name|daemon_type|name|host|status|refreshed|age|mem_use|mem_lim|image",
"type": "CephChoices"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "refresh",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd329": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"prometheus",
"set-credentials",
{
"name": "username",
"req": false,
"type": "CephString"
},
{
"name": "password",
"req": false,
"type": "CephString"
}
]
},
"cmd330": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"prometheus",
"set-target",
{
"name": "url",
"type": "CephString"
}
]
},
"cmd331": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"prometheus",
"remove-target",
{
"name": "url",
"type": "CephString"
}
]
},
"cmd332": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"alertmanager",
"set-credentials",
{
"name": "username",
"req": false,
"type": "CephString"
},
{
"name": "password",
"req": false,
"type": "CephString"
}
]
},
"cmd333": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"prometheus",
"get-credentials"
]
},
"cmd334": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"alertmanager",
"get-credentials"
]
},
"cmd335": {
"flags": 8,
"help": "Create OSD daemon(s) on all available devices",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"apply",
"osd",
{
"name": "all_available_devices",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "unmanaged",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "dry_run",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "method",
"positional": false,
"req": false,
"strings": "raw|lvm",
"type": "CephChoices"
}
]
},
"cmd336": {
"flags": 8,
"help": "Create OSD daemon(s) on specified host and device(s) (e.g., ceph orch daemon add osd myhost:/dev/sdb)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
"add",
"osd",
{
"name": "svc_arg",
"req": false,
"type": "CephString"
},
{
"name": "method",
"req": false,
"strings": "raw|lvm",
"type": "CephChoices"
}
]
},
"cmd337": {
"flags": 8,
"help": "Remove OSD daemons",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"osd",
"rm",
{
"n": "N",
"name": "osd_id",
"type": "CephString"
},
{
"name": "replace",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "zap",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "no_destroy",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd338": {
"flags": 8,
"help": "Cancel ongoing OSD removal operation",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"osd",
"rm",
"stop",
{
"n": "N",
"name": "osd_id",
"type": "CephString"
}
]
},
"cmd339": {
"flags": 8,
"help": "Status of OSD removal operation",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"osd",
"rm",
"status",
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
}
]
},
"cmd340": {
"flags": 8,
"help": "Add daemon(s)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
"add",
{
"name": "daemon_type",
"req": false,
"strings": "mon|mgr|rbd-mirror|cephfs-mirror|crash|alertmanager|grafana|node-exporter|ceph-exporter|prometheus|loki|promtail|mds|rgw|nfs|iscsi|nvmeof|snmp-gateway|elasticsearch|jaeger-agent|jaeger-collector|jaeger-query",
"type": "CephChoices"
},
{
"name": "placement",
"req": false,
"type": "CephString"
}
]
},
"cmd341": {
"flags": 8,
"help": "Start MDS daemon(s)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
"add",
"mds",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
}
]
},
"cmd342": {
"flags": 8,
"help": "Start RGW daemon(s)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
"add",
"rgw",
{
"name": "svc_id",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "port",
"positional": false,
"req": false,
"type": "CephInt"
},
{
"name": "ssl",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd343": {
"flags": 8,
"help": "Start NFS daemon(s)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
"add",
"nfs",
{
"name": "svc_id",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
}
]
},
"cmd344": {
"flags": 8,
"help": "Start iscsi daemon(s)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
"add",
"iscsi",
{
"name": "pool",
"type": "CephString"
},
{
"name": "api_user",
"type": "CephString"
},
{
"name": "api_password",
"type": "CephString"
},
{
"name": "trusted_ip_list",
"req": false,
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
}
]
},
"cmd345": {
"flags": 8,
"help": "Start nvmeof daemon(s)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
"add",
"nvmeof",
{
"name": "pool",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
}
]
},
"cmd346": {
"flags": 8,
"help": "Start, stop, restart, redeploy, or reconfig an entire service (i.e. all daemons)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
{
"name": "action",
"strings": "start|stop|restart|redeploy|reconfig|rotate-key",
"type": "CephChoices"
},
{
"name": "service_name",
"type": "CephString"
}
]
},
"cmd347": {
"flags": 8,
"help": "Start, stop, restart, redeploy, reconfig, or rotate-key for a specific daemon",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
{
"name": "action",
"strings": "start|stop|restart|reconfig|rotate-key",
"type": "CephChoices"
},
{
"name": "name",
"type": "CephString"
}
]
},
"cmd348": {
"flags": 8,
"help": "Redeploy a daemon (with a specific image)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
"redeploy",
{
"name": "name",
"type": "CephString"
},
{
"name": "image",
"req": false,
"type": "CephString"
}
]
},
"cmd349": {
"flags": 8,
"help": "Remove specific daemon(s)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"daemon",
"rm",
{
"n": "N",
"name": "names",
"type": "CephString"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd350": {
"flags": 8,
"help": "Remove a service",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"rm",
{
"name": "service_name",
"type": "CephString"
},
{
"name": "force",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd351": {
"flags": 8,
"help": "Update the size or placement for a service or apply a large yaml spec",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"apply",
{
"name": "service_type",
"req": false,
"strings": "mon|mgr|rbd-mirror|cephfs-mirror|crash|alertmanager|grafana|node-exporter|ceph-exporter|prometheus|loki|promtail|mds|rgw|nfs|iscsi|nvmeof|snmp-gateway|elasticsearch|jaeger-agent|jaeger-collector|jaeger-query",
"type": "CephChoices"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "dry_run",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "unmanaged",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd352": {
"flags": 8,
"help": "Update the number of MDS instances for the given fs_name",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"apply",
"mds",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "dry_run",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "unmanaged",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd353": {
"flags": 8,
"help": "Update the number of RGW instances for the given zone",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"apply",
"rgw",
{
"name": "svc_id",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "realm",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "zonegroup",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "zone",
"positional": false,
"req": false,
"type": "CephString"
},
{
"n": "N",
"name": "networks",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "port",
"positional": false,
"req": false,
"type": "CephInt"
},
{
"name": "ssl",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "dry_run",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "unmanaged",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd354": {
"flags": 8,
"help": "Scale an NFS service",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"apply",
"nfs",
{
"name": "svc_id",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "port",
"positional": false,
"req": false,
"type": "CephInt"
},
{
"name": "dry_run",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "unmanaged",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd355": {
"flags": 8,
"help": "Scale an iSCSI service",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"apply",
"iscsi",
{
"name": "pool",
"type": "CephString"
},
{
"name": "api_user",
"type": "CephString"
},
{
"name": "api_password",
"type": "CephString"
},
{
"name": "trusted_ip_list",
"req": false,
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "unmanaged",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "dry_run",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd356": {
"flags": 8,
"help": "Scale an nvmeof service",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"apply",
"nvmeof",
{
"name": "pool",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "unmanaged",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "dry_run",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd357": {
"flags": 8,
"help": "Add a Prometheus to SNMP gateway service (cephadm only)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"apply",
"snmp-gateway",
{
"name": "snmp_version",
"strings": "V2c|V3",
"type": "CephChoices"
},
{
"name": "destination",
"type": "CephString"
},
{
"name": "port",
"req": false,
"type": "CephInt"
},
{
"name": "engine_id",
"req": false,
"type": "CephString"
},
{
"name": "auth_protocol",
"req": false,
"strings": "MD5|SHA",
"type": "CephChoices"
},
{
"name": "privacy_protocol",
"req": false,
"strings": "DES|AES",
"type": "CephChoices"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "unmanaged",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "dry_run",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd358": {
"flags": 8,
"help": "Apply jaeger tracing services",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"apply",
"jaeger",
{
"name": "es_nodes",
"req": false,
"type": "CephString"
},
{
"name": "without_query",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "placement",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "unmanaged",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "dry_run",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd359": {
"flags": 8,
"help": "Set 'unmanaged: true' for the given service name",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"set-unmanaged",
{
"name": "service_name",
"type": "CephString"
}
]
},
"cmd360": {
"flags": 8,
"help": "Set 'unmanaged: false' for the given service name",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"set-managed",
{
"name": "service_name",
"type": "CephString"
}
]
},
"cmd361": {
"flags": 8,
"help": "Select orchestrator module backend",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"set",
"backend",
{
"name": "module_name",
"req": false,
"type": "CephString"
}
]
},
"cmd362": {
"flags": 8,
"help": "Pause orchestrator background work",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"pause"
]
},
"cmd363": {
"flags": 8,
"help": "Resume orchestrator background work (if paused)",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"resume"
]
},
"cmd364": {
"flags": 8,
"help": "Cancel ongoing background operations",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"cancel"
]
},
"cmd365": {
"flags": 8,
"help": "Report configured backend and its status",
"module": "mgr",
"perm": "r",
"sig": [
"orch",
"status",
{
"name": "detail",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
}
]
},
"cmd366": {
"flags": 8,
"help": "Add or update a tuned profile",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"tuned-profile",
"apply",
{
"name": "profile_name",
"req": false,
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "settings",
"req": false,
"type": "CephString"
},
{
"name": "no_overwrite",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd367": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"tuned-profile",
"rm",
{
"name": "profile_name",
"type": "CephString"
}
]
},
"cmd368": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "r",
"sig": [
"orch",
"tuned-profile",
"ls",
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml|xml-pretty|xml",
"type": "CephChoices"
}
]
},
"cmd369": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"tuned-profile",
"add-setting",
{
"name": "profile_name",
"type": "CephString"
},
{
"name": "setting",
"type": "CephString"
},
{
"name": "value",
"type": "CephString"
}
]
},
"cmd370": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"tuned-profile",
"rm-setting",
{
"name": "profile_name",
"type": "CephString"
},
{
"name": "setting",
"type": "CephString"
}
]
},
"cmd371": {
"flags": 8,
"help": "Check service versions vs available and target containers",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"upgrade",
"check",
{
"name": "image",
"req": false,
"type": "CephString"
},
{
"name": "ceph_version",
"req": false,
"type": "CephString"
}
]
},
"cmd372": {
"flags": 8,
"help": "Check for available versions (or tags) we can upgrade to",
"module": "mgr",
"perm": "r",
"sig": [
"orch",
"upgrade",
"ls",
{
"name": "image",
"req": false,
"type": "CephString"
},
{
"name": "tags",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "show_all_versions",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd373": {
"flags": 8,
"help": "Check the status of any potential ongoing upgrade operation",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"upgrade",
"status"
]
},
"cmd374": {
"flags": 8,
"help": "Initiate upgrade",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"upgrade",
"start",
{
"name": "image",
"req": false,
"type": "CephString"
},
{
"name": "daemon_types",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "hosts",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "services",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "limit",
"positional": false,
"req": false,
"type": "CephInt"
},
{
"name": "ceph_version",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd375": {
"flags": 8,
"help": "Pause an in-progress upgrade",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"upgrade",
"pause"
]
},
"cmd376": {
"flags": 8,
"help": "Resume paused upgrade",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"upgrade",
"resume"
]
},
"cmd377": {
"flags": 8,
"help": "Stop an in-progress upgrade",
"module": "mgr",
"perm": "rw",
"sig": [
"orch",
"upgrade",
"stop"
]
},
"cmd378": {
"flags": 8,
"help": "add osd perf query",
"module": "mgr",
"perm": "w",
"sig": [
"osd",
"perf",
"query",
"add",
{
"name": "query",
"strings": "client_id|rbd_image_id|all_subkeys",
"type": "CephChoices"
}
]
},
"cmd379": {
"flags": 8,
"help": "remove osd perf query",
"module": "mgr",
"perm": "w",
"sig": [
"osd",
"perf",
"query",
"remove",
{
"name": "query_id",
"req": true,
"type": "CephInt"
}
]
},
"cmd380": {
"flags": 8,
"help": "fetch osd perf counters",
"module": "mgr",
"perm": "w",
"sig": [
"osd",
"perf",
"counters",
"get",
{
"name": "query_id",
"req": true,
"type": "CephInt"
}
]
},
"cmd381": {
"flags": 8,
"help": "report on pool pg_num sizing recommendation and intent",
"module": "mgr",
"perm": "r",
"sig": [
"osd",
"pool",
"autoscale-status",
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd382": {
"flags": 8,
"help": "set the autoscaler threshold A.K.A. the factor by which the new PG_NUM must vary from the existing PG_NUM",
"module": "mgr",
"perm": "w",
"sig": [
"osd",
"pool",
"set",
"threshold",
{
"name": "num",
"type": "CephFloat"
}
]
},
"cmd383": {
"flags": 8,
"help": "Get the noautoscale flag to see if all pools are setting the autoscaler on or off as well as newly created pools in the future.",
"module": "mgr",
"perm": "w",
"sig": [
"osd",
"pool",
"get",
"noautoscale"
]
},
"cmd384": {
"flags": 8,
"help": "Unset the noautoscale flag so all pools will go back to its previous mode. Newly created pools in the future will autoscaler on by default.",
"module": "mgr",
"perm": "w",
"sig": [
"osd",
"pool",
"unset",
"noautoscale"
]
},
"cmd385": {
"flags": 8,
"help": "set the noautoscale for all pools (including newly created pools in the future) and complete all on-going progress events regarding PG-autoscaling.",
"module": "mgr",
"perm": "w",
"sig": [
"osd",
"pool",
"set",
"noautoscale"
]
},
"cmd386": {
"flags": 8,
"help": "Show progress of recovery operations",
"module": "mgr",
"perm": "r",
"sig": [
"progress"
]
},
"cmd387": {
"flags": 8,
"help": "Show machine readable progress information",
"module": "mgr",
"perm": "r",
"sig": [
"progress",
"json"
]
},
"cmd388": {
"flags": 8,
"help": "Reset progress tracking",
"module": "mgr",
"perm": "rw",
"sig": [
"progress",
"clear"
]
},
"cmd389": {
"flags": 8,
"help": "Enable progress tracking",
"module": "mgr",
"perm": "rw",
"sig": [
"progress",
"on"
]
},
"cmd390": {
"flags": 8,
"help": "Disable progress tracking",
"module": "mgr",
"perm": "rw",
"sig": [
"progress",
"off"
]
},
"cmd391": {
"flags": 8,
"help": "Return file_sd compatible prometheus config for mgr cluster",
"module": "mgr",
"perm": "r",
"sig": [
"prometheus",
"file_sd_config"
]
},
"cmd392": {
"flags": 8,
"help": "List all the healthchecks being tracked The format options are parsed in ceph_argparse, before they get evaluated here so we can safely assume that what we have to process is valid. ceph_argparse will throw a ValueError if the cast to our Format class fails. Args: format (Format, optional): output format. Defaults to Format.plain. Returns: HandleCommandResult: return code, stdout and stderr returned to the caller",
"module": "mgr",
"perm": "r",
"sig": [
"healthcheck",
"history",
"ls",
{
"name": "format",
"positional": false,
"req": false,
"strings": "plain|json|json-pretty|yaml",
"type": "CephChoices"
}
]
},
"cmd393": {
"flags": 8,
"help": "Clear the healthcheck history",
"module": "mgr",
"perm": "w",
"sig": [
"healthcheck",
"history",
"clear"
]
},
"cmd394": {
"flags": 8,
"help": "Add rbd mirror snapshot schedule",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"mirror",
"snapshot",
"schedule",
"add",
{
"name": "level_spec",
"type": "CephString"
},
{
"name": "interval",
"type": "CephString"
},
{
"name": "start_time",
"req": false,
"type": "CephString"
}
]
},
"cmd395": {
"flags": 8,
"help": "Remove rbd mirror snapshot schedule",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"mirror",
"snapshot",
"schedule",
"remove",
{
"name": "level_spec",
"type": "CephString"
},
{
"name": "interval",
"req": false,
"type": "CephString"
},
{
"name": "start_time",
"req": false,
"type": "CephString"
}
]
},
"cmd396": {
"flags": 8,
"help": "List rbd mirror snapshot schedule",
"module": "mgr",
"perm": "r",
"sig": [
"rbd",
"mirror",
"snapshot",
"schedule",
"list",
{
"name": "level_spec",
"req": false,
"type": "CephString"
}
]
},
"cmd397": {
"flags": 8,
"help": "Show rbd mirror snapshot schedule status",
"module": "mgr",
"perm": "r",
"sig": [
"rbd",
"mirror",
"snapshot",
"schedule",
"status",
{
"name": "level_spec",
"req": false,
"type": "CephString"
}
]
},
"cmd398": {
"flags": 8,
"help": "Retrieve current RBD IO performance stats",
"module": "mgr",
"perm": "r",
"sig": [
"rbd",
"perf",
"image",
"stats",
{
"name": "pool_spec",
"req": false,
"type": "CephString"
},
{
"name": "sort_by",
"req": false,
"strings": "write_ops|write_bytes|write_latency|read_ops|read_bytes|read_latency",
"type": "CephChoices"
}
]
},
"cmd399": {
"flags": 8,
"help": "Retrieve current RBD IO performance counters",
"module": "mgr",
"perm": "r",
"sig": [
"rbd",
"perf",
"image",
"counters",
{
"name": "pool_spec",
"req": false,
"type": "CephString"
},
{
"name": "sort_by",
"req": false,
"strings": "write_ops|write_bytes|write_latency|read_ops|read_bytes|read_latency",
"type": "CephChoices"
}
]
},
"cmd400": {
"flags": 8,
"help": "Flatten a cloned image asynchronously in the background",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"task",
"add",
"flatten",
{
"name": "image_spec",
"type": "CephString"
}
]
},
"cmd401": {
"flags": 8,
"help": "Remove an image asynchronously in the background",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"task",
"add",
"remove",
{
"name": "image_spec",
"type": "CephString"
}
]
},
"cmd402": {
"flags": 8,
"help": "Remove an image from the trash asynchronously in the background",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"task",
"add",
"trash",
"remove",
{
"name": "image_id_spec",
"type": "CephString"
}
]
},
"cmd403": {
"flags": 8,
"help": "Execute an image migration asynchronously in the background",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"task",
"add",
"migration",
"execute",
{
"name": "image_spec",
"type": "CephString"
}
]
},
"cmd404": {
"flags": 8,
"help": "Commit an executed migration asynchronously in the background",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"task",
"add",
"migration",
"commit",
{
"name": "image_spec",
"type": "CephString"
}
]
},
"cmd405": {
"flags": 8,
"help": "Abort a prepared migration asynchronously in the background",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"task",
"add",
"migration",
"abort",
{
"name": "image_spec",
"type": "CephString"
}
]
},
"cmd406": {
"flags": 8,
"help": "Cancel a pending or running asynchronous task",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"task",
"cancel",
{
"name": "task_id",
"type": "CephString"
}
]
},
"cmd407": {
"flags": 8,
"help": "List pending or running asynchronous tasks",
"module": "mgr",
"perm": "r",
"sig": [
"rbd",
"task",
"list",
{
"name": "task_id",
"req": false,
"type": "CephString"
}
]
},
"cmd408": {
"flags": 8,
"help": "Add rbd trash purge schedule",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"trash",
"purge",
"schedule",
"add",
{
"name": "level_spec",
"type": "CephString"
},
{
"name": "interval",
"type": "CephString"
},
{
"name": "start_time",
"req": false,
"type": "CephString"
}
]
},
"cmd409": {
"flags": 8,
"help": "Remove rbd trash purge schedule",
"module": "mgr",
"perm": "w",
"sig": [
"rbd",
"trash",
"purge",
"schedule",
"remove",
{
"name": "level_spec",
"type": "CephString"
},
{
"name": "interval",
"req": false,
"type": "CephString"
},
{
"name": "start_time",
"req": false,
"type": "CephString"
}
]
},
"cmd410": {
"flags": 8,
"help": "List rbd trash purge schedule",
"module": "mgr",
"perm": "r",
"sig": [
"rbd",
"trash",
"purge",
"schedule",
"list",
{
"name": "level_spec",
"req": false,
"type": "CephString"
}
]
},
"cmd411": {
"flags": 8,
"help": "Show rbd trash purge schedule status",
"module": "mgr",
"perm": "r",
"sig": [
"rbd",
"trash",
"purge",
"schedule",
"status",
{
"name": "level_spec",
"req": false,
"type": "CephString"
}
]
},
"cmd412": {
"flags": 8,
"help": "Create an API key with this name",
"module": "mgr",
"perm": "rw",
"sig": [
"restful",
"create-key",
{
"name": "key_name",
"type": "CephString"
}
]
},
"cmd413": {
"flags": 8,
"help": "Delete an API key with this name",
"module": "mgr",
"perm": "rw",
"sig": [
"restful",
"delete-key",
{
"name": "key_name",
"type": "CephString"
}
]
},
"cmd414": {
"flags": 8,
"help": "List all API keys",
"module": "mgr",
"perm": "r",
"sig": [
"restful",
"list-keys"
]
},
"cmd415": {
"flags": 8,
"help": "Create localized self signed certificate",
"module": "mgr",
"perm": "rw",
"sig": [
"restful",
"create-self-signed-cert"
]
},
"cmd416": {
"flags": 8,
"help": "Restart API server",
"module": "mgr",
"perm": "rw",
"sig": [
"restful",
"restart"
]
},
"cmd417": {
"flags": 8,
"help": "rgw admin",
"module": "mgr",
"perm": "rw",
"sig": [
"rgw",
"admin",
{
"n": "N",
"name": "params",
"type": "CephString"
}
]
},
"cmd418": {
"flags": 8,
"help": "Bootstrap new rgw realm, zonegroup, and zone",
"module": "mgr",
"perm": "rw",
"sig": [
"rgw",
"realm",
"bootstrap",
{
"name": "realm_name",
"req": false,
"type": "CephString"
},
{
"name": "zonegroup_name",
"req": false,
"type": "CephString"
},
{
"name": "zone_name",
"req": false,
"type": "CephString"
},
{
"name": "port",
"req": false,
"type": "CephInt"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "zone_endpoints",
"req": false,
"type": "CephString"
},
{
"name": "start_radosgw",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd419": {
"flags": 8,
"help": "Create credentials for new zone creation",
"module": "mgr",
"perm": "rw",
"sig": [
"rgw",
"realm",
"zone-creds",
"create",
{
"name": "realm_name",
"req": false,
"type": "CephString"
},
{
"name": "endpoints",
"req": false,
"type": "CephString"
},
{
"name": "sys_uid",
"req": false,
"type": "CephString"
}
]
},
"cmd420": {
"flags": 8,
"help": "Create credentials for new zone creation",
"module": "mgr",
"perm": "rw",
"sig": [
"rgw",
"realm",
"zone-creds",
"remove",
{
"name": "realm_token",
"req": false,
"type": "CephString"
}
]
},
"cmd421": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "r",
"sig": [
"rgw",
"realm",
"tokens"
]
},
"cmd422": {
"flags": 8,
"help": "",
"module": "mgr",
"perm": "rw",
"sig": [
"rgw",
"zone",
"modify",
{
"name": "realm_name",
"type": "CephString"
},
{
"name": "zonegroup_name",
"type": "CephString"
},
{
"name": "zone_name",
"type": "CephString"
},
{
"name": "realm_token",
"type": "CephString"
},
{
"n": "N",
"name": "zone_endpoints",
"type": "CephString"
}
]
},
"cmd423": {
"flags": 8,
"help": "Bootstrap new rgw zone that syncs with zone on another cluster in the same realm",
"module": "mgr",
"perm": "rw",
"sig": [
"rgw",
"zone",
"create",
{
"name": "zone_name",
"req": false,
"type": "CephString"
},
{
"name": "realm_token",
"req": false,
"type": "CephString"
},
{
"name": "port",
"req": false,
"type": "CephInt"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "start_radosgw",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "zone_endpoints",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd424": {
"flags": 8,
"help": "Bootstrap new rgw zone that syncs with existing zone",
"module": "mgr",
"perm": "rw",
"sig": [
"rgw",
"realm",
"reconcile",
{
"name": "realm_name",
"req": false,
"type": "CephString"
},
{
"name": "zonegroup_name",
"req": false,
"type": "CephString"
},
{
"name": "zone_name",
"req": false,
"type": "CephString"
},
{
"name": "update",
"positional": false,
"req": false,
"type": "CephBool"
}
]
},
"cmd425": {
"flags": 8,
"help": "Create a CephFS export",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"create",
"cephfs",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
},
{
"name": "fsname",
"type": "CephString"
},
{
"name": "path",
"req": false,
"type": "CephString"
},
{
"name": "readonly",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"n": "N",
"name": "client_addr",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "squash",
"positional": false,
"req": false,
"type": "CephString"
},
{
"n": "N",
"name": "sectype",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd426": {
"flags": 8,
"help": "Create an RGW export",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"create",
"rgw",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
},
{
"name": "bucket",
"req": false,
"type": "CephString"
},
{
"name": "user_id",
"req": false,
"type": "CephString"
},
{
"name": "readonly",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"n": "N",
"name": "client_addr",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "squash",
"positional": false,
"req": false,
"type": "CephString"
},
{
"n": "N",
"name": "sectype",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd427": {
"flags": 8,
"help": "Remove a cephfs export",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"rm",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
}
]
},
"cmd428": {
"flags": 8,
"help": "Delete a cephfs export (DEPRECATED)",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"delete",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
}
]
},
"cmd429": {
"flags": 8,
"help": "List exports of a NFS cluster",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"export",
"ls",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "detailed",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd430": {
"flags": 8,
"help": "Fetch a export of a NFS cluster given the pseudo path/binding",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"export",
"info",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd431": {
"flags": 8,
"help": "Fetch a export of a NFS cluster given the pseudo path/binding (DEPRECATED)",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"export",
"get",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "pseudo_path",
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd432": {
"flags": 8,
"help": "Create or update an export by `-i \u003cjson_or_ganesha_export_file\u003e`",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"export",
"apply",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd433": {
"flags": 8,
"help": "Create an NFS Cluster",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"create",
{
"name": "cluster_id",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
},
{
"name": "ingress",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "virtual_ip",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "ingress_mode",
"positional": false,
"req": false,
"strings": "default|keepalive-only|haproxy-standard|haproxy-protocol",
"type": "CephChoices"
},
{
"name": "port",
"positional": false,
"req": false,
"type": "CephInt"
}
]
},
"cmd434": {
"flags": 8,
"help": "Removes an NFS Cluster",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"rm",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd435": {
"flags": 8,
"help": "Removes an NFS Cluster (DEPRECATED)",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"delete",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd436": {
"flags": 8,
"help": "List NFS Clusters",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"cluster",
"ls",
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd437": {
"flags": 8,
"help": "Displays NFS Cluster info",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"cluster",
"info",
{
"name": "cluster_id",
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd438": {
"flags": 8,
"help": "Fetch NFS-Ganesha config",
"module": "mgr",
"perm": "r",
"sig": [
"nfs",
"cluster",
"config",
"get",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd439": {
"flags": 8,
"help": "Set NFS-Ganesha config by `-i \u003cconfig_file\u003e`",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"config",
"set",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd440": {
"flags": 8,
"help": "Reset NFS-Ganesha Config to default",
"module": "mgr",
"perm": "rw",
"sig": [
"nfs",
"cluster",
"config",
"reset",
{
"name": "cluster_id",
"type": "CephString"
}
]
},
"cmd441": {
"flags": 8,
"help": "Query the version of the embedded Python runtime",
"module": "mgr",
"perm": "r",
"sig": [
"mgr",
"self-test",
"python-version"
]
},
"cmd442": {
"flags": 8,
"help": "Run mgr python interface tests",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"run"
]
},
"cmd443": {
"flags": 8,
"help": "Activate a background workload (one of command_spam, throw_exception)",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"background",
"start",
{
"name": "workload",
"strings": "command_spam|throw_exception|shutdown",
"type": "CephChoices"
}
]
},
"cmd444": {
"flags": 8,
"help": "Stop background workload if any is running",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"background",
"stop"
]
},
"cmd445": {
"flags": 8,
"help": "Peek at a configuration value",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"config",
"get",
{
"name": "key",
"type": "CephString"
}
]
},
"cmd446": {
"flags": 8,
"help": "Peek at a configuration value (localized variant)",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"config",
"get_localized",
{
"name": "key",
"type": "CephString"
}
]
},
"cmd447": {
"flags": 8,
"help": "Test inter-module calls",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"remote"
]
},
"cmd448": {
"flags": 8,
"help": "Run another module's self_test() method",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"module",
{
"name": "module",
"type": "CephString"
}
]
},
"cmd449": {
"flags": 8,
"help": "Create an audit log record.",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"cluster-log",
{
"name": "channel",
"type": "CephString"
},
{
"name": "priority",
"type": "CephString"
},
{
"name": "message",
"type": "CephString"
}
]
},
"cmd450": {
"flags": 8,
"help": "Set a health check from a JSON-formatted description.",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"health",
"set",
{
"name": "checks",
"type": "CephString"
}
]
},
"cmd451": {
"flags": 8,
"help": "Clear health checks by name. If no names provided, clear all.",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"health",
"clear",
{
"n": "N",
"name": "checks",
"req": false,
"type": "CephString"
}
]
},
"cmd452": {
"flags": 8,
"help": "Set the now time for the insights module.",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"insights_set_now_offset",
{
"name": "hours",
"type": "CephInt"
}
]
},
"cmd453": {
"flags": 8,
"help": "eval given source",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"self-test",
"eval",
{
"name": "s",
"req": false,
"type": "CephString"
}
]
},
"cmd454": {
"flags": 8,
"help": "List current snapshot schedules",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"snap-schedule",
"status",
{
"name": "path",
"req": false,
"type": "CephString"
},
{
"name": "fs",
"req": false,
"type": "CephString"
},
{
"name": "subvol",
"req": false,
"type": "CephString"
},
{
"name": "group",
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd455": {
"flags": 8,
"help": "Get current snapshot schedule for \u003cpath\u003e",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"snap-schedule",
"list",
{
"name": "path",
"type": "CephString"
},
{
"name": "recursive",
"positional": false,
"req": false,
"type": "CephBool"
},
{
"name": "fs",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "subvol",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "group",
"positional": false,
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd456": {
"flags": 8,
"help": "Set a snapshot schedule for \u003cpath\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snap-schedule",
"add",
{
"name": "path",
"type": "CephString"
},
{
"name": "snap_schedule",
"type": "CephString"
},
{
"name": "start",
"req": false,
"type": "CephString"
},
{
"name": "fs",
"req": false,
"type": "CephString"
},
{
"name": "subvol",
"req": false,
"type": "CephString"
},
{
"name": "group",
"req": false,
"type": "CephString"
}
]
},
"cmd457": {
"flags": 8,
"help": "Remove a snapshot schedule for \u003cpath\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snap-schedule",
"remove",
{
"name": "path",
"type": "CephString"
},
{
"name": "repeat",
"req": false,
"type": "CephString"
},
{
"name": "start",
"req": false,
"type": "CephString"
},
{
"name": "fs",
"req": false,
"type": "CephString"
},
{
"name": "subvol",
"req": false,
"type": "CephString"
},
{
"name": "group",
"req": false,
"type": "CephString"
}
]
},
"cmd458": {
"flags": 8,
"help": "Set a retention specification for \u003cpath\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snap-schedule",
"retention",
"add",
{
"name": "path",
"type": "CephString"
},
{
"name": "retention_spec_or_period",
"type": "CephString"
},
{
"name": "retention_count",
"req": false,
"type": "CephString"
},
{
"name": "fs",
"req": false,
"type": "CephString"
},
{
"name": "subvol",
"req": false,
"type": "CephString"
},
{
"name": "group",
"req": false,
"type": "CephString"
}
]
},
"cmd459": {
"flags": 8,
"help": "Remove a retention specification for \u003cpath\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snap-schedule",
"retention",
"remove",
{
"name": "path",
"type": "CephString"
},
{
"name": "retention_spec_or_period",
"type": "CephString"
},
{
"name": "retention_count",
"req": false,
"type": "CephString"
},
{
"name": "fs",
"req": false,
"type": "CephString"
},
{
"name": "subvol",
"req": false,
"type": "CephString"
},
{
"name": "group",
"req": false,
"type": "CephString"
}
]
},
"cmd460": {
"flags": 8,
"help": "Activate a snapshot schedule for \u003cpath\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snap-schedule",
"activate",
{
"name": "path",
"type": "CephString"
},
{
"name": "repeat",
"req": false,
"type": "CephString"
},
{
"name": "start",
"req": false,
"type": "CephString"
},
{
"name": "fs",
"req": false,
"type": "CephString"
},
{
"name": "subvol",
"req": false,
"type": "CephString"
},
{
"name": "group",
"req": false,
"type": "CephString"
}
]
},
"cmd461": {
"flags": 8,
"help": "Deactivate a snapshot schedule for \u003cpath\u003e",
"module": "mgr",
"perm": "w",
"sig": [
"fs",
"snap-schedule",
"deactivate",
{
"name": "path",
"type": "CephString"
},
{
"name": "repeat",
"req": false,
"type": "CephString"
},
{
"name": "start",
"req": false,
"type": "CephString"
},
{
"name": "fs",
"req": false,
"type": "CephString"
},
{
"name": "subvol",
"req": false,
"type": "CephString"
},
{
"name": "group",
"req": false,
"type": "CephString"
}
]
},
"cmd462": {
"flags": 8,
"help": "retrieve ceph fs performance stats",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"perf",
"stats",
{
"name": "mds_rank",
"req": false,
"type": "CephString"
},
{
"name": "client_id",
"req": false,
"type": "CephString"
},
{
"name": "client_ip",
"req": false,
"type": "CephString"
}
]
},
"cmd463": {
"flags": 8,
"help": "Show the status of a CephFS filesystem",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"status",
{
"name": "fs",
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd464": {
"flags": 8,
"help": "Show the status of OSDs within a bucket, or all",
"module": "mgr",
"perm": "r",
"sig": [
"osd",
"status",
{
"name": "bucket",
"req": false,
"type": "CephString"
},
{
"name": "format",
"positional": false,
"req": false,
"type": "CephString"
}
]
},
"cmd465": {
"flags": 8,
"help": "Show current configuration",
"module": "mgr",
"perm": "r",
"sig": [
"telegraf",
"config-show"
]
},
"cmd466": {
"flags": 8,
"help": "Set a configuration value",
"module": "mgr",
"perm": "rw",
"sig": [
"telegraf",
"config-set",
{
"name": "key",
"type": "CephString"
},
{
"name": "value",
"type": "CephString"
}
]
},
"cmd467": {
"flags": 8,
"help": "Force sending data to Telegraf",
"module": "mgr",
"perm": "rw",
"sig": [
"telegraf",
"send"
]
},
"cmd468": {
"flags": 8,
"help": "Show current configuration",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"status"
]
},
"cmd469": {
"flags": 8,
"help": "Show the diff between opted-in collection and available collection",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"diff"
]
},
"cmd470": {
"flags": 8,
"help": "Enable telemetry reports from this cluster",
"module": "mgr",
"perm": "rw",
"sig": [
"telemetry",
"on",
{
"name": "license",
"req": false,
"type": "CephString"
}
]
},
"cmd471": {
"flags": 8,
"help": "Disable telemetry reports from this cluster",
"module": "mgr",
"perm": "rw",
"sig": [
"telemetry",
"off"
]
},
"cmd472": {
"flags": 8,
"help": "Enable all channels",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"enable",
"channel",
"all",
{
"n": "N",
"name": "channels",
"req": false,
"type": "CephString"
}
]
},
"cmd473": {
"flags": 8,
"help": "Enable a list of channels",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"enable",
"channel",
{
"n": "N",
"name": "channels",
"req": false,
"type": "CephString"
}
]
},
"cmd474": {
"flags": 8,
"help": "Disable all channels",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"disable",
"channel",
"all",
{
"n": "N",
"name": "channels",
"req": false,
"type": "CephString"
}
]
},
"cmd475": {
"flags": 8,
"help": "Disable a list of channels",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"disable",
"channel",
{
"n": "N",
"name": "channels",
"req": false,
"type": "CephString"
}
]
},
"cmd476": {
"flags": 8,
"help": "List all channels",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"channel",
"ls"
]
},
"cmd477": {
"flags": 8,
"help": "List all collections",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"collection",
"ls"
]
},
"cmd478": {
"flags": 8,
"help": "Send a sample report",
"module": "mgr",
"perm": "rw",
"sig": [
"telemetry",
"send",
{
"n": "N",
"name": "endpoint",
"req": false,
"strings": "ceph|device",
"type": "CephChoices"
},
{
"name": "license",
"req": false,
"type": "CephString"
}
]
},
"cmd479": {
"flags": 8,
"help": "Show a sample report of opted-in collections (except for 'device')",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"show",
{
"n": "N",
"name": "channels",
"req": false,
"type": "CephString"
}
]
},
"cmd480": {
"flags": 8,
"help": "Preview a sample report of the most recent collections available (except for 'device')",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"preview",
{
"n": "N",
"name": "channels",
"req": false,
"type": "CephString"
}
]
},
"cmd481": {
"flags": 8,
"help": "Show a sample device report",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"show-device"
]
},
"cmd482": {
"flags": 8,
"help": "Preview a sample device report of the most recent device collection",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"preview-device"
]
},
"cmd483": {
"flags": 8,
"help": "Show a sample report of all enabled channels (including 'device' channel)",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"show-all"
]
},
"cmd484": {
"flags": 8,
"help": "Preview a sample report of the most recent collections available of all channels (including 'device')",
"module": "mgr",
"perm": "r",
"sig": [
"telemetry",
"preview-all"
]
},
"cmd485": {
"flags": 8,
"help": "load dummy data into test orchestrator",
"module": "mgr",
"perm": "w",
"sig": [
"test_orchestrator",
"load_data"
]
},
"cmd486": {
"flags": 8,
"help": "List volumes",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"volume",
"ls"
]
},
"cmd487": {
"flags": 8,
"help": "Create a CephFS volume",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"volume",
"create",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"name": "placement",
"req": false,
"type": "CephString"
}
]
},
"cmd488": {
"flags": 8,
"help": "Delete a FS volume by passing --yes-i-really-mean-it flag",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"volume",
"rm",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "yes-i-really-mean-it",
"req": false,
"type": "CephString"
}
]
},
"cmd489": {
"flags": 8,
"help": "Rename a CephFS volume by passing --yes-i-really-mean-it flag",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"volume",
"rename",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "vol_name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "new_vol_name",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd490": {
"flags": 8,
"help": "Get the information of a CephFS volume",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"volume",
"info",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "human_readable",
"req": false,
"type": "CephBool"
}
]
},
"cmd491": {
"flags": 8,
"help": "List subvolumegroups",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolumegroup",
"ls",
{
"name": "vol_name",
"type": "CephString"
}
]
},
"cmd492": {
"flags": 8,
"help": "Create a CephFS subvolume group in a volume, and optionally, with a specific data pool layout, and a specific numeric mode",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolumegroup",
"create",
{
"name": "vol_name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "group_name",
"type": "CephString"
},
{
"name": "size",
"req": false,
"type": "CephInt"
},
{
"name": "pool_layout",
"req": false,
"type": "CephString"
},
{
"name": "uid",
"req": false,
"type": "CephInt"
},
{
"name": "gid",
"req": false,
"type": "CephInt"
},
{
"name": "mode",
"req": false,
"type": "CephString"
}
]
},
"cmd493": {
"flags": 8,
"help": "Delete a CephFS subvolume group in a volume",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolumegroup",
"rm",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
}
]
},
"cmd494": {
"flags": 8,
"help": "Get the metadata of a CephFS subvolume group in a volume, ",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolumegroup",
"info",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"type": "CephString"
}
]
},
"cmd495": {
"flags": 8,
"help": "Resize a CephFS subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolumegroup",
"resize",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"type": "CephString"
},
{
"name": "new_size",
"req": true,
"type": "CephString"
},
{
"name": "no_shrink",
"req": false,
"type": "CephBool"
}
]
},
"cmd496": {
"flags": 8,
"help": "Check a volume for the existence of subvolumegroup",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolumegroup",
"exist",
{
"name": "vol_name",
"type": "CephString"
}
]
},
"cmd497": {
"flags": 8,
"help": "List subvolumes",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"ls",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd498": {
"flags": 8,
"help": "Create a CephFS subvolume in a volume, and optionally, with a specific size (in bytes), a specific data pool layout, a specific mode, in a specific subvolume group and in separate RADOS namespace",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"create",
{
"name": "vol_name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "sub_name",
"type": "CephString"
},
{
"name": "size",
"req": false,
"type": "CephInt"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
},
{
"name": "pool_layout",
"req": false,
"type": "CephString"
},
{
"name": "uid",
"req": false,
"type": "CephInt"
},
{
"name": "gid",
"req": false,
"type": "CephInt"
},
{
"name": "mode",
"req": false,
"type": "CephString"
},
{
"name": "namespace_isolated",
"req": false,
"type": "CephBool"
}
]
},
"cmd499": {
"flags": 8,
"help": "Delete a CephFS subvolume in a volume, and optionally, in a specific subvolume group, force deleting a cancelled or failed clone, and retaining existing subvolume snapshots",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"rm",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
},
{
"name": "retain_snapshots",
"req": false,
"type": "CephBool"
}
]
},
"cmd500": {
"flags": 8,
"help": "Allow a cephx auth ID access to a subvolume",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"authorize",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "auth_id",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
},
{
"name": "access_level",
"req": false,
"type": "CephString"
},
{
"name": "tenant_id",
"req": false,
"type": "CephString"
},
{
"name": "allow_existing_id",
"req": false,
"type": "CephBool"
}
]
},
"cmd501": {
"flags": 8,
"help": "Deny a cephx auth ID access to a subvolume",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"deauthorize",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "auth_id",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd502": {
"flags": 8,
"help": "List auth IDs that have access to a subvolume",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"authorized_list",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd503": {
"flags": 8,
"help": "Evict clients based on auth IDs and subvolume mounted",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"evict",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "auth_id",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd504": {
"flags": 8,
"help": "Get the mountpath of a CephFS subvolume group in a volume",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolumegroup",
"getpath",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"type": "CephString"
}
]
},
"cmd505": {
"flags": 8,
"help": "Get the mountpath of a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"getpath",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd506": {
"flags": 8,
"help": "Get the information of a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"info",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd507": {
"flags": 8,
"help": "Check a volume for the existence of a subvolume, optionally in a specified subvolume group",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"exist",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd508": {
"flags": 8,
"help": "Set custom metadata (key-value) for a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"metadata",
"set",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "key_name",
"type": "CephString"
},
{
"name": "value",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd509": {
"flags": 8,
"help": "Get custom metadata associated with the key of a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"metadata",
"get",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "key_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd510": {
"flags": 8,
"help": "List custom metadata (key-value pairs) of a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"metadata",
"ls",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd511": {
"flags": 8,
"help": "Remove custom metadata (key-value) associated with the key of a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"metadata",
"rm",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "key_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
}
]
},
"cmd512": {
"flags": 8,
"help": "Set MDS pinning policy for subvolumegroup",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolumegroup",
"pin",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"req": true,
"type": "CephString"
},
{
"name": "pin_type",
"strings": "export|distributed|random",
"type": "CephChoices"
},
{
"name": "pin_setting",
"req": true,
"type": "CephString"
}
]
},
"cmd513": {
"flags": 8,
"help": "List subvolumegroup snapshots",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolumegroup",
"snapshot",
"ls",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"type": "CephString"
}
]
},
"cmd514": {
"flags": 8,
"help": "Create a snapshot of a CephFS subvolume group in a volume",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolumegroup",
"snapshot",
"create",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
}
]
},
"cmd515": {
"flags": 8,
"help": "Delete a snapshot of a CephFS subvolume group in a volume",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolumegroup",
"snapshot",
"rm",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "group_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
}
]
},
"cmd516": {
"flags": 8,
"help": "List subvolume snapshots",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"snapshot",
"ls",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd517": {
"flags": 8,
"help": "Create a snapshot of a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"snapshot",
"create",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd518": {
"flags": 8,
"help": "Get the information of a CephFS subvolume snapshot and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"snapshot",
"info",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd519": {
"flags": 8,
"help": "Set custom metadata (key-value) for a CephFS subvolume snapshot in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"snapshot",
"metadata",
"set",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "key_name",
"type": "CephString"
},
{
"name": "value",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd520": {
"flags": 8,
"help": "Get custom metadata associated with the key of a CephFS subvolume snapshot in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"snapshot",
"metadata",
"get",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "key_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd521": {
"flags": 8,
"help": "List custom metadata (key-value pairs) of a CephFS subvolume snapshot in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"subvolume",
"snapshot",
"metadata",
"ls",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd522": {
"flags": 8,
"help": "Remove custom metadata (key-value) associated with the key of a CephFS subvolume snapshot in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"snapshot",
"metadata",
"rm",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "key_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
}
]
},
"cmd523": {
"flags": 8,
"help": "Delete a snapshot of a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"snapshot",
"rm",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
}
]
},
"cmd524": {
"flags": 8,
"help": "Resize a CephFS subvolume",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"resize",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "new_size",
"req": true,
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
},
{
"name": "no_shrink",
"req": false,
"type": "CephBool"
}
]
},
"cmd525": {
"flags": 8,
"help": "Set MDS pinning policy for subvolume",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"pin",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "pin_type",
"strings": "export|distributed|random",
"type": "CephChoices"
},
{
"name": "pin_setting",
"req": true,
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd526": {
"flags": 8,
"help": "(deprecated) Protect snapshot of a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"snapshot",
"protect",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd527": {
"flags": 8,
"help": "(deprecated) Unprotect a snapshot of a CephFS subvolume in a volume, and optionally, in a specific subvolume group",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"snapshot",
"unprotect",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd528": {
"flags": 8,
"help": "Clone a snapshot to target subvolume",
"module": "mgr",
"perm": "rw",
"sig": [
"fs",
"subvolume",
"snapshot",
"clone",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "sub_name",
"type": "CephString"
},
{
"name": "snap_name",
"type": "CephString"
},
{
"name": "target_sub_name",
"type": "CephString"
},
{
"name": "pool_layout",
"req": false,
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
},
{
"name": "target_group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd529": {
"flags": 8,
"help": "Get status on a cloned subvolume.",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"clone",
"status",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "clone_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd530": {
"flags": 8,
"help": "Cancel an pending or ongoing clone operation.",
"module": "mgr",
"perm": "r",
"sig": [
"fs",
"clone",
"cancel",
{
"name": "vol_name",
"type": "CephString"
},
{
"name": "clone_name",
"type": "CephString"
},
{
"name": "group_name",
"req": false,
"type": "CephString"
}
]
},
"cmd531": {
"flags": 8,
"help": "Show current configuration",
"module": "mgr",
"perm": "r",
"sig": [
"zabbix",
"config-show"
]
},
"cmd532": {
"flags": 8,
"help": "Set a configuration value",
"module": "mgr",
"perm": "w",
"sig": [
"zabbix",
"config-set",
{
"name": "key",
"type": "CephString"
},
{
"name": "value",
"type": "CephString"
}
]
},
"cmd533": {
"flags": 8,
"help": "Force sending data to Zabbix",
"module": "mgr",
"perm": "r",
"sig": [
"zabbix",
"send"
]
},
"cmd534": {
"flags": 8,
"help": "Discovering Zabbix data",
"module": "mgr",
"perm": "r",
"sig": [
"zabbix",
"discovery"
]
},
"cmd535": {
"flags": 0,
"help": "show mapping of pg to osds",
"module": "pg",
"perm": "r",
"sig": [
"pg",
"map",
{
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd536": {
"flags": 0,
"help": "force a PG to repeer",
"module": "osd",
"perm": "rw",
"sig": [
"pg",
"repeer",
{
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd537": {
"flags": 0,
"help": "get the last pg stats sequence number reported for this osd",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"last-stat-seq",
{
"name": "id",
"type": "CephOsdName"
}
]
},
"cmd538": {
"flags": 0,
"help": "write keyring for requested entity, or master keyring if none given",
"module": "auth",
"perm": "rx",
"sig": [
"auth",
"export",
{
"name": "entity",
"req": false,
"type": "CephString"
}
]
},
"cmd539": {
"flags": 0,
"help": "write keyring file with requested key",
"module": "auth",
"perm": "rx",
"sig": [
"auth",
"get",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd540": {
"flags": 0,
"help": "display requested key",
"module": "auth",
"perm": "rx",
"sig": [
"auth",
"get-key",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd541": {
"flags": 0,
"help": "display requested key",
"module": "auth",
"perm": "rx",
"sig": [
"auth",
"print-key",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd542": {
"flags": 0,
"help": "display requested key",
"module": "auth",
"perm": "rx",
"sig": [
"auth",
"print_key",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd543": {
"flags": 4,
"help": "list authentication state",
"module": "auth",
"perm": "rx",
"sig": [
"auth",
"list"
]
},
"cmd544": {
"flags": 0,
"help": "list authentication state",
"module": "auth",
"perm": "rx",
"sig": [
"auth",
"ls"
]
},
"cmd545": {
"flags": 0,
"help": "auth import: read keyring file from -i \u003cfile\u003e",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"import"
]
},
"cmd546": {
"flags": 0,
"help": "add auth info for \u003centity\u003e from input file, or random key if no input is given, and/or any caps specified in the command",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"add",
{
"name": "entity",
"type": "CephString"
},
{
"n": "N",
"name": "caps",
"req": false,
"type": "CephString"
}
]
},
"cmd547": {
"flags": 0,
"help": "get, or add, key for \u003cname\u003e from system/caps pairs specified in the command. If key already exists, any given caps must match the existing caps for that key.",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"get-or-create-key",
{
"name": "entity",
"type": "CephString"
},
{
"n": "N",
"name": "caps",
"req": false,
"type": "CephString"
}
]
},
"cmd548": {
"flags": 0,
"help": "add auth info for \u003centity\u003e from input file, or random key if no input given, and/or any caps specified in the command",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"get-or-create",
{
"name": "entity",
"type": "CephString"
},
{
"n": "N",
"name": "caps",
"req": false,
"type": "CephString"
}
]
},
"cmd549": {
"flags": 0,
"help": "generate and/or retrieve existing pending key (rotated into place on first use)",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"get-or-create-pending",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd550": {
"flags": 0,
"help": "clear pending key",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"clear-pending",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd551": {
"flags": 0,
"help": "rotate pending key into active position",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"commit-pending",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd552": {
"flags": 0,
"help": "add auth for \u003centity\u003e to access file system \u003cfilesystem\u003e based on following directory and permissions pairs",
"module": "auth",
"perm": "rwx",
"sig": [
"fs",
"authorize",
{
"name": "filesystem",
"type": "CephString"
},
{
"name": "entity",
"type": "CephString"
},
{
"n": "N",
"name": "caps",
"type": "CephString"
}
]
},
"cmd553": {
"flags": 0,
"help": "update caps for \u003cname\u003e from caps specified in the command",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"caps",
{
"name": "entity",
"type": "CephString"
},
{
"n": "N",
"name": "caps",
"type": "CephString"
}
]
},
"cmd554": {
"flags": 4,
"help": "delete all caps for \u003cname\u003e",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"del",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd555": {
"flags": 0,
"help": "remove all caps for \u003cname\u003e",
"module": "auth",
"perm": "rwx",
"sig": [
"auth",
"rm",
{
"name": "entity",
"type": "CephString"
}
]
},
"cmd556": {
"flags": 33,
"help": "cause compaction of monitor's leveldb/rocksdb storage",
"module": "mon",
"perm": "rw",
"sig": [
"compact"
]
},
"cmd557": {
"flags": 0,
"help": "show cluster FSID/UUID",
"module": "mon",
"perm": "r",
"sig": [
"fsid"
]
},
"cmd558": {
"flags": 0,
"help": "log supplied text to the monitor log",
"module": "mon",
"perm": "rw",
"sig": [
"log",
{
"n": "N",
"name": "logtext",
"type": "CephString"
}
]
},
"cmd559": {
"flags": 0,
"help": "print last few lines of the cluster log",
"module": "mon",
"perm": "r",
"sig": [
"log",
"last",
{
"name": "num",
"range": "1",
"req": false,
"type": "CephInt"
},
{
"name": "level",
"req": false,
"strings": "debug|info|sec|warn|error",
"type": "CephChoices"
},
{
"name": "channel",
"req": false,
"strings": "*|cluster|audit|cephadm",
"type": "CephChoices"
}
]
},
"cmd560": {
"flags": 0,
"help": "show cluster status",
"module": "mon",
"perm": "r",
"sig": [
"status"
]
},
"cmd561": {
"flags": 0,
"help": "show cluster health",
"module": "mon",
"perm": "r",
"sig": [
"health",
{
"name": "detail",
"req": false,
"strings": "detail",
"type": "CephChoices"
}
]
},
"cmd562": {
"flags": 0,
"help": "mute health alert",
"module": "mon",
"perm": "w",
"sig": [
"health",
"mute",
{
"name": "code",
"type": "CephString"
},
{
"name": "ttl",
"req": false,
"type": "CephString"
},
{
"name": "sticky",
"req": false,
"type": "CephBool"
}
]
},
"cmd563": {
"flags": 0,
"help": "unmute existing health alert mute(s)",
"module": "mon",
"perm": "w",
"sig": [
"health",
"unmute",
{
"name": "code",
"req": false,
"type": "CephString"
}
]
},
"cmd564": {
"flags": 0,
"help": "show time sync status",
"module": "mon",
"perm": "r",
"sig": [
"time-sync-status"
]
},
"cmd565": {
"flags": 0,
"help": "show cluster free space stats",
"module": "mon",
"perm": "r",
"sig": [
"df",
{
"name": "detail",
"req": false,
"strings": "detail",
"type": "CephChoices"
}
]
},
"cmd566": {
"flags": 0,
"help": "report full status of cluster, optional title tag strings",
"module": "mon",
"perm": "r",
"sig": [
"report",
{
"n": "N",
"name": "tags",
"req": false,
"type": "CephString"
}
]
},
"cmd567": {
"flags": 0,
"help": "report of connected features",
"module": "mon",
"perm": "r",
"sig": [
"features"
]
},
"cmd568": {
"flags": 0,
"help": "report status of monitor quorum",
"module": "mon",
"perm": "r",
"sig": [
"quorum_status"
]
},
"cmd569": {
"flags": 0,
"help": "check whether mon(s) can be safely stopped without reducing immediate availability",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"ok-to-stop",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd570": {
"flags": 0,
"help": "check whether adding a mon and not starting it would break quorum",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"ok-to-add-offline"
]
},
"cmd571": {
"flags": 0,
"help": "check whether removing the specified mon would break quorum",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"ok-to-rm",
{
"name": "id",
"type": "CephString"
}
]
},
"cmd572": {
"flags": 0,
"help": "send a command to a specific daemon",
"module": "mon",
"perm": "rw",
"sig": [
"tell",
{
"name": "target",
"type": "CephName"
},
{
"n": "N",
"name": "args",
"type": "CephString"
}
]
},
"cmd573": {
"flags": 33,
"help": "show mon daemon version",
"module": "mon",
"perm": "r",
"sig": [
"version"
]
},
"cmd574": {
"flags": 0,
"help": "list all nodes in cluster [type]",
"module": "mon",
"perm": "r",
"sig": [
"node",
"ls",
{
"name": "type",
"req": false,
"strings": "all|osd|mon|mds|mgr",
"type": "CephChoices"
}
]
},
"cmd575": {
"flags": 0,
"help": "scrub the monitor stores",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"scrub"
]
},
"cmd576": {
"flags": 0,
"help": "fetch metadata for mon \u003cid\u003e",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"metadata",
{
"name": "id",
"req": false,
"type": "CephString"
}
]
},
"cmd577": {
"flags": 0,
"help": "count mons by metadata field property",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"count-metadata",
{
"name": "property",
"type": "CephString"
}
]
},
"cmd578": {
"flags": 0,
"help": "check running versions of monitors",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"versions"
]
},
"cmd579": {
"flags": 0,
"help": "check running versions of ceph daemons",
"module": "mon",
"perm": "r",
"sig": [
"versions"
]
},
"cmd580": {
"flags": 32,
"help": "show MDS status",
"module": "mds",
"perm": "r",
"sig": [
"mds",
"stat"
]
},
"cmd581": {
"flags": 0,
"help": "dump all CephFS status, optionally from epoch",
"module": "mds",
"perm": "r",
"sig": [
"fs",
"dump",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
}
]
},
"cmd582": {
"flags": 0,
"help": "fetch metadata for mds \u003crole\u003e",
"module": "mds",
"perm": "r",
"sig": [
"mds",
"metadata",
{
"name": "who",
"req": false,
"type": "CephString"
}
]
},
"cmd583": {
"flags": 0,
"help": "count MDSs by metadata field property",
"module": "mds",
"perm": "r",
"sig": [
"mds",
"count-metadata",
{
"name": "property",
"type": "CephString"
}
]
},
"cmd584": {
"flags": 0,
"help": "check running versions of MDSs",
"module": "mds",
"perm": "r",
"sig": [
"mds",
"versions"
]
},
"cmd585": {
"flags": 0,
"help": "check whether stopping the specified MDS would reduce immediate availability",
"module": "mds",
"perm": "r",
"sig": [
"mds",
"ok-to-stop",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd586": {
"flags": 32,
"help": "freeze MDS yes/no",
"module": "mds",
"perm": "rw",
"sig": [
"mds",
"freeze",
{
"name": "role_or_gid",
"type": "CephString"
},
{
"name": "val",
"type": "CephString"
}
]
},
"cmd587": {
"flags": 32,
"help": "set mds state of \u003cgid\u003e to \u003cnumeric-state\u003e",
"module": "mds",
"perm": "rw",
"sig": [
"mds",
"set_state",
{
"name": "gid",
"range": "0",
"type": "CephInt"
},
{
"name": "state",
"range": "0|20",
"type": "CephInt"
}
]
},
"cmd588": {
"flags": 0,
"help": "Mark MDS failed: trigger a failover if a standby is available",
"module": "mds",
"perm": "rw",
"sig": [
"mds",
"fail",
{
"name": "role_or_gid",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd589": {
"flags": 0,
"help": "mark a damaged MDS rank as no longer damaged",
"module": "mds",
"perm": "rw",
"sig": [
"mds",
"repaired",
{
"name": "role",
"type": "CephString"
}
]
},
"cmd590": {
"flags": 0,
"help": "remove nonactive mds",
"module": "mds",
"perm": "rw",
"sig": [
"mds",
"rm",
{
"name": "gid",
"range": "0",
"type": "CephInt"
}
]
},
"cmd591": {
"flags": 32,
"help": "remove failed rank",
"module": "mds",
"perm": "rw",
"sig": [
"mds",
"rmfailed",
{
"name": "role",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd592": {
"flags": 4,
"help": "show mds compatibility settings",
"module": "mds",
"perm": "r",
"sig": [
"mds",
"compat",
"show"
]
},
"cmd593": {
"flags": 0,
"help": "show fs compatibility settings",
"module": "mds",
"perm": "r",
"sig": [
"fs",
"compat",
"show",
{
"name": "fs_name",
"type": "CephString"
}
]
},
"cmd594": {
"flags": 4,
"help": "remove compatible feature",
"module": "mds",
"perm": "rw",
"sig": [
"mds",
"compat",
"rm_compat",
{
"name": "feature",
"range": "0",
"type": "CephInt"
}
]
},
"cmd595": {
"flags": 4,
"help": "remove incompatible feature",
"module": "mds",
"perm": "rw",
"sig": [
"mds",
"compat",
"rm_incompat",
{
"name": "feature",
"range": "0",
"type": "CephInt"
}
]
},
"cmd596": {
"flags": 0,
"help": "make new filesystem using named pools \u003cmetadata\u003e and \u003cdata\u003e",
"module": "fs",
"perm": "rw",
"sig": [
"fs",
"new",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "fs_name",
"type": "CephString"
},
{
"name": "metadata",
"type": "CephString"
},
{
"name": "data",
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
},
{
"name": "allow_dangerous_metadata_overlay",
"req": false,
"type": "CephBool"
},
{
"name": "fscid",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "recover",
"req": false,
"type": "CephBool"
}
]
},
"cmd597": {
"flags": 0,
"help": "bring the file system down and all of its ranks",
"module": "fs",
"perm": "rw",
"sig": [
"fs",
"fail",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd598": {
"flags": 0,
"help": "disable the named filesystem",
"module": "fs",
"perm": "rw",
"sig": [
"fs",
"rm",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd599": {
"flags": 0,
"help": "disaster recovery only: reset to a single-MDS map",
"module": "fs",
"perm": "rw",
"sig": [
"fs",
"reset",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd600": {
"flags": 0,
"help": "list filesystems",
"module": "fs",
"perm": "r",
"sig": [
"fs",
"ls"
]
},
"cmd601": {
"flags": 0,
"help": "get info about one filesystem",
"module": "fs",
"perm": "r",
"sig": [
"fs",
"get",
{
"name": "fs_name",
"type": "CephString"
}
]
},
"cmd602": {
"flags": 0,
"help": "set fs parameter \u003cvar\u003e to \u003cval\u003e",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"set",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "var",
"strings": "max_mds|allow_dirfrags|allow_new_snaps|allow_standby_replay|bal_rank_mask|balance_automate|balancer|cluster_down|down|inline_data|joinable|max_file_size|max_xattr_size|min_compat_client|refuse_client_session|refuse_standby_for_another_fs|session_autoclose|session_timeout|standby_count_wanted",
"type": "CephChoices"
},
{
"name": "val",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
},
{
"name": "yes_i_really_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd603": {
"flags": 0,
"help": "Set a global CephFS flag",
"module": "fs",
"perm": "rw",
"sig": [
"fs",
"flag",
"set",
{
"name": "flag_name",
"strings": "enable_multiple",
"type": "CephChoices"
},
{
"name": "val",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd604": {
"flags": 0,
"help": "list available cephfs features to be set/unset",
"module": "mds",
"perm": "r",
"sig": [
"fs",
"feature",
"ls"
]
},
"cmd605": {
"flags": 0,
"help": "list the flags set on a ceph filesystem",
"module": "fs",
"perm": "r",
"sig": [
"fs",
"lsflags",
{
"name": "fs_name",
"type": "CephString"
}
]
},
"cmd606": {
"flags": 0,
"help": "manipulate compat settings",
"module": "fs",
"perm": "rw",
"sig": [
"fs",
"compat",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "subop",
"strings": "rm_compat|rm_incompat|add_compat|add_incompat",
"type": "CephChoices"
},
{
"name": "feature",
"type": "CephInt"
},
{
"name": "feature_str",
"req": false,
"type": "CephString"
}
]
},
"cmd607": {
"flags": 0,
"help": "add/remove required features of clients",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"required_client_features",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "subop",
"strings": "add|rm",
"type": "CephChoices"
},
{
"name": "val",
"type": "CephString"
}
]
},
"cmd608": {
"flags": 0,
"help": "add data pool \u003cpool\u003e",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"add_data_pool",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "pool",
"type": "CephString"
}
]
},
"cmd609": {
"flags": 0,
"help": "remove data pool \u003cpool\u003e",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"rm_data_pool",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "pool",
"type": "CephString"
}
]
},
"cmd610": {
"flags": 4,
"help": "set the default to the named filesystem",
"module": "fs",
"perm": "rw",
"sig": [
"fs",
"set_default",
{
"name": "fs_name",
"type": "CephString"
}
]
},
"cmd611": {
"flags": 0,
"help": "set the default to the named filesystem",
"module": "fs",
"perm": "rw",
"sig": [
"fs",
"set-default",
{
"name": "fs_name",
"type": "CephString"
}
]
},
"cmd612": {
"flags": 0,
"help": "enable mirroring for a ceph filesystem",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"mirror",
"enable",
{
"name": "fs_name",
"type": "CephString"
}
]
},
"cmd613": {
"flags": 0,
"help": "disable mirroring for a ceph filesystem",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"mirror",
"disable",
{
"name": "fs_name",
"type": "CephString"
}
]
},
"cmd614": {
"flags": 0,
"help": "add a mirror peer for a ceph filesystem",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"mirror",
"peer_add",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "uuid",
"type": "CephString"
},
{
"name": "remote_cluster_spec",
"type": "CephString"
},
{
"name": "remote_fs_name",
"type": "CephString"
}
]
},
"cmd615": {
"flags": 0,
"help": "remove a mirror peer for a ceph filesystem",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"mirror",
"peer_remove",
{
"name": "fs_name",
"type": "CephString"
},
{
"name": "uuid",
"type": "CephString"
}
]
},
"cmd616": {
"flags": 0,
"help": "rename a ceph file system",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"rename",
{
"name": "fs_name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "new_fs_name",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd617": {
"flags": 0,
"help": "swap ceph file system names",
"module": "mds",
"perm": "rw",
"sig": [
"fs",
"swap",
{
"name": "fs1_name",
"type": "CephString"
},
{
"name": "fs1_id",
"range": "0",
"type": "CephInt"
},
{
"name": "fs2_name",
"type": "CephString"
},
{
"name": "fs2_id",
"range": "0",
"type": "CephInt"
},
{
"name": "swap_fscids",
"req": true,
"strings": "yes|no",
"type": "CephChoices"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd618": {
"flags": 0,
"help": "dump formatted monmap (optionally from epoch)",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"dump",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
}
]
},
"cmd619": {
"flags": 0,
"help": "summarize monitor status",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"stat"
]
},
"cmd620": {
"flags": 0,
"help": "get monmap",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"getmap",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
}
]
},
"cmd621": {
"flags": 0,
"help": "add new monitor named \u003cname\u003e at \u003caddr\u003e, possibly with CRUSH location \u003clocation\u003e",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"add",
{
"name": "name",
"type": "CephString"
},
{
"name": "addr",
"type": "CephIPAddr"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"n": "N",
"name": "location",
"req": false,
"type": "CephString"
}
]
},
"cmd622": {
"flags": 0,
"help": "remove monitor named \u003cname\u003e",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"rm",
{
"name": "name",
"type": "CephString"
}
]
},
"cmd623": {
"flags": 4,
"help": "remove monitor named \u003cname\u003e",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"remove",
{
"name": "name",
"type": "CephString"
}
]
},
"cmd624": {
"flags": 0,
"help": "list available mon map features to be set/unset",
"module": "mon",
"perm": "r",
"sig": [
"mon",
"feature",
"ls",
{
"name": "with_value",
"req": false,
"type": "CephBool"
}
]
},
"cmd625": {
"flags": 0,
"help": "set provided feature on mon map",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"feature",
"set",
{
"name": "feature_name",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd626": {
"flags": 0,
"help": "set the rank for the specified mon",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"set-rank",
{
"name": "name",
"type": "CephString"
},
{
"name": "rank",
"type": "CephInt"
}
]
},
"cmd627": {
"flags": 0,
"help": "set the addrs (IPs and ports) a specific monitor binds to",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"set-addrs",
{
"name": "name",
"type": "CephString"
},
{
"name": "addrs",
"type": "CephString"
}
]
},
"cmd628": {
"flags": 0,
"help": "set the weight for the specified mon",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"set-weight",
{
"name": "name",
"type": "CephString"
},
{
"name": "weight",
"range": "0|65535",
"type": "CephInt"
}
]
},
"cmd629": {
"flags": 0,
"help": "enable the msgr2 protocol on port 3300",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"enable-msgr2"
]
},
"cmd630": {
"flags": 0,
"help": "set the election strategy to use; choices classic, disallow, connectivity",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"set",
"election_strategy",
{
"name": "strategy",
"type": "CephString"
}
]
},
"cmd631": {
"flags": 0,
"help": "prevent the named mon from being a leader",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"add",
"disallowed_leader",
{
"name": "name",
"type": "CephString"
}
]
},
"cmd632": {
"flags": 0,
"help": "allow the named mon to be a leader again",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"rm",
"disallowed_leader",
{
"name": "name",
"type": "CephString"
}
]
},
"cmd633": {
"flags": 0,
"help": "specify location \u003cargs\u003e for the monitor \u003cname\u003e, using CRUSH bucket names",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"set_location",
{
"name": "name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"n": "N",
"name": "args",
"type": "CephString"
}
]
},
"cmd634": {
"flags": 0,
"help": "enable stretch mode, changing the peering rules and failure handling on all pools with \u003ctiebreaker_mon\u003e as the tiebreaker and setting \u003cdividing_bucket\u003e locations as the units for stretching across",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"enable_stretch_mode",
{
"name": "tiebreaker_mon",
"type": "CephString"
},
{
"name": "new_crush_rule",
"type": "CephString"
},
{
"name": "dividing_bucket",
"type": "CephString"
}
]
},
"cmd635": {
"flags": 0,
"help": "switch the stretch tiebreaker to be the named mon",
"module": "mon",
"perm": "rw",
"sig": [
"mon",
"set_new_tiebreaker",
{
"name": "name",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd636": {
"flags": 0,
"help": "print summary of OSD map",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"stat"
]
},
"cmd637": {
"flags": 0,
"help": "print summary of OSD map",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"dump",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
}
]
},
"cmd638": {
"flags": 0,
"help": "print osd's {id} information (instead of all osds from map)",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"info",
{
"name": "id",
"req": false,
"type": "CephOsdName"
}
]
},
"cmd639": {
"flags": 0,
"help": "print OSD tree",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"tree",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"n": "N",
"name": "states",
"req": false,
"strings": "up|down|in|out|destroyed",
"type": "CephChoices"
}
]
},
"cmd640": {
"flags": 0,
"help": "print OSD tree in bucket",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"tree-from",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "bucket",
"type": "CephString"
},
{
"n": "N",
"name": "states",
"req": false,
"strings": "up|down|in|out|destroyed",
"type": "CephChoices"
}
]
},
"cmd641": {
"flags": 0,
"help": "show all OSD ids",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"ls",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
}
]
},
"cmd642": {
"flags": 0,
"help": "get OSD map",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"getmap",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
}
]
},
"cmd643": {
"flags": 0,
"help": "get CRUSH map",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"getcrushmap",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
}
]
},
"cmd644": {
"flags": 0,
"help": "show largest OSD id",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"getmaxosd"
]
},
"cmd645": {
"flags": 0,
"help": "show OSD ids under bucket \u003cname\u003e in the CRUSH map",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"ls-tree",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "name",
"req": true,
"type": "CephString"
}
]
},
"cmd646": {
"flags": 0,
"help": "find osd \u003cid\u003e in the CRUSH map and show its location",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"find",
{
"name": "id",
"type": "CephOsdName"
}
]
},
"cmd647": {
"flags": 0,
"help": "fetch metadata for osd {id} (default all)",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"metadata",
{
"name": "id",
"req": false,
"type": "CephOsdName"
}
]
},
"cmd648": {
"flags": 0,
"help": "count OSDs by metadata field property",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"count-metadata",
{
"name": "property",
"type": "CephString"
}
]
},
"cmd649": {
"flags": 0,
"help": "check running versions of OSDs",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"versions"
]
},
"cmd650": {
"flags": 0,
"help": "show NUMA status of OSDs",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"numa-status"
]
},
"cmd651": {
"flags": 0,
"help": "find pg for \u003cobject\u003e in \u003cpool\u003e with [namespace]",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"map",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "object",
"type": "CephObjectname"
},
{
"name": "nspace",
"req": false,
"type": "CephString"
}
]
},
"cmd652": {
"flags": 4,
"help": "list pools",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"lspools"
]
},
"cmd653": {
"flags": 4,
"help": "list crush rules",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"rule",
"list"
]
},
"cmd654": {
"flags": 0,
"help": "list crush rules",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"rule",
"ls"
]
},
"cmd655": {
"flags": 0,
"help": "list all crush rules that reference the same \u003cclass\u003e",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"rule",
"ls-by-class",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "class",
"type": "CephString"
}
]
},
"cmd656": {
"flags": 0,
"help": "dump crush rule \u003cname\u003e (default all)",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"rule",
"dump",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"req": false,
"type": "CephString"
}
]
},
"cmd657": {
"flags": 0,
"help": "dump crush map",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"dump"
]
},
"cmd658": {
"flags": 0,
"help": "set crush map from input file",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"setcrushmap",
{
"name": "prior_version",
"req": false,
"type": "CephInt"
}
]
},
"cmd659": {
"flags": 0,
"help": "set crush map from input file",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"set",
{
"name": "prior_version",
"req": false,
"type": "CephInt"
}
]
},
"cmd660": {
"flags": 0,
"help": "add no-parent (probably root) crush bucket \u003cname\u003e of type \u003ctype\u003e to location \u003cargs\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"add-bucket",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"name": "type",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"n": "N",
"name": "args",
"req": false,
"type": "CephString"
}
]
},
"cmd661": {
"flags": 0,
"help": "rename bucket \u003csrcname\u003e to \u003cdstname\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"rename-bucket",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "srcname",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "dstname",
"type": "CephString"
}
]
},
"cmd662": {
"flags": 0,
"help": "update crushmap position and weight for \u003cname\u003e to \u003cweight\u003e with location \u003cargs\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"set",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "weight",
"range": "0.0",
"type": "CephFloat"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"n": "N",
"name": "args",
"type": "CephString"
}
]
},
"cmd663": {
"flags": 0,
"help": "add or update crushmap position and weight for \u003cname\u003e with \u003cweight\u003e and location \u003cargs\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"add",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "weight",
"range": "0.0",
"type": "CephFloat"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"n": "N",
"name": "args",
"type": "CephString"
}
]
},
"cmd664": {
"flags": 0,
"help": "convert all CRUSH current straw buckets to use the straw2 algorithm",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"set-all-straw-buckets-to-straw2"
]
},
"cmd665": {
"flags": 0,
"help": "create crush device class \u003cclass\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"class",
"create",
{
"goodchars": "[A-Za-z0-9-_]",
"name": "class",
"type": "CephString"
}
]
},
"cmd666": {
"flags": 0,
"help": "remove crush device class \u003cclass\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"class",
"rm",
{
"goodchars": "[A-Za-z0-9-_]",
"name": "class",
"type": "CephString"
}
]
},
"cmd667": {
"flags": 0,
"help": "set the \u003cclass\u003e of the osd(s) \u003cid\u003e [\u003cid\u003e...],or use \u003call|any\u003e to set all.",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"set-device-class",
{
"name": "class",
"type": "CephString"
},
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd668": {
"flags": 0,
"help": "remove class of the osd(s) \u003cid\u003e [\u003cid\u003e...],or use \u003call|any\u003e to remove all.",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"rm-device-class",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd669": {
"flags": 0,
"help": "rename crush device class \u003csrcname\u003e to \u003cdstname\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"class",
"rename",
{
"goodchars": "[A-Za-z0-9-_]",
"name": "srcname",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_]",
"name": "dstname",
"type": "CephString"
}
]
},
"cmd670": {
"flags": 0,
"help": "create entry or move existing entry for \u003cname\u003e \u003cweight\u003e at/to location \u003cargs\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"create-or-move",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "weight",
"range": "0.0",
"type": "CephFloat"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"n": "N",
"name": "args",
"type": "CephString"
}
]
},
"cmd671": {
"flags": 0,
"help": "move existing entry for \u003cname\u003e to location \u003cargs\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"move",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"n": "N",
"name": "args",
"type": "CephString"
}
]
},
"cmd672": {
"flags": 0,
"help": "swap existing bucket contents from (orphan) bucket \u003csource\u003e and \u003ctarget\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"swap-bucket",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "source",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "dest",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd673": {
"flags": 0,
"help": "link existing entry for \u003cname\u003e under location \u003cargs\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"link",
{
"name": "name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"n": "N",
"name": "args",
"type": "CephString"
}
]
},
"cmd674": {
"flags": 0,
"help": "remove \u003cname\u003e from crush map (everywhere, or just at \u003cancestor\u003e)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"rm",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "ancestor",
"req": false,
"type": "CephString"
}
]
},
"cmd675": {
"flags": 4,
"help": "remove \u003cname\u003e from crush map (everywhere, or just at \u003cancestor\u003e)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"remove",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "ancestor",
"req": false,
"type": "CephString"
}
]
},
"cmd676": {
"flags": 0,
"help": "unlink \u003cname\u003e from crush map (everywhere, or just at \u003cancestor\u003e)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"unlink",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "ancestor",
"req": false,
"type": "CephString"
}
]
},
"cmd677": {
"flags": 0,
"help": "recalculate the weights for the tree to ensure they sum correctly",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"reweight-all"
]
},
"cmd678": {
"flags": 0,
"help": "change \u003cname\u003e's weight to \u003cweight\u003e in crush map",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"reweight",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"name": "weight",
"range": "0.0",
"type": "CephFloat"
}
]
},
"cmd679": {
"flags": 0,
"help": "change all leaf items beneath \u003cname\u003e to \u003cweight\u003e in crush map",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"reweight-subtree",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"name": "weight",
"range": "0.0",
"type": "CephFloat"
}
]
},
"cmd680": {
"flags": 0,
"help": "set crush tunables values to \u003cprofile\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"tunables",
{
"name": "profile",
"strings": "legacy|argonaut|bobtail|firefly|hammer|jewel|optimal|default",
"type": "CephChoices"
}
]
},
"cmd681": {
"flags": 0,
"help": "set crush tunable \u003ctunable\u003e to \u003cvalue\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"set-tunable",
{
"name": "tunable",
"strings": "straw_calc_version",
"type": "CephChoices"
},
{
"name": "value",
"type": "CephInt"
}
]
},
"cmd682": {
"flags": 0,
"help": "get crush tunable \u003ctunable\u003e",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"get-tunable",
{
"name": "tunable",
"strings": "straw_calc_version",
"type": "CephChoices"
}
]
},
"cmd683": {
"flags": 0,
"help": "show current crush tunables",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"show-tunables"
]
},
"cmd684": {
"flags": 0,
"help": "create crush rule \u003cname\u003e to start from \u003croot\u003e, replicate across buckets of type \u003ctype\u003e, using a choose mode of \u003cfirstn|indep\u003e (default firstn; indep best for erasure pools)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"rule",
"create-simple",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "root",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "type",
"type": "CephString"
},
{
"name": "mode",
"req": false,
"strings": "firstn|indep",
"type": "CephChoices"
}
]
},
"cmd685": {
"flags": 0,
"help": "create crush rule \u003cname\u003e for replicated pool to start from \u003croot\u003e, replicate across buckets of type \u003ctype\u003e, use devices of type \u003cclass\u003e (ssd or hdd)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"rule",
"create-replicated",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "root",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "type",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "class",
"req": false,
"type": "CephString"
}
]
},
"cmd686": {
"flags": 0,
"help": "create crush rule \u003cname\u003e for erasure coded pool created with \u003cprofile\u003e (default default)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"rule",
"create-erasure",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"name": "profile",
"req": false,
"type": "CephString"
}
]
},
"cmd687": {
"flags": 0,
"help": "remove crush rule \u003cname\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"rule",
"rm",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
}
]
},
"cmd688": {
"flags": 0,
"help": "rename crush rule \u003csrcname\u003e to \u003cdstname\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"rule",
"rename",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "srcname",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "dstname",
"type": "CephString"
}
]
},
"cmd689": {
"flags": 0,
"help": "dump crush buckets and items in a tree view",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"tree",
{
"name": "show_shadow",
"req": false,
"type": "CephBool"
}
]
},
"cmd690": {
"flags": 0,
"help": "list items beneath a node in the CRUSH tree",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"ls",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "node",
"type": "CephString"
}
]
},
"cmd691": {
"flags": 0,
"help": "list all crush device classes",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"class",
"ls"
]
},
"cmd692": {
"flags": 0,
"help": "list all osds belonging to the specific \u003cclass\u003e",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"class",
"ls-osd",
{
"goodchars": "[A-Za-z0-9-_]",
"name": "class",
"type": "CephString"
}
]
},
"cmd693": {
"flags": 0,
"help": "get classes of specified osd(s) \u003cid\u003e [\u003cid\u003e...]",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"get-device-class",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd694": {
"flags": 0,
"help": "list crush weight sets",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"weight-set",
"ls"
]
},
"cmd695": {
"flags": 0,
"help": "dump crush weight sets",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"crush",
"weight-set",
"dump"
]
},
"cmd696": {
"flags": 0,
"help": "create a default backward-compatible weight-set",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"weight-set",
"create-compat"
]
},
"cmd697": {
"flags": 0,
"help": "create a weight-set for a given pool",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"weight-set",
"create",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "mode",
"strings": "flat|positional",
"type": "CephChoices"
}
]
},
"cmd698": {
"flags": 0,
"help": "remove the weight-set for a given pool",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"weight-set",
"rm",
{
"name": "pool",
"type": "CephPoolname"
}
]
},
"cmd699": {
"flags": 0,
"help": "remove the backward-compatible weight-set",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"weight-set",
"rm-compat"
]
},
"cmd700": {
"flags": 0,
"help": "set weight for an item (bucket or osd) in a pool's weight-set",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"weight-set",
"reweight",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "item",
"type": "CephString"
},
{
"n": "N",
"name": "weight",
"range": "0.0",
"type": "CephFloat"
}
]
},
"cmd701": {
"flags": 0,
"help": "set weight for an item (bucket or osd) in the backward-compatible weight-set",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"crush",
"weight-set",
"reweight-compat",
{
"name": "item",
"type": "CephString"
},
{
"n": "N",
"name": "weight",
"range": "0.0",
"type": "CephFloat"
}
]
},
"cmd702": {
"flags": 0,
"help": "set new maximum osd value",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"setmaxosd",
{
"name": "newmax",
"range": "0",
"type": "CephInt"
}
]
},
"cmd703": {
"flags": 0,
"help": "set usage ratio at which OSDs are marked full",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"set-full-ratio",
{
"name": "ratio",
"range": "0.0|1.0",
"type": "CephFloat"
}
]
},
"cmd704": {
"flags": 0,
"help": "set usage ratio at which OSDs are marked too full to backfill",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"set-backfillfull-ratio",
{
"name": "ratio",
"range": "0.0|1.0",
"type": "CephFloat"
}
]
},
"cmd705": {
"flags": 0,
"help": "set usage ratio at which OSDs are marked near-full",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"set-nearfull-ratio",
{
"name": "ratio",
"range": "0.0|1.0",
"type": "CephFloat"
}
]
},
"cmd706": {
"flags": 0,
"help": "get the minimum client version we will maintain compatibility with",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"get-require-min-compat-client"
]
},
"cmd707": {
"flags": 0,
"help": "set the minimum client version we will maintain compatibility with",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"set-require-min-compat-client",
{
"name": "version",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd708": {
"flags": 0,
"help": "pause osd",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pause"
]
},
"cmd709": {
"flags": 0,
"help": "unpause osd",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"unpause"
]
},
"cmd710": {
"flags": 0,
"help": "create erasure code profile \u003cname\u003e with [\u003ckey[=value]\u003e ...] pairs. Add a --force at the end to override an existing profile (VERY DANGEROUS)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"erasure-code-profile",
"set",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
},
{
"n": "N",
"name": "profile",
"req": false,
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd711": {
"flags": 0,
"help": "get erasure code profile \u003cname\u003e",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"erasure-code-profile",
"get",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
}
]
},
"cmd712": {
"flags": 0,
"help": "remove erasure code profile \u003cname\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"erasure-code-profile",
"rm",
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "name",
"type": "CephString"
}
]
},
"cmd713": {
"flags": 0,
"help": "list all erasure code profiles",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"erasure-code-profile",
"ls"
]
},
"cmd714": {
"flags": 0,
"help": "set \u003ckey\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"set",
{
"name": "key",
"strings": "full|pause|noup|nodown|noout|noin|nobackfill|norebalance|norecover|noscrub|nodeep-scrub|notieragent|nosnaptrim|pglog_hardlimit|noautoscale",
"type": "CephChoices"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd715": {
"flags": 0,
"help": "unset \u003ckey\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"unset",
{
"name": "key",
"strings": "full|pause|noup|nodown|noout|noin|nobackfill|norebalance|norecover|noscrub|nodeep-scrub|notieragent|nosnaptrim|noautoscale",
"type": "CephChoices"
}
]
},
"cmd716": {
"flags": 0,
"help": "set the minimum allowed OSD release to participate in the cluster",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"require-osd-release",
{
"name": "release",
"strings": "octopus|pacific|quincy|reef",
"type": "CephChoices"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd717": {
"flags": 0,
"help": "set osd(s) \u003cid\u003e [\u003cid\u003e...] down, or use \u003cany|all\u003e to set all osds down",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"down",
{
"n": "N",
"name": "ids",
"type": "CephString"
},
{
"name": "definitely_dead",
"req": false,
"type": "CephBool"
}
]
},
"cmd718": {
"flags": 0,
"help": "stop the corresponding osd daemons and mark them as down",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"stop",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd719": {
"flags": 0,
"help": "set osd(s) \u003cid\u003e [\u003cid\u003e...] out, or use \u003cany|all\u003e to set all osds out",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"out",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd720": {
"flags": 0,
"help": "set osd(s) \u003cid\u003e [\u003cid\u003e...] in, can use \u003cany|all\u003e to automatically set all previously out osds in",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"in",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd721": {
"flags": 4,
"help": "remove osd(s) \u003cid\u003e [\u003cid\u003e...], or use \u003cany|all\u003e to remove all osds",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd722": {
"flags": 4,
"help": "mark osd(s) \u003cid\u003e [\u003cid\u003e...] as noup, or use \u003call|any\u003e to mark all osds as noup",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"add-noup",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd723": {
"flags": 4,
"help": "mark osd(s) \u003cid\u003e [\u003cid\u003e...] as nodown, or use \u003call|any\u003e to mark all osds as nodown",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"add-nodown",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd724": {
"flags": 4,
"help": "mark osd(s) \u003cid\u003e [\u003cid\u003e...] as noin, or use \u003call|any\u003e to mark all osds as noin",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"add-noin",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd725": {
"flags": 4,
"help": "mark osd(s) \u003cid\u003e [\u003cid\u003e...] as noout, or use \u003call|any\u003e to mark all osds as noout",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"add-noout",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd726": {
"flags": 4,
"help": "allow osd(s) \u003cid\u003e [\u003cid\u003e...] to be marked up (if they are currently marked as noup), can use \u003call|any\u003e to automatically filter out all noup osds",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm-noup",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd727": {
"flags": 4,
"help": "allow osd(s) \u003cid\u003e [\u003cid\u003e...] to be marked down (if they are currently marked as nodown), can use \u003call|any\u003e to automatically filter out all nodown osds",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm-nodown",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd728": {
"flags": 4,
"help": "allow osd(s) \u003cid\u003e [\u003cid\u003e...] to be marked in (if they are currently marked as noin), can use \u003call|any\u003e to automatically filter out all noin osds",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm-noin",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd729": {
"flags": 4,
"help": "allow osd(s) \u003cid\u003e [\u003cid\u003e...] to be marked out (if they are currently marked as noout), can use \u003call|any\u003e to automatically filter out all noout osds",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm-noout",
{
"n": "N",
"name": "ids",
"type": "CephString"
}
]
},
"cmd730": {
"flags": 0,
"help": "set \u003cflags\u003e for batch osds or crush nodes, \u003cflags\u003e must be a comma-separated subset of {noup,nodown,noin,noout}",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"set-group",
{
"name": "flags",
"type": "CephString"
},
{
"n": "N",
"name": "who",
"type": "CephString"
}
]
},
"cmd731": {
"flags": 0,
"help": "unset \u003cflags\u003e for batch osds or crush nodes, \u003cflags\u003e must be a comma-separated subset of {noup,nodown,noin,noout}",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"unset-group",
{
"name": "flags",
"type": "CephString"
},
{
"n": "N",
"name": "who",
"type": "CephString"
}
]
},
"cmd732": {
"flags": 0,
"help": "reweight osd to 0.0 \u003c \u003cweight\u003e \u003c 1.0",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"reweight",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "weight",
"range": "0.0|1.0",
"type": "CephFloat"
}
]
},
"cmd733": {
"flags": 0,
"help": "reweight osds with {\u003cid\u003e: \u003cweight\u003e,...}",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"reweightn",
{
"name": "weights",
"type": "CephString"
}
]
},
"cmd734": {
"flags": 0,
"help": "force creation of pg \u003cpgid\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"force-create-pg",
{
"name": "pgid",
"type": "CephPgid"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd735": {
"flags": 0,
"help": "set pg_temp mapping \u003cpgid\u003e:[\u003cid\u003e [\u003cid\u003e...]] (developers only)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pg-temp",
{
"name": "pgid",
"type": "CephPgid"
},
{
"n": "N",
"name": "id",
"req": false,
"type": "CephOsdName"
}
]
},
"cmd736": {
"flags": 0,
"help": "set pg_upmap mapping \u003cpgid\u003e:[\u003cid\u003e [\u003cid\u003e...]] (developers only)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pg-upmap",
{
"name": "pgid",
"type": "CephPgid"
},
{
"n": "N",
"name": "id",
"type": "CephOsdName"
}
]
},
"cmd737": {
"flags": 0,
"help": "clear pg_upmap mapping for \u003cpgid\u003e (developers only)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm-pg-upmap",
{
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd738": {
"flags": 0,
"help": "set pg_upmap_items mapping \u003cpgid\u003e:{\u003cid\u003e to \u003cid\u003e, [...]} (developers only)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pg-upmap-items",
{
"name": "pgid",
"type": "CephPgid"
},
{
"n": "N",
"name": "id",
"type": "CephOsdName"
}
]
},
"cmd739": {
"flags": 0,
"help": "clear pg_upmap_items mapping for \u003cpgid\u003e (developers only)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm-pg-upmap-items",
{
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd740": {
"flags": 0,
"help": "set pg primary osd \u003cpgid\u003e:\u003cid\u003e (id (osd) must be part of pgid)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pg-upmap-primary",
{
"name": "pgid",
"type": "CephPgid"
},
{
"name": "id",
"type": "CephOsdName"
}
]
},
"cmd741": {
"flags": 0,
"help": "clear pg primary setting for \u003cpgid\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm-pg-upmap-primary",
{
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd742": {
"flags": 0,
"help": "clear all pg primary entries (developers only)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm-pg-upmap-primary-all"
]
},
"cmd743": {
"flags": 0,
"help": "set primary_temp mapping pgid:\u003cid\u003e (developers only)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"primary-temp",
{
"name": "pgid",
"type": "CephPgid"
},
{
"name": "id",
"type": "CephOsdName"
}
]
},
"cmd744": {
"flags": 0,
"help": "clear primary_temp mapping pgid (developers only)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"rm-primary-temp",
{
"name": "pgid",
"type": "CephPgid"
}
]
},
"cmd745": {
"flags": 0,
"help": "adjust osd primary-affinity from 0.0 \u003c= \u003cweight\u003e \u003c= 1.0",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"primary-affinity",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "weight",
"range": "0.0|1.0",
"type": "CephFloat"
}
]
},
"cmd746": {
"flags": 32,
"help": "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.",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"destroy-actual",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd747": {
"flags": 0,
"help": "purge all traces of an OSD that was partially created but never started",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"purge-new",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd748": {
"flags": 32,
"help": "purge all osd data from the monitors. Combines `osd destroy`, `osd rm`, and `osd crush rm`.",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"purge-actual",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd749": {
"flags": 0,
"help": "mark osd as permanently lost. THIS DESTROYS DATA IF NO MORE REPLICAS EXIST, BE CAREFUL",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"lost",
{
"name": "id",
"type": "CephOsdName"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd750": {
"flags": 4,
"help": "create new osd (with optional UUID and ID)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"create",
{
"name": "uuid",
"req": false,
"type": "CephUUID"
},
{
"name": "id",
"req": false,
"type": "CephOsdName"
}
]
},
"cmd751": {
"flags": 0,
"help": "Create a new OSD. If supplied, the `id` to be replaced needs to exist and have been previously destroyed. Reads secrets from JSON file via `-i \u003cfile\u003e` (see man page).",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"new",
{
"name": "uuid",
"req": true,
"type": "CephUUID"
},
{
"name": "id",
"req": false,
"type": "CephOsdName"
}
]
},
"cmd752": {
"flags": 0,
"help": "add (optionally until \u003cexpire\u003e seconds from now) or remove \u003caddr\u003e from blocklist",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"blocklist",
{
"goodchars": "[range]",
"name": "range",
"req": false,
"type": "CephString"
},
{
"name": "blocklistop",
"strings": "add|rm",
"type": "CephChoices"
},
{
"name": "addr",
"type": "CephEntityAddr"
},
{
"name": "expire",
"range": "0.0",
"req": false,
"type": "CephFloat"
}
]
},
"cmd753": {
"flags": 0,
"help": "show blocklisted clients",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"blocklist",
"ls"
]
},
"cmd754": {
"flags": 0,
"help": "clear all blocklisted clients",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"blocklist",
"clear"
]
},
"cmd755": {
"flags": 4,
"help": "add (optionally until \u003cexpire\u003e seconds from now) or remove \u003caddr\u003e from blacklist",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"blacklist",
{
"name": "blacklistop",
"strings": "add|rm",
"type": "CephChoices"
},
{
"name": "addr",
"type": "CephEntityAddr"
},
{
"name": "expire",
"range": "0.0",
"req": false,
"type": "CephFloat"
}
]
},
"cmd756": {
"flags": 4,
"help": "show blacklisted clients",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"blacklist",
"ls"
]
},
"cmd757": {
"flags": 4,
"help": "clear all blacklisted clients",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"blacklist",
"clear"
]
},
"cmd758": {
"flags": 0,
"help": "make snapshot \u003csnap\u003e in \u003cpool\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"mksnap",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "snap",
"type": "CephString"
}
]
},
"cmd759": {
"flags": 0,
"help": "remove snapshot \u003csnap\u003e from \u003cpool\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"rmsnap",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "snap",
"type": "CephString"
}
]
},
"cmd760": {
"flags": 0,
"help": "Forces removal of snapshots in the range [lower_snapid_bound, upper_snapid_bound) on pool \u003cpool\u003e in order to cause OSDs to re-trim them.",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"force-remove-snap",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "lower_snapid_bound",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "upper_snapid_bound",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "dry_run",
"req": false,
"type": "CephBool"
}
]
},
"cmd761": {
"flags": 0,
"help": "list pools",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"pool",
"ls",
{
"name": "detail",
"req": false,
"strings": "detail",
"type": "CephChoices"
}
]
},
"cmd762": {
"flags": 0,
"help": "create pool",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"create",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "pg_num",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "pgp_num",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "pool_type",
"req": false,
"strings": "replicated|erasure",
"type": "CephChoices"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "erasure_code_profile",
"req": false,
"type": "CephString"
},
{
"name": "rule",
"req": false,
"type": "CephString"
},
{
"name": "expected_num_objects",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "size",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "pg_num_min",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "pg_num_max",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "autoscale_mode",
"req": false,
"strings": "on|off|warn",
"type": "CephChoices"
},
{
"name": "bulk",
"req": false,
"type": "CephBool"
},
{
"name": "target_size_bytes",
"range": "0",
"req": false,
"type": "CephInt"
},
{
"name": "target_size_ratio",
"range": "0.0",
"req": false,
"type": "CephFloat"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd763": {
"flags": 4,
"help": "delete pool",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"delete",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "pool2",
"req": false,
"type": "CephPoolname"
},
{
"name": "yes_i_really_really_mean_it",
"req": false,
"type": "CephBool"
},
{
"name": "yes_i_really_really_mean_it_not_faking",
"req": false,
"type": "CephBool"
}
]
},
"cmd764": {
"flags": 0,
"help": "remove pool",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"rm",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "pool2",
"req": false,
"type": "CephPoolname"
},
{
"name": "yes_i_really_really_mean_it",
"req": false,
"type": "CephBool"
},
{
"name": "yes_i_really_really_mean_it_not_faking",
"req": false,
"type": "CephBool"
}
]
},
"cmd765": {
"flags": 0,
"help": "rename \u003csrcpool\u003e to \u003cdestpool\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"rename",
{
"name": "srcpool",
"type": "CephPoolname"
},
{
"name": "destpool",
"type": "CephPoolname"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd766": {
"flags": 0,
"help": "get pool parameter \u003cvar\u003e",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"pool",
"get",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "var",
"strings": "size|min_size|pg_num|pgp_num|crush_rule|hashpspool|nodelete|nopgchange|nosizechange|write_fadvise_dontneed|noscrub|nodeep-scrub|hit_set_type|hit_set_period|hit_set_count|hit_set_fpp|use_gmt_hitset|target_max_objects|target_max_bytes|cache_target_dirty_ratio|cache_target_dirty_high_ratio|cache_target_full_ratio|cache_min_flush_age|cache_min_evict_age|erasure_code_profile|min_read_recency_for_promote|all|min_write_recency_for_promote|fast_read|hit_set_grade_decay_rate|hit_set_search_last_n|scrub_min_interval|scrub_max_interval|deep_scrub_interval|recovery_priority|recovery_op_priority|scrub_priority|compression_mode|compression_algorithm|compression_required_ratio|compression_max_blob_size|compression_min_blob_size|csum_type|csum_min_block|csum_max_block|allow_ec_overwrites|fingerprint_algorithm|pg_autoscale_mode|pg_autoscale_bias|pg_num_min|pg_num_max|target_size_bytes|target_size_ratio|dedup_tier|dedup_chunk_algorithm|dedup_cdc_chunk_size|eio|bulk",
"type": "CephChoices"
}
]
},
"cmd767": {
"flags": 0,
"help": "set pool parameter \u003cvar\u003e to \u003cval\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"set",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "var",
"strings": "size|min_size|pg_num|pgp_num|pgp_num_actual|crush_rule|hashpspool|nodelete|nopgchange|nosizechange|write_fadvise_dontneed|noscrub|nodeep-scrub|hit_set_type|hit_set_period|hit_set_count|hit_set_fpp|use_gmt_hitset|target_max_bytes|target_max_objects|cache_target_dirty_ratio|cache_target_dirty_high_ratio|cache_target_full_ratio|cache_min_flush_age|cache_min_evict_age|min_read_recency_for_promote|min_write_recency_for_promote|fast_read|hit_set_grade_decay_rate|hit_set_search_last_n|scrub_min_interval|scrub_max_interval|deep_scrub_interval|recovery_priority|recovery_op_priority|scrub_priority|compression_mode|compression_algorithm|compression_required_ratio|compression_max_blob_size|compression_min_blob_size|csum_type|csum_min_block|csum_max_block|allow_ec_overwrites|fingerprint_algorithm|pg_autoscale_mode|pg_autoscale_bias|pg_num_min|pg_num_max|target_size_bytes|target_size_ratio|dedup_tier|dedup_chunk_algorithm|dedup_cdc_chunk_size|eio|bulk",
"type": "CephChoices"
},
{
"name": "val",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd768": {
"flags": 0,
"help": "set object or byte limit on pool",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"set-quota",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "field",
"strings": "max_objects|max_bytes",
"type": "CephChoices"
},
{
"name": "val",
"type": "CephString"
}
]
},
"cmd769": {
"flags": 0,
"help": "obtain object or byte limits for pool",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"pool",
"get-quota",
{
"name": "pool",
"type": "CephPoolname"
}
]
},
"cmd770": {
"flags": 0,
"help": "enable use of an application \u003capp\u003e [cephfs,rbd,rgw] on pool \u003cpoolname\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"application",
"enable",
{
"name": "pool",
"type": "CephPoolname"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "app",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd771": {
"flags": 0,
"help": "disables use of an application \u003capp\u003e on pool \u003cpoolname\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"application",
"disable",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "app",
"type": "CephString"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd772": {
"flags": 0,
"help": "sets application \u003capp\u003e metadata key \u003ckey\u003e to \u003cvalue\u003e on pool \u003cpoolname\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"application",
"set",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "app",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.]",
"name": "key",
"type": "CephString"
},
{
"goodchars": "[A-Za-z0-9-_.=]",
"name": "value",
"type": "CephString"
}
]
},
"cmd773": {
"flags": 0,
"help": "removes application \u003capp\u003e metadata key \u003ckey\u003e on pool \u003cpoolname\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"pool",
"application",
"rm",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "app",
"type": "CephString"
},
{
"name": "key",
"type": "CephString"
}
]
},
"cmd774": {
"flags": 0,
"help": "get value of key \u003ckey\u003e of application \u003capp\u003e on pool \u003cpoolname\u003e",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"pool",
"application",
"get",
{
"name": "pool",
"req": false,
"type": "CephPoolname"
},
{
"name": "app",
"req": false,
"type": "CephString"
},
{
"name": "key",
"req": false,
"type": "CephString"
}
]
},
"cmd775": {
"flags": 0,
"help": "get basic pg distribution stats",
"module": "osd",
"perm": "r",
"sig": [
"osd",
"utilization"
]
},
"cmd776": {
"flags": 0,
"help": "force a healthy stretch mode, requiring the full number of CRUSH buckets to peer and letting all non-tiebreaker monitors be elected leader ",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"force_healthy_stretch_mode",
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd777": {
"flags": 0,
"help": "try and force a recovery stretch mode, increasing the pool size to its non-failure value if currently degraded and all monitor buckets are up",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"force_recovery_stretch_mode",
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd778": {
"flags": 0,
"help": "Allow crimson-osds to boot and join the cluster. Note, crimson-osd is not yet considered stable and may crash or cause data loss -- should be avoided outside of testing and development. This setting is irrevocable",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"set-allow-crimson",
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd779": {
"flags": 0,
"help": "add the tier \u003ctierpool\u003e (the second one) to base pool \u003cpool\u003e (the first one)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"tier",
"add",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "tierpool",
"type": "CephPoolname"
},
{
"name": "force_nonempty",
"req": false,
"type": "CephBool"
}
]
},
"cmd780": {
"flags": 0,
"help": "remove the tier \u003ctierpool\u003e (the second one) from base pool \u003cpool\u003e (the first one)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"tier",
"rm",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "tierpool",
"type": "CephPoolname"
}
]
},
"cmd781": {
"flags": 4,
"help": "remove the tier \u003ctierpool\u003e (the second one) from base pool \u003cpool\u003e (the first one)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"tier",
"remove",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "tierpool",
"type": "CephPoolname"
}
]
},
"cmd782": {
"flags": 0,
"help": "specify the caching mode for cache tier \u003cpool\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"tier",
"cache-mode",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "mode",
"strings": "writeback|proxy|readproxy|readonly|none",
"type": "CephChoices"
},
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd783": {
"flags": 0,
"help": "set the overlay pool for base pool \u003cpool\u003e to be \u003coverlaypool\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"tier",
"set-overlay",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "overlaypool",
"type": "CephPoolname"
}
]
},
"cmd784": {
"flags": 0,
"help": "remove the overlay pool for base pool \u003cpool\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"tier",
"rm-overlay",
{
"name": "pool",
"type": "CephPoolname"
}
]
},
"cmd785": {
"flags": 4,
"help": "remove the overlay pool for base pool \u003cpool\u003e",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"tier",
"remove-overlay",
{
"name": "pool",
"type": "CephPoolname"
}
]
},
"cmd786": {
"flags": 0,
"help": "add a cache \u003ctierpool\u003e (the second one) of size \u003csize\u003e to existing pool \u003cpool\u003e (the first one)",
"module": "osd",
"perm": "rw",
"sig": [
"osd",
"tier",
"add-cache",
{
"name": "pool",
"type": "CephPoolname"
},
{
"name": "tierpool",
"type": "CephPoolname"
},
{
"name": "size",
"range": "0",
"type": "CephInt"
}
]
},
"cmd787": {
"flags": 0,
"help": "get \u003ckey\u003e",
"module": "config-key",
"perm": "r",
"sig": [
"config-key",
"get",
{
"name": "key",
"type": "CephString"
}
]
},
"cmd788": {
"flags": 0,
"help": "set \u003ckey\u003e to value \u003cval\u003e",
"module": "config-key",
"perm": "rw",
"sig": [
"config-key",
"set",
{
"name": "key",
"type": "CephString"
},
{
"name": "val",
"req": false,
"type": "CephString"
}
]
},
"cmd789": {
"flags": 4,
"help": "put \u003ckey\u003e, value \u003cval\u003e",
"module": "config-key",
"perm": "rw",
"sig": [
"config-key",
"put",
{
"name": "key",
"type": "CephString"
},
{
"name": "val",
"req": false,
"type": "CephString"
}
]
},
"cmd790": {
"flags": 4,
"help": "delete \u003ckey\u003e",
"module": "config-key",
"perm": "rw",
"sig": [
"config-key",
"del",
{
"name": "key",
"type": "CephString"
}
]
},
"cmd791": {
"flags": 0,
"help": "rm \u003ckey\u003e",
"module": "config-key",
"perm": "rw",
"sig": [
"config-key",
"rm",
{
"name": "key",
"type": "CephString"
}
]
},
"cmd792": {
"flags": 0,
"help": "check for \u003ckey\u003e's existence",
"module": "config-key",
"perm": "r",
"sig": [
"config-key",
"exists",
{
"name": "key",
"type": "CephString"
}
]
},
"cmd793": {
"flags": 4,
"help": "list keys",
"module": "config-key",
"perm": "r",
"sig": [
"config-key",
"list"
]
},
"cmd794": {
"flags": 0,
"help": "list keys",
"module": "config-key",
"perm": "r",
"sig": [
"config-key",
"ls"
]
},
"cmd795": {
"flags": 0,
"help": "dump keys and values (with optional prefix)",
"module": "config-key",
"perm": "r",
"sig": [
"config-key",
"dump",
{
"name": "key",
"req": false,
"type": "CephString"
}
]
},
"cmd796": {
"flags": 0,
"help": "dump basic info about the mgr cluster state",
"module": "mgr",
"perm": "r",
"sig": [
"mgr",
"stat"
]
},
"cmd797": {
"flags": 0,
"help": "dump the latest MgrMap",
"module": "mgr",
"perm": "r",
"sig": [
"mgr",
"dump",
{
"name": "epoch",
"range": "0",
"req": false,
"type": "CephInt"
}
]
},
"cmd798": {
"flags": 0,
"help": "set mgr parameter \u003cvar\u003e to \u003cval\u003e",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"set",
{
"name": "var",
"strings": "down",
"type": "CephChoices"
},
{
"name": "val",
"type": "CephString"
}
]
},
"cmd799": {
"flags": 0,
"help": "treat the named manager daemon as failed",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"fail",
{
"name": "who",
"req": false,
"type": "CephString"
}
]
},
"cmd800": {
"flags": 0,
"help": "list active mgr modules",
"module": "mgr",
"perm": "r",
"sig": [
"mgr",
"module",
"ls"
]
},
"cmd801": {
"flags": 0,
"help": "list service endpoints provided by mgr modules",
"module": "mgr",
"perm": "r",
"sig": [
"mgr",
"services"
]
},
"cmd802": {
"flags": 0,
"help": "enable mgr module",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"module",
"enable",
{
"name": "module",
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
}
]
},
"cmd803": {
"flags": 0,
"help": "disable mgr module",
"module": "mgr",
"perm": "rw",
"sig": [
"mgr",
"module",
"disable",
{
"name": "module",
"type": "CephString"
}
]
},
"cmd804": {
"flags": 0,
"help": "dump metadata for all daemons or a specific daemon",
"module": "mgr",
"perm": "r",
"sig": [
"mgr",
"metadata",
{
"name": "who",
"req": false,
"type": "CephString"
}
]
},
"cmd805": {
"flags": 0,
"help": "count ceph-mgr daemons by metadata field property",
"module": "mgr",
"perm": "r",
"sig": [
"mgr",
"count-metadata",
{
"name": "property",
"type": "CephString"
}
]
},
"cmd806": {
"flags": 0,
"help": "check running versions of ceph-mgr daemons",
"module": "mgr",
"perm": "r",
"sig": [
"mgr",
"versions"
]
},
"cmd807": {
"flags": 0,
"help": "Set a configuration option for one or more entities",
"module": "config",
"perm": "rw",
"sig": [
"config",
"set",
{
"name": "who",
"type": "CephString"
},
{
"name": "name",
"type": "CephString"
},
{
"name": "value",
"type": "CephString"
},
{
"name": "force",
"req": false,
"type": "CephBool"
}
]
},
"cmd808": {
"flags": 0,
"help": "Clear a configuration option for one or more entities",
"module": "config",
"perm": "rw",
"sig": [
"config",
"rm",
{
"name": "who",
"type": "CephString"
},
{
"name": "name",
"type": "CephString"
}
]
},
"cmd809": {
"flags": 0,
"help": "Show configuration option(s) for an entity",
"module": "config",
"perm": "r",
"sig": [
"config",
"get",
{
"name": "who",
"type": "CephString"
},
{
"name": "key",
"req": false,
"type": "CephString"
}
]
},
"cmd810": {
"flags": 0,
"help": "Show all configuration option(s)",
"module": "mon",
"perm": "r",
"sig": [
"config",
"dump"
]
},
"cmd811": {
"flags": 0,
"help": "Describe a configuration option",
"module": "config",
"perm": "r",
"sig": [
"config",
"help",
{
"name": "key",
"type": "CephString"
}
]
},
"cmd812": {
"flags": 0,
"help": "List available configuration options",
"module": "config",
"perm": "r",
"sig": [
"config",
"ls"
]
},
"cmd813": {
"flags": 0,
"help": "Assimilate options from a conf, and return a new, minimal conf file",
"module": "config",
"perm": "rw",
"sig": [
"config",
"assimilate-conf"
]
},
"cmd814": {
"flags": 0,
"help": "Show recent history of config changes",
"module": "config",
"perm": "r",
"sig": [
"config",
"log",
{
"name": "num",
"req": false,
"type": "CephInt"
}
]
},
"cmd815": {
"flags": 0,
"help": "Revert configuration to a historical version specified by \u003cnum\u003e",
"module": "config",
"perm": "rw",
"sig": [
"config",
"reset",
{
"name": "num",
"range": "0",
"type": "CephInt"
}
]
},
"cmd816": {
"flags": 0,
"help": "Generate a minimal ceph.conf file",
"module": "config",
"perm": "r",
"sig": [
"config",
"generate-minimal-conf"
]
},
"cmd817": {
"flags": 33,
"help": "inject config arguments into monitor",
"module": "mon",
"perm": "rw",
"sig": [
"injectargs",
{
"n": "N",
"name": "injected_args",
"type": "CephString"
}
]
},
"cmd818": {
"flags": 33,
"help": "Query health metrics for underlying device",
"module": "mon",
"perm": "rw",
"sig": [
"smart",
{
"name": "devid",
"req": false,
"type": "CephString"
}
]
},
"cmd819": {
"flags": 33,
"help": "report status of monitors",
"module": "mon",
"perm": "r",
"sig": [
"mon_status"
]
},
"cmd820": {
"flags": 33,
"help": "show heap usage info (available only if compiled with tcmalloc)",
"module": "mon",
"perm": "rw",
"sig": [
"heap",
{
"name": "heapcmd",
"strings": "dump|start_profiler|stop_profiler|release|stats",
"type": "CephChoices"
},
{
"name": "value",
"req": false,
"type": "CephString"
}
]
},
"cmd821": {
"flags": 33,
"help": "show the scores used in connectivity-based elections",
"module": "mon",
"perm": "rwx",
"sig": [
"connection",
"scores",
"dump"
]
},
"cmd822": {
"flags": 33,
"help": "reset the scores used in connectivity-based elections",
"module": "mon",
"perm": "rwx",
"sig": [
"connection",
"scores",
"reset"
]
},
"cmd823": {
"flags": 33,
"help": "force sync of and clear monitor store",
"module": "mon",
"perm": "rw",
"sig": [
"sync_force",
{
"name": "yes_i_really_mean_it",
"req": false,
"type": "CephBool"
}
]
},
"cmd824": {
"flags": 33,
"help": "add peer address as potential bootstrap peer for cluster bringup",
"module": "mon",
"perm": "rw",
"sig": [
"add_bootstrap_peer_hint",
{
"name": "addr",
"type": "CephIPAddr"
}
]
},
"cmd825": {
"flags": 33,
"help": "add peer address vector as potential bootstrap peer for cluster bringup",
"module": "mon",
"perm": "rw",
"sig": [
"add_bootstrap_peer_hintv",
{
"name": "addrv",
"type": "CephString"
}
]
},
"cmd826": {
"flags": 33,
"help": "force monitor back into quorum",
"module": "mon",
"perm": "rw",
"sig": [
"quorum",
"enter"
]
},
"cmd827": {
"flags": 33,
"help": "force monitor out of the quorum",
"module": "mon",
"perm": "rw",
"sig": [
"quorum",
"exit"
]
},
"cmd828": {
"flags": 33,
"help": "show the ops currently in flight",
"module": "mon",
"perm": "r",
"sig": [
"ops"
]
},
"cmd829": {
"flags": 33,
"help": "list existing sessions",
"module": "mon",
"perm": "r",
"sig": [
"sessions"
]
},
"cmd830": {
"flags": 33,
"help": "show recent ops",
"module": "mon",
"perm": "r",
"sig": [
"dump_historic_ops"
]
},
"cmd831": {
"flags": 33,
"help": "show recent slow ops",
"module": "mon",
"perm": "r",
"sig": [
"dump_historic_slow_ops"
]
}
}