Data Sync Server Documentation Index
Configuration Reference Home

Kafka Cluster External Server

Maintains information required to access a Kafka cluster, including server addresses, ports, and optional SSL information.

Parent Component
Relations from This Component
Relations to This Component
Properties
dsconfig Usage

Parent Component

The Kafka Cluster External Server component inherits from the External Server

Relations from This Component

The following components have a direct aggregation relation from Kafka Cluster External Servers:

Relations to This Component

The following components have a direct aggregation relation to Kafka Cluster External Servers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ bootstrap-server
↓ producer-property
↓ use-ssl
↓ trust-manager-provider
↓ key-manager-provider

Basic Properties

description

Description
A description for this External Server
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

bootstrap-server

Description
List of Kafka brokers to use for this Kafka Cluster External Server, following the host:port format.
Default Value
None
Allowed Values
A host:port pair where the host can be a host name, an IPv4 address, or an IPv6 address.

Example values
Value Synopsis
kafka.example.com:9092 Kafka broker on host kafka.example.com at port 9092.

Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action

producer-property

Description
Specifies extra properties to use when constructing the KafkaProducer for sending messages. Specify any number of properties that will be passed to the Kafka producer. Valid properties can be found in Kafka documentation, and invalid properties will be ignored without warning.
Default Value
None
Allowed Values
Key, composed of alphanumeric characters, dots, or underscores, followed by = and then the value.

Example values
Value Synopsis
linger.ms=5 The property linger.ms will be set to 5.

Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

use-ssl

Description
If enabled, the Kafka Cluster External Server will use SSL to encrypt communication with the Kafka brokers.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

trust-manager-provider

Description
Specifies the file-based trust manager that should be used with the Kafka Cluster External Server for connecting to the Kafka cluster over SSL.
Default Value
None
Allowed Values
The DN of any File Based Trust Manager Provider.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

key-manager-provider

Description
Specifies the file-based key manager that should be used with the Kafka Cluster External Server for connecting to the Kafka cluster over SSL.
Default Value
None
Allowed Values
The DN of any File Based Key Manager Provider.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured External Servers:

dsconfig list-external-servers
     [--property {propertyName}] ...

To view the configuration for an existing External Server:

dsconfig get-external-server-prop
     --server-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing External Server:

dsconfig set-external-server-prop
     --server-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Kafka Cluster External Server:

dsconfig create-external-server
     --server-name {name}
     --type kafka-cluster
     --set bootstrap-server:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing External Server:

dsconfig delete-external-server
     --server-name {name}