Cloud

rpk shadow describe

Describes a Redpanda shadow link.

This command shows the shadow link configuration, including connection settings, synchronization options, and filters. Use the flags to display specific sections or all sections of the configuration.

By default, the command displays the overview and client configuration sections. Use the flags to display additional sections such as topic synchronization, consumer offset synchronization, and security synchronization settings.

The command uses the Redpanda ID of the cluster you are currently logged into. To use a different cluster, either log in and create a profile for it, or use the --redpanda-id flag to specify it directly.

Usage

rpk shadow describe [LINK_NAME] [flags]

Examples

Describe a shadow link with default sections (overview and client):

rpk shadow describe my-shadow-link

Display all configuration sections:

rpk shadow describe my-shadow-link --print-all

Display specific sections:

rpk shadow describe my-shadow-link --print-overview --print-topic

Display only the client configuration:

rpk shadow describe my-shadow-link -c

Flags

Value Type Description

-a, --print-all

-

Print all sections.

-c, --print-client

-

Print the client configuration section.

-r, --print-consumer

-

Print the detailed consumer offset configuration section.

-o, --print-overview

-

Print the overview section.

-s, --print-security

-

Print the detailed security configuration section.

-t, --print-topic

-

Print the detailed topic configuration section.

-h, --help

-

Help for describe.

--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.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.