OS Manuals

/usr/lib/kafka/bin/kafka-streams-groups.sh

Community edition of Confluent Kafka.

From confluent-kafka 8.4.0.215-r1 (os), captured 2026-11-05 by running kafka-streams-groups.sh --help (exit 1). permalink

Also provided by 1 other package version
This tool helps to list, or describe streams groups.
Option                                  Description
------                                  -----------
--all-groups                            Apply to all streams groups.
--all-input-topics                      Consider all source topics used in the
                                          topology of the group. Supported
                                          operations: delete-offsets, reset-
                                          offsets.
--bootstrap-server <String: server to   REQUIRED: The server(s) to connect to.
  connect to>
--by-duration <String: duration>        Reset offsets to offset by duration
                                          from current timestamp. Format:
                                          'PnDTnHnMnS'
--command-config <String: command       Property file containing configs to be
  config property file>                   passed to Admin Client.
--delete                                Pass in groups to delete topic
                                          partition offsets and ownership
                                          information over the entire streams
                                          group. For instance --group g1 --
                                          group g2
--delete-all-internal-topics            Delete all internal topics linked to
                                          the streams group. Supported
                                          operations: reset-offsets, delete.
                                          With reset-offsets, this option is
                                          applicable only when --execute is
                                          used.
--delete-internal-topic <String>        Delete specified internal topic of the
                                          streams group. Supported operations:
                                          reset-offsets.This option is
                                          applicable only when --execute is
                                          used.
--delete-offsets                        Delete offsets of streams group.
                                          Supports one streams group at the
                                          time, and multiple topics.
--describe                              Describe streams group and list offset
                                          lag related to given group.
--dry-run                               Only show results without executing
                                          changes on streams group. Supported
                                          operations: reset-offsets.
--execute                               Execute operation. Supported
                                          operations: reset-offsets.
--export                                Export operation execution to a CSV
                                          file. Supported operations: reset-
                                          offsets.
--from-file <String: path to CSV file>  Reset offsets to values defined in CSV
                                          file.
--group <String: streams group>         The streams group we wish to act on.
--help                                  Print usage information.
--input-topic <String: topic>           The input topic whose committed offset
                                          should be deleted or reset. In
                                          `reset-offsets` case, partitions can
                                          be specified using this format:
                                          `topic1:0,1,2`, where 0,1,2 are the
                                          partition to be included in the
                                          process. Multiple input topics can
                                          be specified. Supported operations:
                                          delete-offsets, reset-offsets.
--list                                  List all streams groups.
--members                               Describe members of the group. This
                                          option may be used with the '--
                                          describe' option only.
--offsets                               Describe the group and list all topic
                                          partitions in the group along with
                                          their offset information.This is the
                                          default sub-action and may be used
                                          with the '--describe' option only.
--reset-offsets                         Reset offsets of streams group. The
                                          instances should be inactive.
                                        Has 2 execution options: --dry-run to
                                          plan which offsets to reset, and --
                                          execute to update the offsets.
                                        If you use --execute, all internal
                                          topics linked to the group will also
                                          be deleted.
                                        You must choose one of the following
                                          reset specifications: --to-datetime,
                                          --by-duration, --to-earliest, --to-
                                          latest, --shift-by, --from-file, --
                                          to-current, --to-offset.
                                        To define the scope use --all-input-
                                          topics or --input-topic. One scope
                                          must be specified unless you use '--
                                          from-file'.
                                        Fails if neither '--dry-run' nor '--
                                          execute' is specified.
--shift-by <Long: number-of-offsets>    Reset offsets shifting current offset
                                          by 'n', where 'n' can be positive or
                                          negative.
--state [String]                        When specified with '--list', it
                                          displays the state of all groups. It
                                          can also be used to list groups with
                                          specific states. Valid values are
                                          Empty, NotReady, Stable, Assigning,
                                          Reconciling, and Dead.
--timeout <Long: timeout (ms)>          The timeout that can be set for some
                                          use cases. For example, it can be
                                          used when describing the group to
                                          specify the maximum amount of time
                                          in milliseconds to wait before the
                                          group stabilizes. (default: 30000)
--to-current                            Reset offsets to current offset.
--to-datetime <String: datetime>        Reset offsets to offset from datetime.
                                          Format: 'YYYY-MM-DDThh:mm:ss.sss'
--to-earliest                           Reset offsets to earliest offset.
--to-latest                             Reset offsets to latest offset.
--to-offset <Long: offset>              Reset offsets to a specific offset.
--verbose                               Use with --describe --state  to show
                                          group epoch and target assignment
                                          epoch.
                                        Use with --describe --members to show
                                          for each member the member epoch,
                                          target assignment epoch, current
                                          assignment, target assignment, and
                                          whether member is still using the
                                          classic rebalance protocol.
                                        Use with --describe --offsets  and --
                                          describe  to show leader epochs for
                                          each partition.
--version                               Display Kafka version.
Options (31)
OptionDescriptionSource
--all-groupsApply to all streams groups.help
--all-input-topicsConsider all source topics used in the topology of the group.help
--bootstrap-server String:REQUIRED: The server(s) to connect to.help
--by-duration String:Reset offsets to offset by duration from current timestamp.help
--command-config String:Property file containing configs to be config property file> passed to Admin Client.help
--deletePass in groups to delete topic partition offsets and ownership information over the entire streams group.help
--delete-all-internal-topicsDelete all internal topics linked to the streams group.help
--delete-internal-topic StringDelete specified internal topic of the streams group.help
--delete-offsetsDelete offsets of streams group.help
--describeDescribe streams group and list offset lag related to given group.help
--dry-runOnly show results without executing changes on streams group.help
--executeExecute operation.help
--exportExport operation execution to a CSV file.help
--from-file String:Reset offsets to values defined in CSV file.help
--group String:The streams group we wish to act on.help
--helpPrint usage information.help
--input-topic String:The input topic whose committed offset should be deleted or reset.help
--listList all streams groups.help
--membersDescribe members of the group.help
--offsetsDescribe the group and list all topic partitions in the group along with their offset information.This is the default sub-action and may be used with the '--describe' option only.help
--reset-offsetsReset offsets of streams group.help
--shift-by Long:Reset offsets shifting current offset by 'n', where 'n' can be positive or negative.help
--state StringWhen specified with '--list', it displays the state of all groups.help
--timeout Long:The timeout that can be set for some use cases.help
--to-currentReset offsets to current offset.help
--to-datetime String:Reset offsets to offset from datetime.help
--to-earliestReset offsets to earliest offset.help
--to-latestReset offsets to latest offset.help
--to-offset Long:Reset offsets to a specific offset.help
--verboseUse with --describe --state to show group epoch and target assignment epoch.help
--versionDisplay Kafka version.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.