OS Manuals

/usr/bin/cephadm

Ceph cephadm orchestrator CLI

From ceph-19-cephadm 19.2.7-r4 (enterprise-packages), captured 2026-11-08 by running cephadm --help (exit 0). permalink

usage: cephadm [-h] [--image IMAGE] [--docker] [--data-dir DATA_DIR] [--log-dir LOG_DIR]
               [--logrotate-dir LOGROTATE_DIR] [--sysctl-dir SYSCTL_DIR] [--unit-dir UNIT_DIR]
               [--verbose] [--log-dest {file,syslog}] [--timeout TIMEOUT] [--retry RETRY]
               [--env ENV] [--no-container-init] [--no-cgroups-split]
               {version,pull,inspect-image,ls,list-networks,adopt,rm-daemon,rm-cluster,run,shell,enter,ceph-volume,zap-osds,unit,unit-install,logs,bootstrap,deploy,_orch,check-host,prepare-host,add-repo,rm-repo,install,registry-login,gather-facts,host-maintenance,agent,disk-rescan}
               ...

Bootstrap Ceph daemons with systemd and containers.

positional arguments:
  {version,pull,inspect-image,ls,list-networks,adopt,rm-daemon,rm-cluster,run,shell,enter,ceph-volume,zap-osds,unit,unit-install,logs,bootstrap,deploy,_orch,check-host,prepare-host,add-repo,rm-repo,install,registry-login,gather-facts,host-maintenance,agent,disk-rescan}
                        sub-command
    version             get cephadm version
    pull                pull a ceph container image (will pull the default image if --image not
                        provided)
    inspect-image       inspect local container image
    ls                  list daemon instances on this host
    list-networks       list IP networks
    adopt               adopt daemon deployed with a different tool
    rm-daemon           remove daemon instance
    rm-cluster          remove all daemons for a cluster
    run                 run a ceph daemon, in a container, in the foreground
    shell               run an interactive shell inside a daemon container
    enter               run an interactive shell inside a running daemon container
    ceph-volume         run ceph-volume inside a container
    zap-osds            zap all OSDs associated with a particular fsid
    unit                operate on the daemon's systemd unit
    unit-install        Install the daemon's systemd unit
    logs                print journald logs for a daemon container
    bootstrap           bootstrap a cluster (mon + mgr daemons)
    deploy              deploy a daemon
    check-host          check host configuration
    prepare-host        prepare a host for cephadm use
    add-repo            configure package repository
    rm-repo             remove package repository configuration
    install             install ceph package(s)
    registry-login      log host into authenticated registry
    gather-facts        gather and return host related information (JSON format)
    host-maintenance    Manage the maintenance state of a host
    agent               start cephadm agent
    disk-rescan         rescan all HBAs to detect new/removed devices

options:
  -h, --help            show this help message and exit
  --image IMAGE         container image. Can also be set via the "CEPHADM_IMAGE" env var (default:
                        None)
  --docker              use docker instead of podman (default: False)
  --data-dir DATA_DIR   base directory for daemon data (default: /var/lib/ceph)
  --log-dir LOG_DIR     base directory for daemon logs (default: /var/log/ceph)
  --logrotate-dir LOGROTATE_DIR
                        location of logrotate configuration files (default: /etc/logrotate.d)
  --sysctl-dir SYSCTL_DIR
                        location of sysctl configuration files (default: /etc/sysctl.d)
  --unit-dir UNIT_DIR   base directory for systemd units (default: /etc/systemd/system)
  --verbose, -v         Show debug-level log messages (default: False)
  --log-dest {file,syslog}
                        select one or more destination for persistent logging (default: None)
  --timeout TIMEOUT     timeout in seconds (default: None)
  --retry RETRY         max number of retries (default: 15)
  --env ENV, -e ENV     set environment variable (default: [])
  --no-container-init   Do not run podman/docker with `--init` (default: False)
  --no-cgroups-split    Do not run containers with --cgroups=split (currently only relevant when
                        using podman) (default: False)
Options (15)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--image IMAGEcontainer image.help + man
--dockeruse docker instead of podman (default: False)help + man
--data-dir DATA_DIRbase directory for daemon data (default: /var/lib/ceph)help + man
--log-dir LOG_DIRbase directory for daemon logs (default: /var/log/ceph)help + man
--logrotate-dir LOGROTATE_DIRlocation of logrotate configuration files (default: /etc/logrotate.d)help + man
--sysctl-dir SYSCTL_DIRlocation of sysctl configuration files (default: /etc/sysctl.d)help
--unit-dir UNIT_DIRbase directory for systemd units (default: /etc/systemd/system)help + man
--verbose, -vShow debug-level log messages (default: False)help + man
--log-dest fileselect one or more destination for persistent logging (default: None)help
--timeout TIMEOUTtimeout in seconds (default: None)help + man
--retry RETRYmax number of retries (default: 15)help + man
--env, -e ENVset environment variable (default: [])help
--no-container-initDo not run podman/docker with `--init` (default: False)help + man
--no-cgroups-splitDo not run containers with --cgroups=split (currently only relevant when using podman) (default: False)help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.