General usage:
==============
usage: ceph [-h] [-c CEPHCONF] [-i INPUT_FILE] [-o OUTPUT_FILE]
[--setuser SETUSER] [--setgroup SETGROUP] [--id CLIENT_ID]
[--name CLIENT_NAME] [--cluster CLUSTER]
[--admin-daemon ADMIN_SOCKET] [-s] [-w] [--watch-debug]
[--watch-info] [--watch-sec] [--watch-warn] [--watch-error]
[--watch-channel WATCH_CHANNEL] [--version] [--verbose]
[--concise] [-f {json,json-pretty,xml,xml-pretty,plain}]
[--connect-timeout CLUSTER_TIMEOUT]
Ceph administration tool
optional arguments:
-h, --help request mon help
-c CEPHCONF, --conf CEPHCONF
ceph configuration file
-i INPUT_FILE, --in-file INPUT_FILE
input file, or "-" for stdin
-o OUTPUT_FILE, --out-file OUTPUT_FILE
output file, or "-" for stdout
--setuser SETUSER set user file permission
--setgroup SETGROUP set group file permission
--id CLIENT_ID, --user CLIENT_ID
client id for authentication
--name CLIENT_NAME, -n CLIENT_NAME
client name for authentication
--cluster CLUSTER cluster name
--admin-daemon ADMIN_SOCKET
submit admin-socket commands ("help" for help
-s, --status show cluster status
-w, --watch watch live cluster changes
--watch-debug watch debug events
--watch-info watch info events
--watch-sec watch security events
--watch-warn watch warn events
--watch-error watch error events
--watch-channel WATCH_CHANNEL
which log channel to follow when using -w/--watch. One
of ['cluster', 'audit', '*'
--version, -v display version
--verbose make verbose
--concise make less verbose
-f {json,json-pretty,xml,xml-pretty,plain}, --format {json,json-pretty,xml,xml-pretty,plain}
--connect-timeout CLUSTER_TIMEOUT
set a timeout for connecting to the cluster
Local commands:
===============
ping Send simple presence/life test to a mon
may be 'mon.*' for all mons
daemon {type.id|path}
Same as --admin-daemon, but auto-find admin socket
daemonperf {type.id | path} [stat-pats] [priority] [] []
daemonperf {type.id | path} list|ls [stat-pats] [priority]
Get selected perf stats from daemon/admin socket
Optional shell-glob comma-delim match string stat-pats
Optional selection priority (can abbreviate name):
critical, interesting, useful, noninteresting, debug
List shows a table of all available stats
Run times (default forever),
once per seconds (default 1)
Monitor commands:
=================
auth add { [...]} add auth info for from input file, or random key if no input is given, and/or any caps specified in the
command
auth caps [...] update caps for from caps specified in the command
auth export {} write keyring for requested entity, or master keyring if none given
auth get write keyring file with requested key
auth get-key display requested key
auth get-or-create { [...]} add auth info for from input file, or random key if no input given, and/or any caps specified in the command
auth get-or-create-key { [...]} get, or add, key for from system/caps pairs specified in the command. If key already exists, any given caps
must match the existing caps for that key.
auth import auth import: read keyring file from -i
auth ls list authentication state
auth print-key display requested key
auth print_key display requested key
auth rm remove all caps for
balancer dump Show an optimization plan
balancer eval {} Evaluate data distribution for the current cluster or specific pool or specific plan
balancer eval-verbose { } Evaluate data distribution for the current cluster or specific pool or specific plan (verbosely)
balancer execute Execute an optimization plan
balancer ls List all plans
balancer mode none|crush-compat|upmap Set balancer mode
balancer off Disable automatic balancing
balancer on Enable automatic balancing
balancer optimize { [...]} Run optimizer to create a new plan
balancer pool add [...] Enable automatic balancing for specific pools
balancer pool ls List automatic balancing pools. Note that empty list means all existing pools will be automatic balancing targets,
which is the default behaviour of balancer.
balancer pool rm [...] Disable automatic balancing for specific pools
balancer reset Discard all optimization plans
balancer rm Discard an optimization plan
balancer show Show details of an optimization plan
balancer status Show balancer status
config assimilate-conf Assimilate options from a conf, and return a new, minimal conf file
config dump Show all configuration option(s)
config generate-minimal-conf Generate a minimal ceph.conf file
config get {} Show configuration option(s) for an entity
config help Describe a configuration option
config log {} Show recent history of config changes
config ls List available configuration options
config reset Revert configuration to previous state
config rm Clear a configuration option for one or more entities
config set {--force} Set a configuration option for one or more entities
config show {} Show running configuration
config show-with-defaults Show running configuration (including compiled-in defaults)
config-key dump {} dump keys and values (with optional prefix)
config-key exists check for 's existence
config-key get get
config-key ls list keys
config-key rm rm
config-key set {} set to value
crash info show crash dump metadata
crash json_report Crashes in the last hours
crash ls Show saved crash dumps
crash post Add a crash dump (use -i )
crash prune Remove crashes older than days
crash rm Remove a saved crash
crash stat Summarize recorded crashes
deepsea config-set Set a configuration value
deepsea config-show Show current configuration
device check-health Check life expectancy of devices
device get-health-metrics {} Show stored device metrics for the device
device info Show information about a device
device ls Show devices
device ls-by-daemon Show devices associated with a daemon
device ls-by-host Show devices on a host
device monitoring off Disable device health monitoring
device monitoring on Enable device health monitoring
device predict-life-expectancy {} Predict life expectancy with local predictor
device query-daemon-health-metrics Get device health metrics for a given daemon
device rm-life-expectancy Clear predicted device life expectancy
device scrape-daemon-health-metrics Scrape and store device health metrics for a given daemon
device scrape-health-metrics {} Scrape and store health metrics
device set-life-expectancy {} Set predicted device life expectancy
df {detail} show cluster free space stats
features report of connected features
fs add_data_pool add data pool
fs authorize [...] add auth for to access file system based on following directory and permissions pairs
fs dump {} dump all CephFS status, optionally from epoch
fs fail bring the file system down and all of its ranks
fs flag set enable_multiple {--yes-i-really-mean-it} Set a global CephFS flag
fs get get info about one filesystem
fs ls list filesystems
fs new {--force} {--allow-dangerous-metadata-overlay} make new filesystem using named pools and
fs reset {--yes-i-really-mean-it} disaster recovery only: reset to a single-MDS map
fs rm {--yes-i-really-mean-it} disable the named filesystem
fs rm_data_pool remove data pool
fs set max_mds|max_file_size|allow_new_snaps|inline_data|cluster_down|allow_dirfrags|balancer|standby_ set fs parameter to
count_wanted|session_timeout|session_autoclose|allow_standby_replay|down|joinable|min_compat_client {--yes-i-
really-mean-it}
fs set-default set the default to the named filesystem
fs status {} Show the status of a CephFS filesystem
fs subvolume create {} Create a CephFS subvolume within an existing volume
fs subvolume rm Delete a CephFS subvolume
fs volume create {} Create a CephFS volume
fs volume ls List volumes
fs volume rm Delete a CephFS volume
fsid show cluster FSID/UUID
health {detail} show cluster health
heap dump|start_profiler|stop_profiler|release|stats show heap usage info (available only if compiled with tcmalloc)
influx config-set Set a configuration value
influx config-show Show current configuration
influx send Force sending data to Influx
injectargs [...] inject config arguments into monitor
insights Retrieve insights report
insights prune-health Remove health history older than hours
iostat Get IO rates
log [...] log supplied text to the monitor log
log last {} {debug|info|sec|warn|error} {*|cluster|audit} print last few lines of the cluster log
mds compat rm_compat remove compatible feature
mds compat rm_incompat remove incompatible feature
mds compat show show mds compatibility settings
mds count-metadata count MDSs by metadata field property
mds fail Mark MDS failed: trigger a failover if a standby is available
mds freeze freeze MDS yes/no
mds metadata {} fetch metadata for mds
mds ok-to-stop [...] check whether stopping the specified MDS would reduce immediate availability
mds repaired mark a damaged MDS rank as no longer damaged
mds rm remove nonactive mds
mds rmfailed {--yes-i-really-mean-it} remove failed rank
mds set_state set mds state of to
mds stat show MDS status
mds versions check running versions of MDSs
mgr count-metadata count ceph-mgr daemons by metadata field property
mgr dump {} dump the latest MgrMap
mgr fail treat the named manager daemon as failed
mgr metadata {} dump metadata for all daemons or a specific daemon
mgr module disable disable mgr module
mgr module enable {--force} enable mgr module
mgr module ls list active mgr modules
mgr self-test background start Activate a background workload (one of command_spam, throw_exception)
mgr self-test background stop Stop background workload if any is running
mgr self-test cluster-log Create an audit log record.
mgr self-test config get Peek at a configuration value
mgr self-test config get_localized Peek at a configuration value (localized variant)
mgr self-test health clear { [...]} Clear health checks by name. If no names provided, clear all.
mgr self-test health set Set a health check from a JSON-formatted description.
mgr self-test insights_set_now_offset Set the now time for the insights module.
mgr self-test module Run another module's self_test() method
mgr self-test remote Test inter-module calls
mgr self-test run Run mgr python interface tests
mgr services list service endpoints provided by mgr modules
mgr versions check running versions of ceph-mgr daemons
mon add add new monitor named at
mon compact cause compaction of monitor's leveldb/rocksdb storage
mon count-metadata count mons by metadata field property
mon dump {} dump formatted monmap (optionally from epoch)
mon enable-msgr2 enable the msgr2 protocol on port 3300
mon feature ls {--with-value} list available mon map features to be set/unset
mon feature set {--yes-i-really-mean-it} set provided feature on mon map
mon getmap {} get monmap
mon metadata {} fetch metadata for mon
mon ok-to-add-offline check whether adding a mon and not starting it would break quorum
mon ok-to-rm check whether removing the specified mon would break quorum
mon ok-to-stop [...] check whether mon(s) can be safely stopped without reducing immediate availability
mon rm remove monitor named
mon scrub scrub the monitor stores
mon set-addrs set the addrs (IPs and ports) a specific monitor binds to
mon set-rank set the rank for the specified mon
mon stat summarize monitor status
mon sync force {--yes-i-really-mean-it} {--i-know-what-i-am-doing} force sync of and clear monitor store
mon versions check running versions of monitors
mon_status report status of monitors
node ls {all|osd|mon|mds|mgr} list all nodes in cluster [type]
orchestrator device ls { [...]} {json|plain} {--refresh} List devices on a node
orchestrator host add {} Add a host
orchestrator host ls List hosts
orchestrator host rm {} Remove a host
orchestrator mds add Create an MDS service
orchestrator mds rm Remove an MDS service
orchestrator mgr update {} { [...]} Update the number of manager instances
orchestrator mon update {} { [...]} Update the number of monitor instances
orchestrator nfs add {} Create an NFS service
orchestrator nfs rm Remove an NFS service
orchestrator nfs update Scale an NFS service
orchestrator osd create {} Create an OSD service. Either --svc_arg=host:drives or -i
orchestrator osd rm [...] Remove OSD services
orchestrator rgw add Create an RGW service
orchestrator rgw rm Remove an RGW service
orchestrator service ls {} {mon|mgr|osd|mds|nfs|rgw|rbd-mirror} {} {json|plain} List services known to orchestrator
orchestrator service start|stop|reload Start, stop or reload an entire service (i.e. all daemons)
orchestrator service-instance start|stop|reload Start, stop or reload a specific service instance
orchestrator set backend {} Select orchestrator module backend
orchestrator status Report configured backend and its status
osd add-nodown [...] mark osd(s) [...] as nodown, or use to mark all osds as nodown
osd add-noin [...] mark osd(s) [...] as noin, or use to mark all osds as noin
osd add-noout [...] mark osd(s) [...] as noout, or use to mark all osds as noout
osd add-noup [...] mark osd(s) [...] as noup, or use to mark all osds as noup
osd blacklist add|rm {} add (optionally until seconds from now) or remove 