---
title: "kafkabroker modify"
slug: "kafkabroker-modify"
updated: 2026-10-27T17:24:38Z
published: 2026-10-27T17:24:38Z
canonical: "docs.vastdata.com/kafkabroker-modify"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vastdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# kafkabroker modify

This command modifies a Kafka [event broker configuration](/docs-5-3/docs/en/publishing-events-to-third-party-event-brokers) on the VAST cluster.

## Usage

```plaintext
kafkabroker modify --id ID
                   [--name NAME]
                   [--addresses ADDRESSES]
                   [--tenant-ID TENANT_ID]
                   [--serve-all-tenants]
```

## Required Parameters

| `--id ID` | The ID of the Kafka broker configuration that you want to change. |
| --- | --- |

## Options

| `--addresses ADDRESSES` | Kafka broker connection details. Specify `ADDRESSES` as a comma-separated list of `<host>:<port>` pairs, where: - `<host>` is an IP address of FQDN of the Kafka broker server. - `<port>` is the port number. You can specify up to five `<host>:<port>` pairs. For example: `192.168.1.1:9092,192.168.1.2:9092` > [!TIP] > Tip > > Ensure that the hosts are accessible from the VAST cluster's management interface at the specified ports. |
| --- | --- |
| `--tenant-id TENANT_ID` | Add this option if you want to restrict use of this Kafka broker to a particular tenant. |
| `--serve-all-tenants` | Lifts any existing tenant restrictions so that the Kafka broker can be used for all tenants. |

## Example

To make Kafka broker 2 available for tenant 5 only:

```plaintext
vcli: admin> kafkabroker modify --id 2 --tenant-id 5
```