.. _event_notification_kafka_server:

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

Set remote kafka server ip address


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

	===================================== ========================================================================
	 **Parameter**                         **Value** 

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

	 **Element Name**                      server

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

	 **Element Attributes**                server_attributes

	 **Partition Visibility**              shared

	 **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:`1498_server_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/event_notification_kafka_server_POST.txt
   :literal:




.. raw:: html

   </div></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:`1498_server_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/event_notification_kafka_server_GET.txt
   :literal:




.. raw:: html

   </div></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:`1498_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:`1498_server_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/event_notification_kafka_server_PUT.txt
   :literal:




.. raw:: html

   </div></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:`1498_server_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/event_notification_kafka_server_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1498_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

    **sampling-enable**

        **Type:** List

    **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

.. _1498_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **counters1**

        **Description** 'all': all; 'pr-acos-harmony-topic': L7 PR logs sent; 'avro-device-status-topic': Device Status Metrics sent; 'avro-partition-metrics-topic': Partition Metrics sent; 'avro-generic-sent': Generic Metrics sent; 'pr-acos-harmony-topic-enqueue-err': L7 PR dropped,enq error on acos queues; 'pr-acos-harmony-topic-dequeue-err': L7 PR dropped,enq error analytics queues; 'avro-generic-failed-encoding': Generic Metrics dropped,encoding error; 'avro-generic-failed-sending': Generic Metrics dropped,sending failure; 'avro-device-status-topic-enqueue-err': Device Status dropped,enq error on acos queues; 'avro-device-status-topic-dequeue-err': Device Status dropped,enq error analytics queues; 'avro-partition-metrics-topic-enqueue-err': Part metrics dropped,enq error on acos queues; 'avro-partition-metrics-topic-dequeue-err': Part metrics dropped,enq error analytics queues; 'kafka-unknown-topic-dequeue-err': Unknown type dropped,enq error analytics queues; 'kafka-broker-down': Messages dropped,analytics down; 'kafka-queue-full-err': Messages dropped,acos analytics queue full; 'pr-throttle-drop': L7 PR dropped,log throttling; 'pr-not-allowed-drop': L7 PR dropped, not allowed to be sent; 'pr-be-ttfb-anomaly': L7 PR back-end ttfb is negative; 'pr-be-ttlb-anomaly': L7 PR back-end ttlb is negative; 'pr-in-latency-threshold-exceed': L7 PR on latency threshold exceeded; 'pr-out-latency-threshold-exceed': L7 PR out latency threshold exceeded; 'pr-out-latency-anomaly': L7 PR out latency negative; 'pr-in-latency-anomaly': L7 PR on latency negative; 'kafka-topic-error': Module not supported by analytics; 'pc-encoding-failed': L4 PC logs dropped,encoding error; 'pc-acos-harmony-topic': L4 PC logs sent; 'pc-acos-harmony-topic-dequeue-err': L4 PC logs dropped,enq error analytics queues; 'cgn-pc-acos-harmony-topic': CGN PC logs sent; 'cgn-pc-acos-harmony-topic-dequeue-err': CGN PC logs dropped,enq error analytics queues; 'cgn-pe-acos-harmony-topic': CGN PE logs sent; 'cgn-pe-acos-harmony-topic-dequeue-err': CGN PE logs dropped,enq error analytics queues; 'fw-pc-acos-harmony-topic': FW PC logs sent; 'fw-pc-acos-harmony-topic-dequeue-err': FW PC logs dropped,enq error analytics queues; 'fw-deny-pc-acos-harmony-topic': FW DENY PC logs sent; 'fw-deny-pc-acos-harmony-topic-dequeue-err': FW DENY PC logs dropped,enq error analytics queues; 'fw-rst-pc-acos-harmony-topic': FW RST PC logs sent; 'fw-rst-pc-acos-harmony-topic-dequeue-err': FW RST PC logs dropped,enq error analytics queues; 'cgn-summary-error-acos-harmony-topic': CGN PE logs sent; 'cgn-summary-error-acos-harmony-topic-dequeue-err': CGN PE logs dropped,enq error analytics queues; 'rule-set-application-metrics-topic': AppFW metrics sent; 'rule-set-application-metrics-topic-dequeue-err': AppFW metrics dropped,enq error analytics queues; 'slb-ssl-stats-metrics-topic': SSL metrics sent; 'slb-ssl-stats-metrics-topic-dequeue-err': SSL metrics dropped,enq error analytics queues; 'slb-client-ssl-counters-metrics-topic': Client SSL metrics sent; 'slb-client-ssl-counters-metrics-topic-dequeue-err': Cilent SSL metrics dropped,enq error analytics qs; 'slb-server-ssl-counters-metrics-topic': Server SSL metrics sent; 'slb-server-ssl-counters-metrics-topic-dequeue-err': Server SSL metrics dropped,enq error analytics qs; 'pc-throttle-drop': L4 PC logs dropped,throttling; 'metrics-dropped-pt-missing': Metrics dropped,missing partition tenant mapping; 'ssli-pc-acos-harmony-topic': SSLi PC topic counter from acos to harmony; 'ssli-pc-acos-harmony-topic-dequeue-err': SSLi PC topic to harmony dequeue error; 'ssli-pe-acos-harmony-topic': SSLi PE topic counter from acos to harmony; 'ssli-pe-acos-harmony-topic-dequeue-err': SSLi PE topic to harmony dequeue error; 'analytics-bus-restart': Analytics bus restart count; 'waf-learn-pr-topic': WAF learn topic counter; 'waf-learn-pr-topic-dequeue-err': WAF learn metrics dropped,enq error analytics qs; 'waf-events-topic': WAF events topic counter; 'waf-events-topic-dequeue-err': WAF events metrics dropped,enq error analytics qs; 'visibility-topn-harmony-topic': Visibility TopN sent; 'visibility-topn-harmony-topic-dequeue-err': Visibility TopN metrics dropped,enq error analytics qs; 'hc-logs-sent-to-master': HC logs sent to master; 'hc-logs-received-from-blade': HC logs received from blade; 'hc-oper-sent-to-master': HC oper to master; 'hc-oper-received-from-blade': HC oper received from blade; 'hc-counters-sent-to-master': HC counters sent to master; 'hc-counters-received-from-blade': HC counters received from blade; 'hc-counters-dropped-from-blade': HC counters dropped from blade (uuid or size mismatch); 'pe-acos-harmony-topic': L7 PE logs sent; 'pe-acos-harmony-topic-enqueue-err': L7 PE dropped,enq error on acos queues; 'pe-acos-harmony-topic-dequeue-err': L7 PE dropped,enq error analytics queues; 'vpn-ipsec-sa-metrics-topic': IPSec SA metrics sent; 'vpn-ipsec-sa-metrics-topic-dequeue-err': IPSec SA metrics dropped,enq error analytics qs; 'vpn-ike-gateway-metrics-topic': IKE gateway metrics sent; 'vpn-ike-gateway-metrics-topic-dequeue-err': IKE gateway metrics dropped,enq error analytics qs; 'vpn-stats-metrics-topic': VPN STATS metrics sent; 'vpn-stats-metrics-topic-dequeue-err': VPN STATS metrics dropped,enq error analytics qs; 'cgn-port-usage-hstgrm-acos-harmony-topic': CGN Port Usage Histogram HC Export; 'cgn-port-usage-hstgrm-acos-harmony-topic-dequeue-err': CGN Port Usage Histogram HC Export Failed; 'avro-system-env-topic': System environment sent; 'avro-system-env-dequeue-err': System Environmet dropped,enq error analytics queues; 'cert-pinning-list-topic': Cert-pinning candidate list sent; 'cert-pinning-list-topic-dequeue-err': Cert-pinning candidate list dropped,enq error analytics queues; 'ngwaf-hc-ep-topic': NGWAF HC PE export; 'ngwaf-hc-ep-topic-dequeue-err': NGWAF HC PE export failed; 'ngwaf-hc-metrics-topic': NGWAF HC metrics export; 'ngwaf-hc-metrics-topic-dequeue-err': NGWAF HC metrics export failed; 

        **Type:** string

        **Supported Values:** all, pr-acos-harmony-topic, avro-device-status-topic, avro-partition-metrics-topic, avro-generic-sent, pr-acos-harmony-topic-enqueue-err, pr-acos-harmony-topic-dequeue-err, avro-generic-failed-encoding, avro-generic-failed-sending, avro-device-status-topic-enqueue-err, avro-device-status-topic-dequeue-err, avro-partition-metrics-topic-enqueue-err, avro-partition-metrics-topic-dequeue-err, kafka-unknown-topic-dequeue-err, kafka-broker-down, kafka-queue-full-err, pr-throttle-drop, pr-not-allowed-drop, pr-be-ttfb-anomaly, pr-be-ttlb-anomaly, pr-in-latency-threshold-exceed, pr-out-latency-threshold-exceed, pr-out-latency-anomaly, pr-in-latency-anomaly, kafka-topic-error, pc-encoding-failed, pc-acos-harmony-topic, pc-acos-harmony-topic-dequeue-err, cgn-pc-acos-harmony-topic, cgn-pc-acos-harmony-topic-dequeue-err, cgn-pe-acos-harmony-topic, cgn-pe-acos-harmony-topic-dequeue-err, fw-pc-acos-harmony-topic, fw-pc-acos-harmony-topic-dequeue-err, fw-deny-pc-acos-harmony-topic, fw-deny-pc-acos-harmony-topic-dequeue-err, fw-rst-pc-acos-harmony-topic, fw-rst-pc-acos-harmony-topic-dequeue-err, cgn-summary-error-acos-harmony-topic, cgn-summary-error-acos-harmony-topic-dequeue-err, rule-set-application-metrics-topic, rule-set-application-metrics-topic-dequeue-err, slb-ssl-stats-metrics-topic, slb-ssl-stats-metrics-topic-dequeue-err, slb-client-ssl-counters-metrics-topic, slb-client-ssl-counters-metrics-topic-dequeue-err, slb-server-ssl-counters-metrics-topic, slb-server-ssl-counters-metrics-topic-dequeue-err, pc-throttle-drop, metrics-dropped-pt-missing, ssli-pc-acos-harmony-topic, ssli-pc-acos-harmony-topic-dequeue-err, ssli-pe-acos-harmony-topic, ssli-pe-acos-harmony-topic-dequeue-err, analytics-bus-restart, waf-learn-pr-topic, waf-learn-pr-topic-dequeue-err, waf-events-topic, waf-events-topic-dequeue-err, visibility-topn-harmony-topic, visibility-topn-harmony-topic-dequeue-err, hc-logs-sent-to-master, hc-logs-received-from-blade, hc-oper-sent-to-master, hc-oper-received-from-blade, hc-counters-sent-to-master, hc-counters-received-from-blade, hc-counters-dropped-from-blade, pe-acos-harmony-topic, pe-acos-harmony-topic-enqueue-err, pe-acos-harmony-topic-dequeue-err, vpn-ipsec-sa-metrics-topic, vpn-ipsec-sa-metrics-topic-dequeue-err, vpn-ike-gateway-metrics-topic, vpn-ike-gateway-metrics-topic-dequeue-err, vpn-stats-metrics-topic, vpn-stats-metrics-topic-dequeue-err, cgn-port-usage-hstgrm-acos-harmony-topic, cgn-port-usage-hstgrm-acos-harmony-topic-dequeue-err, avro-system-env-topic, avro-system-env-dequeue-err, cert-pinning-list-topic, cert-pinning-list-topic-dequeue-err, ngwaf-hc-ep-topic, ngwaf-hc-ep-topic-dequeue-err, ngwaf-hc-metrics-topic, ngwaf-hc-metrics-topic-dequeue-err