A Kafka Sync Destination defines the Sync Pipe destination as a topic within a Kafka cluster.
The Kafka Sync Destination component inherits from the Sync Destination
The following components have a direct aggregation relation from Kafka Sync Destinations:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| topic | |
| cluster | |
| message-key-attribute | |
| plugin |
| Description | A description for this Sync Destination |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Name of topic in the Kafka cluster that changes should be written to. The Kafka producer will use this topic with the partition key to determine where to send changes. If the topic does not exist, the cluster configuration controls the behavior. No error will be thrown if the topic doesn't exist, unless the cluster specifically denies topic creation through a producer. |
| Default Value | None |
| Allowed Values | Kafka restricts topic names to alphanumeric characters, period, underscore, or minus, and a length of 249. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Defines the Kafka service (or cluster if you change the config object) where messages will be published. |
| Default Value | None |
| Allowed Values | The DN of any Kafka Cluster External Server. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Candidate list of attributes to use as the message partition key. Each attribute should uniquely identify the entry. The Kafka Sync Destination will find the first attribute from the entry that is defined and nonempty. This value of that attribute will be used as the producer's partition key. If no candidate exists, is defined, and is nonempty, the producer will default to the entry DN. |
| Default Value | The DN of the entry will be used as the message key. |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies sync destination plugins that should be applied to operations that are synchronized by this Kafka Sync Destination. If multiple plugins are provided, then they will be invoked in the order they are specified. |
| Default Value | None |
| Allowed Values | The DN of any Kafka Sync Destination Plugin. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Sync Destinations:
dsconfig list-sync-destinations
[--property {propertyName}] ...
To view the configuration for an existing Sync Destination:
dsconfig get-sync-destination-prop
--destination-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Sync Destination:
dsconfig set-sync-destination-prop
--destination-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Kafka Sync Destination:
dsconfig create-sync-destination
--destination-name {name}
--type kafka
--set topic:{propertyValue}
--set cluster:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Sync Destination:
dsconfig delete-sync-destination
--destination-name {name}