.. _event_notification_kafka_server:

event-notification kafka server
===============================

Set remote kafka server ip address


server Specification
--------------------

	===================================== ========================================================================
	===================================== ========================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      server

	 **Element URI**                       /axapi/v3/event-notification/kafka/server

	 **Element Attributes**                server_attributes

	 **Statistics Data URI**               /axapi/v3/event-notification/kafka/server/stats

	 **Operational Data URI**              /axapi/v3/event-notification/kafka/server/oper

	 **Schema**                             :download:`server schema <event-notification-kafka-server/event-notification-kafka-server.txt>`
	===================================== ========================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/event-notification/kafka/server



.. raw:: html

   </td><td valign = 'top'>


:ref:`1213_server_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/event-notification/kafka/server



.. raw:: html

   </td><td valign = 'top'>


:ref:`1213_server_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/event-notification/kafka/server



.. raw:: html

   </td><td valign = 'top'>


:ref:`1213_server_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/event-notification/kafka/server



.. raw:: html

   </td><td valign = 'top'>


:ref:`1213_server_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/event-notification/kafka/server



.. raw:: html

   </td><td valign = 'top'>


:ref:`1213_server_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _1213_server_attributes:

server attributes
-----------------

    **host-ipv4**

        **Description** Set kafka Broker ip address or hostname

        **Type:** string

        **Format:** host

    **port**

        **Description** Set remote kafka port number (Remote kafka port number 1-32767, default is 9092)

        **Type:** number

        **Range:** 1-32767

        **Default:** 9092

    **use-mgmt-port**

        **Description** Use management port for connections

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1213_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - rule-set-application-metrics-topic
      - 8
      - AppFW metrics sent

   *  - 
      - visibility-topn-harmony-topic-dequeue-err
      - 8
      - Visibility TopN metrics dropped,enq error analytics qs

   *  - 
      - cgn-summary-error-acos-harmony-topic
      - 8
      - CGN PE logs sent

   *  - 
      - cgn-pe-acos-harmony-topic
      - 8
      - CGN PE logs sent

   *  - 
      - pr-out-latency-anomaly
      - 8
      - L7 PR out latency negative

   *  - 
      - cgn-pc-acos-harmony-topic-dequeue-err
      - 8
      - CGN PC logs dropped,enq error analytics queues

   *  - 
      - waf-events-topic-dequeue-err
      - 8
      - WAF events metrics dropped,enq error analytics qs

   *  - 
      - pr-in-latency-threshold-exceed
      - 8
      - L7 PR on latency threshold exceeded

   *  - 
      - avro-generic-failed-sending
      - 8
      - Generic Metrics dropped,sending failure

   *  - 
      - slb-ssl-stats-metrics-topic
      - 8
      - SSL metrics sent

   *  - 
      - visibility-topn-harmony-topic
      - 8
      - Visibility TopN sent

   *  - 
      - pc-encoding-failed
      - 8
      - L4 PC logs dropped,encoding error

   *  - 
      - kafka-topic-error
      - 8
      - Module not supported by analytics

   *  - 
      - waf-events-topic
      - 8
      - WAF events topic counter

   *  - 
      - avro-device-status-topic-dequeue-err
      - 8
      - Device Status dropped,enq error analytics queues

   *  - 
      - slb-client-ssl-counters-metrics-topic-dequeue-err
      - 8
      - Cilent SSL metrics dropped,enq error analytics qs

   *  - 
      - pr-acos-harmony-topic
      - 8
      - L7 PR logs sent

   *  - 
      - waf-learn-pr-topic
      - 8
      - WAF learn topic counter

   *  - 
      - fw-rst-pc-acos-harmony-topic
      - 8
      - FW RST PC logs sent

   *  - 
      - pr-out-latency-threshold-exceed
      - 8
      - L7 PR out latency threshold exceeded

   *  - 
      - pc-acos-harmony-topic
      - 8
      - L4 PC logs sent

   *  - 
      - pr-in-latency-anomaly
      - 8
      - L7 PR on latency negative

   *  - 
      - pr-acos-harmony-topic-enqueue-err
      - 8
      - L7 PR dropped,enq error on acos queues

   *  - 
      - kafka-broker-down
      - 8
      - Messages dropped,analytics down

   *  - 
      - fw-pc-acos-harmony-topic-dequeue-err
      - 8
      - FW PC logs dropped,enq error analytics queues

   *  - 
      - cgn-summary-error-acos-harmony-topic-dequeue-err
      - 8
      - CGN PE logs dropped,enq error analytics queues

   *  - 
      - avro-device-status-topic-enqueue-err
      - 8
      - Device Status dropped,enq error on acos queues

   *  - 
      - kafka-queue-full-err
      - 8
      - Messages dropped,acos analytics queue full

   *  - 
      - ssli-pc-acos-harmony-topic
      - 8
      - SSLi PC topic counter from acos to harmony

   *  - 
      - ssli-pe-acos-harmony-topic
      - 8
      - SSLi PE topic counter from acos to harmony

   *  - 
      - pr-throttle-drop
      - 8
      - L7 PR dropped,log throttling

   *  - 
      - avro-partition-metrics-topic
      - 8
      - Partition Metrics sent

   *  - 
      - avro-partition-metrics-topic-enqueue-err
      - 8
      - Part metrics dropped,enq error on acos queues

   *  - 
      - fw-deny-pc-acos-harmony-topic
      - 8
      - FW DENY PC logs sent

   *  - 
      - pc-acos-harmony-topic-dequeue-err
      - 8
      - L4 PC logs dropped,enq error analytics queues

   *  - 
      - pr-acos-harmony-topic-dequeue-err
      - 8
      - L7 PR dropped,enq error analytics queues

   *  - 
      - rule-set-application-metrics-topic-dequeue-err
      - 8
      - AppFW metrics dropped,enq error analytics queues

   *  - 
      - slb-ssl-stats-metrics-topic-dequeue-err
      - 8
      - SSL metrics dropped,enq error analytics queues

   *  - 
      - avro-generic-sent
      - 8
      - Generic Metrics sent

   *  - 
      - slb-server-ssl-counters-metrics-topic
      - 8
      - Server SSL metrics sent

   *  - 
      - fw-pc-acos-harmony-topic
      - 8
      - FW PC logs sent

   *  - 
      - kafka-unknown-topic-dequeue-err
      - 8
      - Unknown type dropped,enq error analytics queues

   *  - 
      - fw-rst-pc-acos-harmony-topic-dequeue-err
      - 8
      - FW RST PC logs dropped,enq error analytics queues

   *  - 
      - avro-device-status-topic
      - 8
      - Device Status Metrics sent

   *  - 
      - analytics-bus-restart
      - 8
      - Analytics bus restart count

   *  - 
      - fw-deny-pc-acos-harmony-topic-dequeue-err
      - 8
      - FW DENY PC logs dropped,enq error analytics queues

   *  - 
      - pc-throttle-drop
      - 8
      - L4 PC logs dropped,throttling

   *  - 
      - pr-be-ttfb-anomaly
      - 8
      - L7 PR back-end ttfb is negative

   *  - 
      - slb-server-ssl-counters-metrics-topic-dequeue-err
      - 8
      - Server SSL metrics dropped,enq error analytics qs

   *  - 
      - waf-learn-pr-topic-dequeue-err
      - 8
      - WAF learn metrics dropped,enq error analytics qs

   *  - 
      - avro-partition-metrics-topic-dequeue-err
      - 8
      - Part metrics dropped,enq error analytics queues

   *  - 
      - pr-be-ttlb-anomaly
      - 8
      - L7 PR back-end ttlb is negative

   *  - 
      - pr-not-allowed-drop
      - 8
      - L7 PR dropped, not allowed to be sent

   *  - 
      - avro-generic-failed-encoding
      - 8
      - Generic Metrics dropped,encoding error

   *  - 
      - ssli-pe-acos-harmony-topic-dequeue-err
      - 8
      - SSLi PE topic to harmony dequeue error

   *  - 
      - cgn-pc-acos-harmony-topic
      - 8
      - CGN PC logs sent

   *  - 
      - ssli-pc-acos-harmony-topic-dequeue-err
      - 8
      - SSLi PC topic to harmony dequeue error

   *  - 
      - metrics-dropped-pt-missing
      - 8
      - Metrics dropped,missing partition tenant mapping

   *  - 
      - cgn-pe-acos-harmony-topic-dequeue-err
      - 8
      - CGN PE logs dropped,enq error analytics queues

   *  - 
      - slb-client-ssl-counters-metrics-topic
      - 8
      - Client SSL metrics sent

.. _1213_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - kafka-broker-state
      - enum
      -  Output contains one of the following values: - Up, Down