Skip to main content
Version: 23.1

rpk cluster config set

Set a single cluster configuration property.

This command is provided for use in scripts. For interactive editing, or bulk changes, use the edit and import commands respectively.

If an empty string is given as the value, the property is reset to its default.

Usage

rpk cluster config set <key> <value> [flags]

Flags

ValueTypeDescription
-h, --help-Help for set.
--admin-api-tls-certstringThe certificate to be used for TLS authentication with the Admin API.
--admin-api-tls-enabled-Enable TLS for the Admin API (not necessary if specifying custom certs).
--admin-api-tls-keystringThe certificate key to be used for TLS authentication with the Admin API.
--admin-api-tls-truststorestringThe truststore to be used for TLS communication with the Admin API.
--all-Include all properties, including tunables.
--api-urlsstring Comma-separated list of admin API addresses (<ip>:<port>
--brokersstringsComma-separated list of broker <ip>:<port> pairs (for example,--brokers `192.168.78.34:9092,192.168.78.35:9092,192.179.23.54:9092`). Alternatively, you may set the REDPANDA_BROKERSenvironment variable with the comma-separated list of broker addresses.
--configstringRedpanda config file, if not set the file will be searched for in the default locations.
--passwordstringSASL password to be used for authentication.
--sasl-mechanismstringThe authentication mechanism to use. Supported values: SCRAM-SHA-256, SCRAM-SHA-512.
--tls-certstringThe certificate to be used for TLS authentication with the broker.
--tls-enabled-Enable TLS for the Kafka API (not necessary if specifying custom certs).
--tls-keystringThe certificate key to be used for TLS authentication with the broker.
--tls-truststorestringThe truststore to be used for TLS communication with the broker.
--userstringSASL user to be used for authentication.
-v, --verbose-Enable verbose logging (default false).

What do you like about this doc?




Optional: Share your email address if we can contact you about your feedback.

Let us know what we do well: