Contents

Kafka commands· 1

broker 1

format 2

kafka-service· 3

topic· 3

 

Kafka commands

broker

Use broker to bind a Kafka broker to a Kafka service instance.

Use undo broker to unbind a Kafka broker from a Kafka service instance.

Syntax

broker [ vpn-instance vpn-instance-name ] { host-name | ipv4-address | ipv6 ipv6-address } port port-number

undo broker [ vpn-instance vpn-instance-name ] { host-name | ipv4-address | ipv6 ipv6-address }

Default

No Kafka broker is bound to the Kafka service instance.

Views

Kafka service instance view

Predefined user roles

network-admin

Parameters

vpn-instance vpn-instance-name: Specifies an MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters. If the Kafka broker is on the public network, do not specify this option.

host-name: Specifies a Kafka broker by its name, a case-insensitive string of 1 to 253 characters.

ipv4-address: Specifies a Kafka broker by its IPv4 address.

ipv6 ipv6-address: Specifies a Kafka broker by its IPv6 address.

port udp-port: Specifies the port number of the Kafka broker, in the range of 1 to 65535. For the Kafka broker to successfully receive Kafka messages generated by the device, make sure the value of this option is the same as that configured on the Kafka broker.

Usage guidelines

Application scenarios

A Kafka server acts as the recipient and storer of Kafka messages published by the device. You can use this command to specify Kafka servers.

Operating mechanism

A Kafka cluster consists of one or more Kafka servers (also called Kafka brokers).

You can execute this command multiple times to specify multiple Kafka brokers. The devices, acting as Kafka message producers, publish produced messages with specific topics to Kafka brokers in the specified format.

The device supports sending Kafka messages such as:

·     Alarm and alarm clear messages for CPU usage threshold exceeding.

·     Alarm and alarm clear messages for free memory dropping below threshold.

·     Alarm and alarm clear messages for interface status changing from up to down.

·     Alarm and alarm clear messages for expiration of basic licenses.

·     Alarm and alarm clear messages for routing table entry threshold exceeding.

·     Alarm and alarm clear messages for ARP table entry threshold exceeding.

·     Alarm and alarm clear messages for BGP neighbor disconnections.

Examples

# Bind a Kafka broker with IP address 1.1.1.1 and port number 5145 to Kafka service instance suyan.

<Sysname> system-view

[Sysname] kafka-service suyan

[Sysname-kafka-service-suyan] broker 1.1.1.1 port 5145

Related commands

kafka-service

format

topic

format

Use format to specify the format for messages sent to Kafka brokers.

Use undo format to restore the default.

Syntax

format string

undo format

Default

No format is specified for messages sent to Kafka brokers.

Views

Kafka service instance view

Predefined user roles

network-admin

Parameters

string: Specifies a format. The value for this argument can only be suyan-cloud in the current software version.

Usage guidelines

Operating mechanism

With this command configured, the device acts as a Kafka message producer and sends generated messages to the target Kafka broker in the specified format.

Examples

# Specify the format for messages sent to Kafka brokers as suyan-cloud.

<Sysname> system-view

[Sysname] kafka-service suyan

[Sysname-kafka-service-suyan] format suyan-cloud

Related commands

kafka-service

broker

topic

kafka-service

Use kafka-service to create a Kafka service instance and enter its view, or enter the view of an existing Kafka service instance.

Use undo kafka-service to delete a Kafka service instance.

Syntax

kafka-service service-name

undo kafka-service service-name

Default

No Kafka service instance exists.

Views

System view

Predefined user roles

network-admin

Parameters

service-name: Specify a Kafka service instance by its name, a case-insensitive string of 1 to 15 characters. The name must start with a letter.

Usage guidelines

Operating mechanism

A Kafka service instance is used to manage and configure a Kafka service. In a Kafka service instance view, you can bind Kafka brokers (servers) and configure the topics and format for messages. After the configuration, the device acts as a Kafka message producer and sends generated messages with the specified topic to the target Kafka brokers in the specified format.

Restrictions and guidelines

You can execute this command multiple times to create multiple Kafka service instances for configuring different parameters and bind different Kafka brokers. In the current software version, only one Kafka service instance can be configured on the device.

Examples

# Create Kafka service instance suyan and enter its view.

<Sysname> system-view

[Sysname] kafka-service suyan

[Sysname-kafka-service-suyan]

Related commands

broker

format

topic

topic

Use topic to configure a Kafka topic.

Use undo topic to delete a Kafka topic.

Syntax

topic module topic-name

undo topic module

Default

No Kafka topic is configured.

Views

Kafka service instance view

Predefined user roles

network-admin

Parameters

module: Specifies a service module that supports sending Kafka messages. The value for this argument can only be alarm in the current software version.

topic-name: Specifies a topic used by the service module to send messages to Kafka brokers, a case-insensitive string of 1 to 249 characters. The name can contain letters, digits, hyphens (-), and underscores (_), and cannot be empty.

Usage guidelines

Application scenarios

Topics are an essential part of Kafka messages. You can use topics to classify the messages generated by the device as needed for management of the messages.

Operating mechanism

With this command configured, the device acts as a Kafka message producer, automatically adds the corresponding topics to the messages generated by the specified service modules, and then sends them to the Kafka brokers.

Restrictions and guidelines

If you execute this command multiple times for the same module, the most recent configuration takes effect. Only the alarm module is supported in the current software version.

Examples

# Configure the Kafka topic for the alarm module as suyan-alarm.

<Sysname> system-view

[Sysname] kafka-service suyan

[Sysname-kafka-service-suyan] topic alarm suyan-alarm

Related commands

kafka-service

broker

format