OS Manuals

/usr/bin/cephcsi

CSI driver for Ceph

From cephcsi 3.18.2-r0 (enterprise-packages), captured 2026-11-08 by running cephcsi --help (exit 0). permalink

Also provided by 1 other package version
Usage of /usr/bin/cephcsi:
  -add_dir_header
    	If true, adds the file directory to the header of the log messages
  -alsologtostderr
    	log to standard error as well as files (no effect when -logtostderr=true)
  -alsologtostderrthreshold value
    	logs at or above this threshold go to stderr when -alsologtostderr=true (no effect when -logtostderr=true)
  -automaxprocs
    	automatically set GOMAXPROCS to match Linux container CPU quota
  -clustername string
    	name of the cluster
  -controllerserver
    	start cephcsi controller server
  -crush-location-labels string
    	list of Kubernetes node labels, that determines the CRUSH location the node belongs to, separated by ','
  -csi-addons-endpoint string
    	CSI-Addons endpoint (default "unix:///tmp/csi-addons.sock")
  -domainlabels string
    	list of Kubernetes node labels, that determines the topology domain the node belongs to, separated by ','
  -drivername string
    	name of the driver
  -drivernamespace string
    	namespace in which driver is deployed (default "default")
  -enable-fencing
    	enable fencing of nodes during non-graceful shutdowns
  -enable-read-affinity
    	enable read affinity
  -enableprofiling
    	enable go profiling
  -endpoint string
    	CSI endpoint (default "unix:///tmp/csi.sock")
  -feature-gates string
    	comma-separated list of feature gates (e.g., SlowGRPCRestart=false)
  -forcecephkernelclient
    	enable Ceph Kernel clients on kernel < 4.17 which support quotas
  -fusemountoptions string
    	Comma separated string of mount options accepted by ceph-fuse mounter
  -instanceid string
    	Unique ID distinguishing this instance of Ceph-CSI among other instances, when sharing Ceph clusters across CSI instances for provisioning (default "default")
  -kernelmountoptions string
    	Comma separated string of mount options accepted by cephfs kernel mounter
  -kubeconfig string
    	Paths to a kubeconfig. Only required if out-of-cluster.
  -legacy_stderr_threshold_behavior
    	If true, stderrthreshold is ignored when logtostderr=true (legacy behavior). If false, stderrthreshold is honored even when logtostderr=true (default true)
  -log_backtrace_at value
    	when logging hits line file:N, emit a stack trace
  -log_dir string
    	If non-empty, write log files in this directory (no effect when -logtostderr=true)
  -log_file string
    	If non-empty, use this log file (no effect when -logtostderr=true)
  -log_file_max_size uint
    	Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
  -logslowopinterval duration
    	how often to inform about slow gRPC calls (default 30s)
  -logtostderr
    	log to standard error instead of files (default true)
  -maxsnapshotsonimage uint
    	Maximum number of snapshots allowed on rbd image without flattening (default 450)
  -metricspath string
    	path of prometheus endpoint where metrics will be available (default "/metrics")
  -metricsport int
    	TCP port for liveness/profile metrics requests (default 8080)
  -minsnapshotsonimage uint
    	Minimum number of snapshots required on rbd image to start flattening (default 250)
  -nodeid string
    	node id
  -nodeserver
    	start cephcsi node server
  -one_output
    	If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
  -pidlimit int
    	the PID limit to configure through cgroups
  -pluginpath string
    	plugin path (default "/var/lib/kubelet/plugins")
  -polltime duration
    	time interval in seconds between each poll (default 1m0s)
  -radosnamespacecephfs string
    	CephFS RadosNamespace used to store CSI specific objects and keys.
  -rbdhardmaxclonedepth uint
    	Hard limit for maximum number of nested volume clones that are taken before a flatten occurs (default 8)
  -rbdsoftmaxclonedepth uint
    	Soft limit for maximum number of nested volume clones that are taken before a flatten occurs (default 4)
  -setmetadata
    	[DEPRECATED] this flag is deprecated and will be removed in a future release. Metadata is now always set on volumes regardless of this flag's value (default true)
  -skip_headers
    	If true, avoid header prefixes in the log messages
  -skip_log_headers
    	If true, avoid headers when opening log files (no effect when -logtostderr=true)
  -skipforceflatten
    	skip image flattening if kernel support mapping of rbd images which has the deep-flatten feature
  -stagingpath string
    	staging path (default "/var/lib/kubelet/plugins/kubernetes.io/csi/")
  -stderrthreshold value
    	logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true unless -legacy_stderr_threshold_behavior=false) (default 2)
  -timeout duration
    	probe timeout in seconds (default 3s)
  -type string
    	driver type [rbd|cephfs|nfs|nvmeof|liveness|controller]
  -v value
    	number for the log level verbosity
  -version
    	Print cephcsi version information
  -vmodule value
    	comma-separated list of pattern=N settings for file-filtered logging
Options (52)
OptionDescriptionSource
-add_dir_headerIf true, adds the file directory to the header of the log messageshelp
-alsologtostderrlog to standard error as well as files (no effect when -logtostderr=true)help
-alsologtostderrthreshold valuelogs at or above this threshold go to stderr when -alsologtostderr=true (no effect when -logtostderr=true)help
-automaxprocsautomatically set GOMAXPROCS to match Linux container CPU quotahelp
-clustername stringname of the clusterhelp
-controllerserverstart cephcsi controller serverhelp
-crush-location-labels stringlist of Kubernetes node labels, that determines the CRUSH location the node belongs to, separated by ','help
-csi-addons-endpoint stringCSI-Addons endpoint (default "unix:///tmp/csi-addons.sock")help
-domainlabels stringlist of Kubernetes node labels, that determines the topology domain the node belongs to, separated by ','help
-drivername stringname of the driverhelp
-drivernamespace stringnamespace in which driver is deployed (default "default")help
-enable-fencingenable fencing of nodes during non-graceful shutdownshelp
-enable-read-affinityenable read affinityhelp
-enableprofilingenable go profilinghelp
-endpoint stringCSI endpoint (default "unix:///tmp/csi.sock")help
-feature-gates stringcomma-separated list of feature gates (e.g., SlowGRPCRestart=false)help
-forcecephkernelclientenable Ceph Kernel clients on kernel < 4.17 which support quotashelp
-fusemountoptions stringComma separated string of mount options accepted by ceph-fuse mounterhelp
-instanceid stringUnique ID distinguishing this instance of Ceph-CSI among other instances, when sharing Ceph clusters across CSI instances for provisioning (default "default")help
-kernelmountoptions stringComma separated string of mount options accepted by cephfs kernel mounterhelp
-kubeconfig stringPaths to a kubeconfig.help
-legacy_stderr_threshold_behaviorIf true, stderrthreshold is ignored when logtostderr=true (legacy behavior).help
-log_backtrace_at valuewhen logging hits line file:N, emit a stack tracehelp
-log_dir stringIf non-empty, write log files in this directory (no effect when -logtostderr=true)help
-log_file stringIf non-empty, use this log file (no effect when -logtostderr=true)help
-log_file_max_size uintDefines the maximum size a log file can grow to (no effect when -logtostderr=true).help
-logslowopinterval durationhow often to inform about slow gRPC calls (default 30s)help
-logtostderrlog to standard error instead of files (default true)help
-maxsnapshotsonimage uintMaximum number of snapshots allowed on rbd image without flattening (default 450)help
-metricspath stringpath of prometheus endpoint where metrics will be available (default "/metrics")help
-metricsport intTCP port for liveness/profile metrics requests (default 8080)help
-minsnapshotsonimage uintMinimum number of snapshots required on rbd image to start flattening (default 250)help
-nodeid stringnode idhelp
-nodeserverstart cephcsi node serverhelp
-one_outputIf true, only write logs to their native severity level (vs also writing to each lower severity level;help
-pidlimit intthe PID limit to configure through cgroupshelp
-pluginpath stringplugin path (default "/var/lib/kubelet/plugins")help
-polltime durationtime interval in seconds between each poll (default 1m0s)help
-radosnamespacecephfs stringCephFS RadosNamespace used to store CSI specific objects and keys.help
-rbdhardmaxclonedepth uintHard limit for maximum number of nested volume clones that are taken before a flatten occurs (default 8)help
-rbdsoftmaxclonedepth uintSoft limit for maximum number of nested volume clones that are taken before a flatten occurs (default 4)help
-setmetadata[DEPRECATED] this flag is deprecated and will be removed in a future release.help
-skip_headersIf true, avoid header prefixes in the log messageshelp
-skip_log_headersIf true, avoid headers when opening log files (no effect when -logtostderr=true)help
-skipforceflattenskip image flattening if kernel support mapping of rbd images which has the deep-flatten featurehelp
-stagingpath stringstaging path (default "/var/lib/kubelet/plugins/kubernetes.io/csi/")help
-stderrthreshold valuelogs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true unless -legacy_stderr_threshold_behavior=false) (default 2)help
-timeout durationprobe timeout in seconds (default 3s)help
-type stringdriver type [rbd|cephfs|nfs|nvmeof|liveness|controller]help
-v valuenumber for the log level verbosityhelp
-versionPrint cephcsi version informationhelp
-vmodule valuecomma-separated list of pattern=N settings for file-filtered logginghelp

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