Streaming

rpk shadow status

Get the status of a Redpanda Shadow Link.

This command shows the current status of a Shadow Link, including the overall state, task statuses, and per-topic replication progress. Use this command to monitor replication health and track how closely shadow topics follow the source cluster.

By default, the command displays all status sections. Use the flags to display specific sections such as overview, task status, or topic status. When using this command with the --format json/yaml flag, we default to all sections.

Usage

rpk shadow status <link_name> [flags]

Examples

This section provides examples of how to use rpk shadow status.

Display the status of a shadow link.

rpk shadow status my-shadow-link

Display specific sections.

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

Flags

Value Type Description

--format

string

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

-a, --print-all

bool

Print all sections.

-o, --print-overview

bool

Print the overview section.

-y, --print-registry

bool

Print the schema registry sync status section. (New in v26.2.1)

-k, --print-task

bool

Print the task status section.

-t, --print-topic

bool

Print the detailed topic status section.

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.