24.1 23.3 23.2

rpk security role describe

Describe a Redpanda role.

This command describes a role, including the ACLs associated to the role, and lists members who are assigned the role.

Examples

Describe the role red (print members and ACLs):

rpk security role describe red

Print only the members of role red:

rpk security role describe red --print-members

Print only the ACL associated to the role red:

rpk security role describe red --print-permissions

Usage

rpk security role describe [ROLE] [flags]

Aliases

describe, info

Flags

Value Type Description

-h, --help

-

Help for describe.

-a, --print-all

-

Print all sections.

-m, --print-members

-

Print the members section.

-p, --print-permissions

-

Print the role permissions section.

--config

string

Redpanda or rpk config file; default search paths are /var/lib/redpanda/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, 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.

--format

string

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

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.