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>
  • 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>
  • 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 delete
Completed Updating config for entity: topic 'topic2'.

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

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

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

See Also

reset