Streaming

rpk cluster quotas describe

Describe client quotas.

This command describes client quotas that match the provided filtering criteria. Running the command without filters returns all client quotas. Use the --strict flag for strict matching, which means that the only quotas returned exactly match the filters.

Filters can be provided in terms of entities. An entity consists of either a client ID or a client ID prefix.

Usage

rpk cluster quotas describe [flags]

Examples

This section provides examples of how to use rpk cluster quotas describe.

Describe all client quotas.

rpk cluster quotas describe

Describe all client quota with client ID <foo>.

rpk cluster quotas describe --name client-id=<foo>

Describe client quotas for a given client ID prefix <bar>..

rpk cluster quotas describe --name client-id=<bar>.

Flags

Value Type Description

--any

stringSlice

Entity type for any matching (names or default). Valid type values: client-id or client-id-prefix. Repeatable.

--default

stringSlice

Entity type for default matching. Valid type values: client-id or client-id-prefix. Repeatable.

--name

stringSlice

Entity type and name pair for exact name matching. Valid type values: client-id or client-id-prefix. Repeatable.

--strict

bool

Use strict matching: exclude entities with unspecified entity types.

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.