apache kafka command reference tibco software release 1.0 ... · commands executed on this...

TIBCO® Messaging ManagerApache Kafka Command ReferenceSoftware Release 1.0September 2019

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDERSEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH,THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITHTIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES,AND INDEMNITIES. DOWNLOAD AND USE OF THESE ITEMS IS SOLELY AT YOUR OWNDISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDINGTO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THEFOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document is subject to U.S. and international copyright laws and treaties. No part of thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, the TIBCO logo, the TIBCO O logo, TIB, Information Bus, FTL, eFTL, Rendezvous, andLogLogic are either registered trademarks or trademarks of TIBCO Software Inc. in the United Statesand/or other countries.

Java and all Java based trademarks and logos are trademarks or registered trademarks of Oracle and/orits affiliates.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating systemplatforms for a specific software version are released at the same time. Please see the readme.txt file forthe availability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer toTIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

2

TIBCO® Messaging Manager Apache Kafka Command Reference

https://www.tibco.com/patents

Copyright © 2010–2019 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

3


Contents

About this Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

MSGMX Apache Kafka Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4


About this Product

TIBCO® is proud to announce the latest release of TIBCO Messaging Manager software.

This release is the latest in a long history of TIBCO products that leverage the power of InformationBus® technology to enable truly event-driven IT environments. To find out more about how TIBCOMessaging Manager software and other TIBCO products are powered by TIB® technology, please visitus at www.tibco.com.

TIBCO Messaging Manager software is part of TIBCO Messaging.

Product Overview

TIBCO Messaging Manager (MSGMX) provides an intelligent, predictive, and auto-completingcommand line interface for Apache Kafka Distribution. MSGMX runs in any standard command-linewindow or terminal emulator. It provides an intuitive, fast, auto-validating, and simple user interfacewhile still providing full command and option support.

5


HTTP://WWW.TIBCO.COM/

TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainlyin HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any otherdocumentation included with the product. To access the latest documentation, visit https://docs.tibco.com.

TIBCO Documentation

Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site. To access the documentation web page for this product from a localsoftware installation, open the following file:

TIBCO_HOME/msgmx/1.0/product_info/docinfo.txt

TIBCO_HOME is the top-level directory in which TIBCO products are installed.

● On Windows platforms, the default value of TIBCO_HOME is C:\tibco.● On UNIX and Mac platforms, the default value of TIBCO_HOME is /opt/tibco.

The following documents for this product can be found on the TIBCO Documentation site.

● TIBCO Messaging Manager User's Guide This manual provides installation and configurationprocedures plus an overview of general use and features.

● TIBCO Messaging Manager Release Notes Read the release notes for a list of new and changedfeatures. This document also contains lists of known issues and closed issues for this release.

● Command Reference manuals for the supported TIBCO messaging products.

Additional information resources may be available that include tutorials, readme files, and summarydocuments of commands for specific products supported.

Updated Resources on TIBCO Community

Supplemental resources are now distributed at the TIBCO Messaging Community Wiki in theReference Info tab. You can always find the latest versions of these resources in that location.

Those resources include quick start guides, tutorials, and usage examples.

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

● For an overview of TIBCO Support, visit http://www.tibco.com/services/support.● For accessing the Support Knowledge Base and getting personalized content about products you are

interested in, visit the TIBCO Support portal at https://support.tibco.com.● For creating a Support case, you must have a valid maintenance or support contract with TIBCO.

You also need a user name and password to log in to https://support.tibco.com. If you do not have auser name, you can request one by clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matterexperts to share and access their collective experience. TIBCO Community offers access to Q&A forums,product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, and

6


https://docs.tibco.com

https://docs.tibco.com

https://community.tibco.com/products/tibco-messaging

http://www.tibco.com/services/support

https://support.tibco.com

https://support.tibco.com

tools that extend and enable customers to gain full value from TIBCO products. In addition, users cansubmit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to https://community.tibco.com.

Product Page on TIBCO Community

You can access the TIBCO Messaging community product pages at


.

7


https://ideas.tibco.com/

https://community.tibco.com


MSGMX Apache Kafka Commands

TIBCO Messaging Manager provides a comprehensive and efficient command wrapper foradministering the Apache Kafka Distribution. The Apache Kafka commands supported by MSGMXhave an intuitive correlation with native Apache Kafka command combinations and tasks whileproviding a flexible and assistive interface that frees you from the arcane syntax and limitations ofusing the native Apache Kafka scripts.

All MSGMX Apache Kafka Distribution commands start with a verb that states the action to be taken—create, delete, list, etc. These verbs are listed in this manual in alphabetical order for easy reference.

Commands have options or flags that can be required or optional. (Options require an argument whileflags do not.) A required option or flag is a selection from a list of choices. Options or flags not requiredare shown in this document enclosed in "[ ]". Free text entry is designated as <FreeTextEntry>.

8


connect

Connect to an Apache ZooKeeper node or Apache Kafka Broker.

Use the connect command to associate your MSGMX session with one or more Apache ZooKeepernodes or Apache Kafka Brokers. To be able to do this, the target service must be running and anaccessible IP address must be supplied.

Synopsis

connect zookeeper <hostname | address:port>

connect bootstrap-server <hostname | address:port> [command-config <ConfigFilename>]

Required Arguments

server-type <hostname | address:port>connection destination

Optional Arguments

command-config <ConfigFilename>For a bootstrap-server connection, you can specify a credential file to provide the credentials for accessto a secure bootstrap-server. These configuration parameters are automatically applied to allcommands executed on this bootstrap-server, and are unset when disconnected from the bootstrap-server or by connecting to another bootstrap-server. If you reconnect to this server later, you must re-specify the credential file.

Examples

> connect zookeeper localhost:2181zookeeper@localhost:2181>

> connect bootstrap-server localhost:9092bootstrap-server@localhost:9092>

> connect bootstrap-server localhost:9093 command-config ../sample.plaintext.command-configbootstrap-server@localhost:9093>

> connect bootstrap-server localhost:9092 command-config ../sample.ssl.command-configbootstrap-server@localhost:9092>

Sample plain text configuration file:sasl.mechanism=PLAINrequest.timeout.ms=20000bootstrap.servers=localhost:9092retry.backoff.ms=500

sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required \ username="admin" \ password="admin-secret";

security.protocol=SASL_PLAINTEXT

Sample SSL configuration file:security.protocol=SSLssl.truststore.type=JKSssl.keystore.type=JKSssl.truststore.location=<client_trustore_location>ssl.truststore.password=test1234

9


See Also

disconnect

10


create

Create an object.

Use this command to create an object on the server to which you are connected. For Apache Kafka, youcan create topics, ACLs for topics, clusters, groups and delegation tokens.

Synopsis

create topic <String> partitions <Int> replication-factor <Int> [force | if-not-

exists | disable-rack-aware]

create topic <String> replica-assignment <String> [force | if-not-exists | disable-

rack-aware]

create topic-acl <String> allow-principal | deny-principal <PrincipalType:name>

[force | allow-host <String> | deny-host <String> | operation <String>]

create topic-acl <String> producer allow-principal <String> [force | allow-host

<String> | deny-host <String> | operation <String>]

create topic-acl <String> consumer allow-principal <String> [force | allow-host

<String> | cluster | transaction-id <String>]

create cluster-acl allow-principal | deny-principal <PrincipalType:name> [force |

allow-host <String> | deny-host <String> | operation <String>]

create group-acl <String> allow-principal | deny-principal <PrincipalType:name>


create delegation-token-acl <String> allow-principal | deny-principal

<PrincipalType:name> [force | allow-host <String> | deny-host <String> | operation

<String>]

Options

topic <String> partitions <Int> replication-factor <Int>topic with partitions and replication factor specified

topic <String> replica-assignment <String>topic specification

topic-acl <String> allow-principal | deny-principal <PrincipalType:name>topic ACL specification

topic-acl <String> producer allow-principal <String> [force | allow-host <String>topic ACL specification

cluster-acl allow-principal | deny-principal <PrincipalType:name>cluster ACL specification

group-acl <String> allow-principal | deny-principal <PrincipalType:name>group ACL specification

delegation-token-acl <String> allow-principal | deny-principal <PrincipalType:name>delegation token ACL specification

11


Optional Arguments

allow-host <String>ACL option

clusterACL producer option

deny-host <String>ACL option

disable-rack-awaretopic option

forcebypass yes/no prompts

group <String>ACL consumer option

if-not-existstopic-only option

operation <String>ACL option

transaction-id <String>ACL producer option

Examples

zookeeper@localhost:2181> create topic topic1 partitions 1 replication-factor 2

zookeeper@localhost:2181> create topic topic2 replica-assignment 0:2

zookeeper@localhost:2181> create topic-acl topic2 allow-principal type:Name

zookeeper@localhost:2181> create topic-acl topic1 producer allow-principal type:Name

zookeeper@localhost:2181> create topic-acl topic1 consumer allow-principal type:Name group 0

zookeeper@localhost:2181> create cluster-acl allow-principal type:Name

zookeeper@localhost:2181> create group-acl 0 allow-principal type:Name

zookeeper@localhost:2181> create delegation-token-acl aclName allow-principal

See Also

delete

12


delete

Delete an object.

Use this command to delete an object on the server to which you are connected.

Synopsis

delete topic <TopicName> [force | if-exists | topics-with-overrides | disable-rack-

aware]

delete topic-acl <String> allow-principal | deny-principal <PrincipalType:name>


delete topic-acl <String> producer allow-principal <PrincipalType:name> [force |

allow-host <String> | cluster | transaction-id <String>]

delete topic-acl <String> consumer allow-principal <PrincipalType:name> [group

<String> | force | allow-host <String>]

delete cluster-acl allow-principal | deny-principal <PrincipalType:name> [force |

allow-host <String> | deny-host <String> | operation <String>]

delete group-acl <String> allow-principal | deny-principal <PrincipalType:name>


delete delegation-token-acl <String> allow-principal | deny-principal

<PrincipalType:name> [force | allow-host <String> | deny-host <String> | operation

<String>]

Options

topic <TopicName>topic name

topic-acl <String> allow-principal | deny-principal <PrincipalType:name>topic ACL

topic-acl <String> producer allow-principal <PrincipalType:name>topic ACL producer

topic-acl <String> consumer allow-principal <PrincipalType:name>topic ACL consumer

cluster-acl allow-principal | deny-principal <PrincipalType:name>cluster ACL

group-acl <String> allow-principal | deny-principal <PrincipalType:name>group ACL

delegation-token-acl <String> allow-principal | deny-principal <PrincipalType:name>delegation token ACL

Optional Arguments


allow-host <String>ACL option

13


deny-host <String>ACL option





if-existstopic option

topics-with-overridestopic option


Examples

zookeeper@localhost:2181> delete topic topic1

zookeeper@localhost:2181> delete topic-acl topic1 consumer allow-principal type:Name group 0

zookeeper@localhost:2181> delete cluster-acl allow-principal type:Name

zookeeper@localhost:2181> delete group-acl 0 allow-principal type:Name

zookeeper@localhost:2181> delete delegation-token-acl aclName

See Also

create

14


disconnect

Disconnect MSGMX from a specific Apache ZooKeeper node or Apache Kafka Broker.

Use the disconnect command to disassociate your administrative session from an Apache ZooKeeper orApache Kafka Broker. If you have other connections active, MSGMX falls back to the most recentprevious connection (if any) and you see an updated prompt.

Synopsis

disconnect zookeeper <hostname | address:port>

disconnect bootstrap-server <hostname | address:port>

Options

zookeeper <hostname | address:port>disconnect from an Apache ZooKeeper

bootstrap-server <hostname | address:port>disconnect from an Apache Kafka Broker

Examples

zookeeper@localhost:2181> disconnect zookeeper localhost:2181>

bootstrap_server@localhost:9092> disconnect bootstrap-server localhost:9092>

See Also

connect

15


exit

Exit MSGMX.

An EOF (end of file - typically Ctrl+D when used interactively) will also cause MSGMX to exit.

Synopsis

exit

Options

None.

16


help

Display help information for any command.

Enter the help command or "?" to display information about a specific command.

Synopsis

help command-name

? command-name

? is an alias for help.

Required Options

Command name to provide help for.

Examples

>help create topic <Topic Name> Usage: create topic <Topic Name> partitions <Int> replication-factor <Int> create topic <Topic Name> replica-assignment <String>

Add a new topic by name.

The name of the topic must contain only alphanumeric, ".", "-", or "_" characters as part of the topic name.

>help set broker <Broker ID> Usage: set broker <Broker ID> log.message.timestamp.type <String> set broker <Broker ID> ssl.client.auth <String> set broker <Broker ID> log.retention.ms <Int> set broker <Broker ID> sasl.login.refresh.window.jitter <Double> set broker <Broker ID> sasl.kerberos.ticket.renew.window.factor <Double> set broker <Broker ID> log.preallocate <Boolean> set broker <Broker ID> log.index.size.max.bytes <Int> set broker <Broker ID> ssl.truststore.type <String> ...Content truncated...

17


list

Display a list of objects.

Use this command to display a list of specified objects from the server to which you are connected.

Synopsis

list connections | zookeepers | bootstrap-servers

list acls [force | principal <String> | cluster | transaction-id <String> |

operation <String>]

list topics [force | exclude-internal | disable-rack-aware]

Options

connectionsall connections to both ZooKeepers and bootstrap-servers

zookeepersconnections to ZooKeepers

bootstrap-serversconnections to bootstrap-servers

aclsall configured ACLs

topicsall configured topics

Optional Argumentss

forcebypass yes/no prompts; ACL or topic option

exclude-internaltopic option

principal <String>ACL option






18


Examples

zookeeper@localhost:2181> list topicstopic1topic2topic3topic6

zookeeper@localhost:2181> list aclsCurrent ACLs for resource `Topic:LITERAL:topic2`: type5:fortopic2 has Allow permission for operations: All from hosts: *

zookeeper@localhost:2181> list connectionslocalhost:2181 (zookeeper)

See Also

create, delete

19


reset

Use this command to reset a specific object's value back to its default on the server to which you areconnected.

Synopsis when connected to ZooKeeper

reset client <ClientName> consumer_byte_rate | producer_byte_rate |

request_percentage

reset user <UserName> consumer_byte_rate | SCRAM-SHA-512 | SCRAM-SHA-256 |

producer_byte_rate | request_percentage

reset topic <TopicName> <Topic Option>

Synopsis when connected to bootstrap-server

reset broker <BrokerID> <Broker Option>

Broker Options

For details on the following options, refer to the Apache Kafka documentation.

● advertised.listeners

● background.threads

● compression.type

● follower.replication.throttled.rate

● leader.replication.throttled.rate

● listener.security.protocol.map

● listeners

● log.cleaner.backoff.ms

● log.cleaner.dedupe.buffer.size

● log.cleaner.delete.retention.ms

● log.cleaner.io.buffer.load.factor

● log.cleaner.io.buffer.size

● log.cleaner.io.max.bytes.per.second

● log.cleaner.min.cleanable.ratio

● log.cleaner.min.compaction.lag.ms

● log.cleaner.threads

● log.cleanup.policy

● log.flush.interval.messages

● log.flush.interval.ms

● log.index.interval.bytes

● log.index.size.max.bytes

● log.message.downconversion.enable

● log.message.timestamp.difference.max.ms

20


● log.message.timestamp.type

● log.preallocate

● log.retention.bytes

● log.retention.ms

● log.roll.jitter.ms

● log.roll.ms

● log.segment.bytes

● log.segment.delete.delay.ms

● max.connections.per.ip

● max.connections.per.ip.overrides

● message.max.bytes

● metric.reporters

● min.insync.replicas

● num.io.threads

● num.network.threads

● num.recovery.threads.per.data.dir

● num.replica.fetchers

● principal.builder.class

● replica.alter.log.dirs.io.max.bytes.per.second

● sasl.enabled.mechanisms

● sasl.jaas.config

● sasl.kerberos.kinit.cmd

● sasl.kerberos.min.time.before.relogin

● sasl.kerberos.principal.to.local.rules

● sasl.kerberos.service.name

● sasl.kerberos.ticket.renew.jitter

● sasl.kerberos.ticket.renew.window.factor

● sasl.login.refresh.buffer.seconds

● sasl.login.refresh.min.period.seconds

● sasl.login.refresh.window.factor

● sasl.login.refresh.window.jitter

● sasl.mechanism.inter.broker.protocol

● ssl.cipher.suites

● ssl.client.auth

● ssl.enabled.protocols

● ssl.endpoint.identification.algorithm

● ssl.key.password

● ssl.keymanager.algorithm

● ssl.keystore.location

21


● ssl.keystore.password● ssl.keystore.type● ssl.protocol● ssl.provider● ssl.secure.random.implementation● ssl.trustmanager.algorithm● ssl.truststore.location● ssl.truststore.password● ssl.truststore.type● unclean.leader.election.enable

Topic Options

● cleanup.policy● compression.type● delete.retention.ms● file.delete.delay.ms● flush.messages● flush.ms● follower.replication.throttled.replicas● index.interval.bytes● leader.replication.throttled.replicas● max.message.bytes● message.downconversion.enable● message.format.version● message.timestamp.difference.max.ms● message.timestamp.type● min.cleanable.dirty.ratio● min.compaction.lag.ms● min.insync.replicas● preallocate● retention.bytes● retention.ms● segment.bytes● segment.index.bytes● segment.jitter.ms● segment.ms● unclean.leader.election.enable

Examples

zookeeper@localhost:2181> reset topic topic2 cleanup.policy

22


zookeeper@localhost:2181> reset user User:* request_percentage

zookeeper@localhost:2181> reset client 0 consumer_byte_rate

zookeeper@localhost:2181> reset broker 0 log.message.timestamp.type

See Also

set

23


set

Use this command to set an object's configuration value on the server to which you are connected.

Synopsis when connected to ZooKeeper

set client <ClientName> consumer_byte_rate | producer_byte_rate | request_percentage

set user <UserName> consumer_byte_rate | SCRAM-SHA-512 | SCRAM-SHA-256 |

producer_byte_rate | request_percentage

set topic <TopicName> <Topic Option>

Synopsis when connected to bootstrap-server

set broker <BrokerID> <Broker Option>

Broker Options

For details on the following options, refer to the Apache Kafka documentation.

● advertised.listeners <String>

● background.threads <Int>

● compression.type <Value>

● follower.replication.throttled.rate <Int>

● leader.replication.throttled.rate <Int>

● listener.security.protocol.map <String>

● listeners <String>

● log.cleaner.backoff.ms <Int>

● log.cleaner.dedupe.buffer.size <Int>

● log.cleaner.delete.retention.ms <Int>

● log.cleaner.io.buffer.load.factor <Double>

● log.cleaner.io.buffer.size <Int>

● log.cleaner.io.max.bytes.per.second <Double>

● log.cleaner.min.cleanable.ratio <Double>

● log.cleaner.min.compaction.lag.ms <Int>

● log.cleaner.threads <Int>

● log.cleanup.policy <String>

● log.flush.interval.messages <Int>

● log.flush.interval.ms <Int>

● log.index.interval.bytes <Int>

● log.index.size.max.bytes <Int>

● log.message.downconversion.enable <Boolean>

● log.message.timestamp.type <String>

● log.preallocate <Boolean>

● log.retention.bytes <Int>

24


● log.retention.ms <Int>

● log.roll.jitter.ms <Int>

● log.roll.ms <Int>

● log.segment.bytes <Int>

● log.segment.delete.delay.ms <Int>

● max.connections.per.ip <Int>

● max.connections.per.ip.overrides <String>

● message.max.bytes <Int>

● message.timestamp.difference.max.ms <Int>

● metric.reporters <String>

● min.insync.replicas <Int>

● num.io.threads <Int>

● num.network.threads <Int>

● num.recovery.threads.per.data.dir <Int>

● num.replica.fetchers <Int>

● principal.builder.class <String>

● replica.alter.log.dirs.io.max.bytes.per.second <Int>

● sasl.enabled.mechanisms <String>

● sasl.jaas.config <String>

● sasl.kerberos.kinit.cmd <String>

● sasl.kerberos.min.time.before.relogin <Int>

● sasl.kerberos.principal.to.local.rules <String>

● sasl.kerberos.service.name <String>

● sasl.kerberos.ticket.renew.jitter <String>

● sasl.kerberos.ticket.renew.window.factor <Double>

● sasl.login.refresh.buffer.seconds <Int>

● sasl.login.refresh.min.period.seconds <Int>

● sasl.login.refresh.window.jitter <Double>

● sasl.mechanism.inter.broker.protocol <String>

● ssl.cipher.suites <String>

● ssl.client.auth <String>

● ssl.enabled.protocols <String>

● ssl.endpoint.identification.algorithm <String>

● ssl.key.password <String>

● ssl.keymanager.algorithm <String>

● ssl.keystore.location <String>

● ssl.keystore.password <String>

● ssl.keystore.type <String>

● ssl.protocol <String>

25


● ssl.provider <String>● ssl.secure.random.implementation <String>● ssl.trustmanager.algorithm <String>● ssl.truststore.location <String>● ssl.truststore.password <String>● ssl.truststore.type <String>● unclean.leader.election.enable <Boolean>

Topic Options

● cleanup.policy <Value>● compression.type <Value>● delete.retention.ms <Int>● file.delete.delay.ms <Int>● flush.messages <Int>● flush.ms <Int>● follower.replication.throttled.replicas <Replicas>● index.interval.bytes <Int>● leader.replication.throttled.replicas <Replica List>● max.message.bytes <Int>● message.downconversion.enable <Boolean>● message.format.version <Version>● message.timestamp.difference.max.ms <Int>● message.timestamp.type <String>● min.cleanable.dirty.ratio <Double>● min.compaction.lag.ms <Int>● min.insync.replicas <Int>● partitions <Int>● preallocate <Boolean>● replica-assignment <String>● retention.bytes <Int>● retention.ms <Int>● segment.bytes <Int>● segment.index.bytes <Int>● segment.ms <Int>● unclean.leader.election.enable <Boolean>

Examples

zookeeper@localhost:2181> set topic topic2 cleanup.policy deleteCompleted Updating config for entity: topic 'topic2'.

zookeeper@localhost:2181> set user tibcoUser:* request_percentage 10Completed Updating config for entity: user-principal 'tibcoUser'.

26


zookeeper@localhost:2181> set client 0 consumer_byte_rate 10000Completed Updating config for entity: client-id '0'.

zookeeper@localhost:2181> set broker 0 log.message.timestamp.type CreateTimeCompleted updating config for broker: 0.

See Also

reset

27


show

Use this command to display an object's configuration values on the server to which you are connected.

Synopsis (zookeeper or bootstrap-server)

show broker <Name> [force]

show topic <TopicName> [exclude-internal | force | if-exists | topics-with-overrides

| unavailable-partitions | under-replicated-partitions | disable-rack-aware]

show all-topics [exclude-internal | force | topics-with-overrides | unavailable-

partitions | under-replicated-partitions | disable-rack-aware]

Synopsis (zookeeper only)

show client | user <Name> [force]

Options

broker <Name>broker name

client <Name>client name

user <Name>user name

topic <TopicName>topic name

all-topicsall topics

exclude-internaltopics option


if-existstopic option

topics-with-overridestopics option

unavailable-partitionstopics option

under-replicated-partitionstopics option


Examples (zookeeper or bootstrap-server)

zookeeper@localhost:2181> show all-topics Topic:topic1 PartitionCount:1 ReplicationFactor:1 Configs:

28


Topic: topic1 Partition: 0 Leader: 0 Replicas: 0 Isr: 0Topic:topic2 PartitionCount:1 ReplicationFactor:1 Configs: Topic: topic2 Partition: 0 Leader: 0 Replicas: 0 Isr: 0Topic:topic3 PartitionCount:1 ReplicationFactor:1 Configs: Topic: topic3 Partition: 0 Leader: 0 Replicas: 0 Isr: 0Topic:topic6 PartitionCount:1 ReplicationFactor:1 Configs: Topic: topic6 Partition: 0 Leader: 0 Replicas: 0 Isr: 0Topic:topicname PartitionCount:1 ReplicationFactor:1 Configs: Topic: topicname Partition: 0 Leader: 0 Replicas: 0 Isr: 0

zookeeper@localhost:2181> show topic topic2 Topic:topic2 PartitionCount:1 ReplicationFactor:1 Configs: Topic: topic2 Partition: 0 Leader: 0 Replicas: 0 Isr: 0

zookeeper@localhost:2181> show broker 0Configs for brokers '0' are log.message.timestamp.type=CreateTime

Examples (zookeeper only)

zookeeper@localhost:2181> show client 0Configs for client-id '0' are request_percentage=50

zookeeper@localhost:2181> show user tibcoUserConfigs for user-principal 'tibcoUser' are request_percentage=99

29


apache kafka command reference tibco software release 1.0 ... · commands executed on this...

Documents