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.

You can specify filters in terms of entities. An entity consists of either a client ID or a client ID prefix.

Usage

rpk cluster quotas describe [flags]
bash

Flags

Value Type Description

--any

strings

Type for any matching (names or default), where type is client-id or client-id-prefix (repeatable).

--default

strings

Type for default matching, where type is client-id or client-id-prefix (repeatable).

--format

string

Output format. Possible values: json, yaml, text, wide, help. Default: text.

-h, --help

-

Help for describe.

--name

strings

The type=name pair for exact name matching, where type is client-id or client-id-prefix (repeatable).

--strict

-

Specifies whether matches are strict. If true, entities with unspecified entity types are excluded.

--config

string

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

-X, --config-opt

stringArray

Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.

Examples

Describe all client quotas:

rpk cluster quotas describe
bash

Describe all client quota with client ID <foo>:

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

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

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