OS Manuals

/usr/bin/aws-ebs-csi-driver

CSI driver for Amazon EBS.

From aws-ebs-csi-driver-1.64 1.64.0-r10 (enterprise-packages), captured 2026-11-08 by running aws-ebs-csi-driver --help (exit 0). permalink

Usage of aws-ebs-csi-driver:
      --aws-sdk-debug-log                                       To enable the aws sdk debug log level (default to false).
      --batching                                                To enable batching of API calls. This is especially helpful for improving performance in workloads that are sensitive to EC2 rate limits.
      --csi-mount-point-prefix string                           A prefix of the mountpoints of all CSI-managed volumes. If this value is non-empty, all volumes mounted to a path beginning with the provided value are assumed to be CSI volumes owned by the EBS CSI Driver and safe to treat as such (for example, by exposing volume metrics).
      --deprecated-metrics                                      DEPRECATED: To enable deprecated metrics. This parameter is only for backward compatibility and may be removed in a future release.
      --enable-node-local-volumes                               Enable support for node-local volumes that use pre-attached EBS volumes.
      --enable-otel-tracing                                     To enable opentelemetry tracing for the driver. The tracing is disabled by default. Configure the exporter endpoint with OTEL_EXPORTER_OTLP_ENDPOINT and other env variables, see https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration.
      --endpoint string                                         Endpoint for the CSI driver server (default "unix://tmp/csi.sock")
      --extra-tags mapStringString                              Extra tags to attach to each dynamically provisioned resource. It is a comma separated list of key value pairs like '<key1>=<value1>,<key2>=<value2>'
      --extra-volume-tags mapStringString                       DEPRECATED: Please use --extra-tags instead. Extra volume tags to attach to each dynamically provisioned volume. It is a comma separated list of key value pairs like '<key1>=<value1>,<key2>=<value2>'
      --http-endpoint :8080                                     The TCP network address where the HTTP server for metrics will listen (example: :8080). The default is empty string, which means the server is disabled.
      --k8s-tag-cluster-id string                               ID of the Kubernetes cluster used for tagging provisioned EBS volumes (optional).
      --kubeconfig string                                       Absolute path to a kubeconfig file. The default is the empty string, which causes the in-cluster config to be used
      --legacy-xfs bigtime=0,inobtcount=0,reflink=0,nrext64=0   Warning: This option will be removed in a future version of EBS CSI Driver. Formats XFS volumes with bigtime=0,inobtcount=0,reflink=0,nrext64=0, so that they can be mounted onto nodes with linux kernel ≤ v5.4. Volumes formatted with this option may experience issues after 2038, and will be unable to use some XFS features (for example, reflinks).
      --log-flush-frequency duration                            Maximum number of seconds between log flushes (default 5s)
      --log-json-info-buffer-size quantity                      [Alpha] In JSON format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this.
      --log-json-split-stream                                   [Alpha] In JSON format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this.
      --log-text-info-buffer-size quantity                      [Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this.
      --log-text-split-stream                                   [Alpha] In text format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this.
      --logging-format string                                   Sets the log format. Permitted formats: "json" (gated by LoggingBetaOptions), "text". (default "text")
      --logtostderr                                             log to standard error instead of files. DEPRECATED: will be removed in a future release.
      --metadata-sources strings                                Dictates which sources are used to retrieve instance metadata. The driver will attempt to rely on each source in order until one succeeds. Valid options include 'imds', 'kubernetes', and (ALPHA) 'metadata-labeler'. (default [imds,kubernetes])
      --metrics-cert-file string                                The path to a certificate to use for serving the metrics server over HTTPS. If the certificate is signed by a certificate authority, this file should be the concatenation of the server's certificate, any intermediates, and the CA's certificate. If this is non-empty, --http-endpoint and --metrics-key-file MUST also be non-empty.
      --metrics-key-file string                                 The path to a key to use for serving the metrics server over HTTPS. If this is non-empty, --http-endpoint and --metrics-cert-file MUST also be non-empty.
      --modify-volume-request-handler-timeout duration          Timeout for the window in which volume modification calls must be received in order for them to coalesce into a single volume modification call to AWS. This must be lower than the csi-resizer and volumemodifier timeouts (default 2s)
      --reserved-volume-attachments int                         Number of volume attachments reserved for system use. Not used when --volume-attach-limit is specified. The total amount of volume attachments for a node is computed as: <nr. of attachments for corresponding instance type> - <number of NICs, if relevant to the instance type> - <reserved-volume-attachments value>. When -1, the amount of reserved attachments is loaded from instance metadata that captured state at node boot and may include not only system disks but also CSI volumes. (default -1)
      --user-agent-extra string                                 Extra string appended to user agent.
  -v, --v Level                                                 number for the log level verbosity
      --version                                                 Print the version and exit.
      --vmodule pattern=N,...                                   comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)
      --volume-attach-limit int                                 Value for the maximum number of volumes attachable per node. If specified, the limit applies to all nodes and overrides --reserved-volume-attachments. If not specified, the value is approximated from the instance type. (default -1)
      --warn-on-invalid-tag                                     To warn on invalid tags, instead of returning an error
      --windows-host-process                                    ALPHA: Indicates whether the driver is running in a Windows privileged container
Options (32)
OptionDescriptionSource
--aws-sdk-debug-logTo enable the aws sdk debug log level (default to false).help
--batchingTo enable batching of API calls.help
--csi-mount-point-prefix stringA prefix of the mountpoints of all CSI-managed volumes.help
--deprecated-metricsDEPRECATED: To enable deprecated metrics.help
--enable-node-local-volumesEnable support for node-local volumes that use pre-attached EBS volumes.help
--enable-otel-tracingTo enable opentelemetry tracing for the driver.help
--endpoint stringEndpoint for the CSI driver server (default "unix://tmp/csi.sock")help
--extra-tags mapStringStringExtra tags to attach to each dynamically provisioned resource.help
--extra-volume-tags mapStringStringDEPRECATED: Please use --extra-tags instead.help
--http-endpoint :8080The TCP network address where the HTTP server for metrics will listen (example: :8080).help
--k8s-tag-cluster-id stringID of the Kubernetes cluster used for tagging provisioned EBS volumes (optional).help
--kubeconfig stringAbsolute path to a kubeconfig file.help
--legacy-xfs bigtime=0Warning: This option will be removed in a future version of EBS CSI Driver.help
--log-flush-frequency durationMaximum number of seconds between log flushes (default 5s)help
--log-json-info-buffer-size quantity[Alpha] In JSON format with split output streams, the info messages can be buffered for a while to increase performance.help
--log-json-split-stream[Alpha] In JSON format, write error messages to stderr and info messages to stdout.help
--log-text-info-buffer-size quantity[Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance.help
--log-text-split-stream[Alpha] In text format, write error messages to stderr and info messages to stdout.help
--logging-format stringSets the log format.help
--logtostderrlog to standard error instead of files.help
--metadata-sources stringsDictates which sources are used to retrieve instance metadata.help
--metrics-cert-file stringThe path to a certificate to use for serving the metrics server over HTTPS.help
--metrics-key-file stringThe path to a key to use for serving the metrics server over HTTPS.help
--modify-volume-request-handler-timeout durationTimeout for the window in which volume modification calls must be received in order for them to coalesce into a single volume modification call to AWS.help
--reserved-volume-attachments intNumber of volume attachments reserved for system use.help
--user-agent-extra stringExtra string appended to user agent.help
-v, --v Levelnumber for the log level verbosityhelp
--versionPrint the version and exit.help
--vmodule pattern=Ncomma-separated list of pattern=N settings for file-filtered logging (only works for text log format)help
--volume-attach-limit intValue for the maximum number of volumes attachable per node.help
--warn-on-invalid-tagTo warn on invalid tags, instead of returning an errorhelp
--windows-host-processALPHA: Indicates whether the driver is running in a Windows privileged containerhelp

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