category: Messaging and Conferencing
provider: Open Source
commonfields:
  id: Kafka V2
  version: -1
configuration:
- display: CSV list of Kafka brokers to connect to, e.g. 172.16.20.207:9092,172.16.20.234:9093
  name: brokers
  required: true
  type: 0
- display: Use TLS for connection
  name: use_ssl
  type: 8
  required: false
- display: CA certificate of Kafka server (.cer)
  name: ca_cert
  type: 12
  required: false
- display: Client certificate (.cer)
  name: client_cert
  type: 12
  required: false
- display: Client certificate key (.key)
  name: client_cert_key
  type: 12
  required: false
- display: Client certificate key password (if required)
  name: additional_password
  type: 4
  required: false
- display: Topic to fetch incidents from (Required for fetch incidents)
  name: topic
  type: 0
  required: false
- display: CSV list of partitions to fetch messages from
  name: partition
  type: 0
  required: false
- additionalinfo: The initial offset to start fetching from, not including the value set (e.g. if 3 is set, the first event that will be fetched will be with offset 4).
  display: Offset to fetch messages from (Exclusive)
  name: offset
  type: 0
  required: false
- defaultvalue: '50'
  display: Max number of messages to fetch
  name: max_messages
  type: 0
  required: false
- display: Fetch incidents
  name: isFetch
  type: 8
  required: false
- display: Incident type
  name: incidentType
  type: 13
  required: false
- additionalinfo: |-
    The max number of message bytes to retrieve in each attempted fetch request. Should be in multiples of 1024. If the fetching process is taking a long time, you should consider increasing this value. Default is '1048576'.
  defaultvalue: '1048576'
  display: Max number of bytes per message
  name: max_bytes_per_message
  type: 0
  required: false
description: 'Deprecated. Use the Kafka v3 integration instead. The Open source distributed streaming platform.'
display: Kafka v2 (Deprecated)
deprecated: true
name: Kafka V2
script:
  commands:
  - arguments:
    - auto: PREDEFINED
      defaultValue: 'true'
      description: Whether to fetch topics available offsets or not.
      name: include_offsets
      predefined:
      - 'true'
      - 'false'
    description: Prints all partitions of a topic.
    name: kafka-print-topics
    outputs:
    - contextPath: Kafka.Topic.Name
      description: Kafka topic name
      type: String
    - contextPath: Kafka.Topic.Partitions.ID
      description: Topic partition ID
      type: Number
    - contextPath: Kafka.Topic.Partitions.EarliestOffset
      description: Topic partition earliest offset
      type: Number
    - contextPath: Kafka.Topic.Partitions.LatestOffset
      description: Topic partition latest offset
      type: Number
  - arguments:
    - description: A topic to filter messages by
      name: topic
      required: true
    - description: Message value (string)
      name: value
      required: true
    - description: Message partition key (number)
      name: partitioning_key
    description: Publishes a message to Kafka.
    name: kafka-publish-msg
  - arguments:
    - description: A topic to filter by
      name: topic
      required: true
    - defaultValue: Earliest
      description: Message offset to filter by. Acceptable values are 'Earliest', 'Latest', or any other offest number.
      name: offset
    - description: Partition (number)
      name: partition
    description: Consumes a single Kafka message.
    name: kafka-consume-msg
    outputs:
    - contextPath: Kafka.Topic.Name
      description: Name of the topic.
      type: string
    - contextPath: Kafka.Topic.Message.Value
      description: Value of the message.
      type: string
    - contextPath: Kafka.Topic.Message.Offset
      description: Offset of the value in the topic.
      type: number
  - arguments:
    - description: A topic to filter by
      name: topic
    description: Fetch partitions for a topic.
    name: kafka-fetch-partitions
    outputs:
    - contextPath: Kafka.Topic.Name
      description: Name of topic.
      type: string
    - contextPath: Kafka.Topic.Partition
      description: Prints all partitions for a topic.
      type: number
  dockerimage: demisto/pykafka:1.0.0.19034
  isfetch: true
  runonce: false
  script: '-'
  subtype: python2
  type: python
tests:
- No Test - Can not connect to instance from remote
fromversion: 5.0.0