Streaming

rpk cluster config list

List cluster configuration properties.

This command lists all available cluster configuration properties. Use the get command to retrieve specific property values, or edit for interactive editing.

Use the --filter flag with a regular expression to filter configuration keys.

By default the request is routed to any broker. Use --node-id to route it to a specific broker, which is useful when you suspect a broker is out of sync with the controller. --node-id is not supported for cloud clusters.

Use rpk cluster config edit for interactive editing.

Usage

rpk cluster config list [flags]

Examples

This section provides examples of how to use rpk cluster config list.

Filtering with regex

List properties matching a pattern

rpk cluster config list --filter="kafka.*"

Filter properties containing 'log'

rpk cluster config list --filter=".*log.*"

Output formats

List in JSON format

rpk cluster config list --format=json

List in YAML format

rpk cluster config list --format=yaml

Flags

Value Type Description

--filter

string

Filter configuration keys using regular expression.

--format

string

Output format (json,yaml,text,wide,help).

--node-id

int

If set, route the cluster configuration request to the given broker instead of any broker. (New in v26.2.1)

Global flags

Value Type Description

--config

string

Redpanda or rpk config file; default search paths are ~/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

--ignore-profile

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

--profile

string

rpk profile to use.

-v, --verbose

bool

Enable verbose logging.

Suggested reading