.. _event_notification:

event-notification
==================

Event notification type


event-notification Specification
--------------------------------

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

	===================================== ===========================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      event-notification

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

	 **Element Attributes**                event-notification_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`event-notification schema <event-notification/event-notification.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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/event-notification



.. raw:: html

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


event-notification_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _790_event-notification_attributes:

event-notification attributes
-----------------------------

    **kafka**

        **Description:** kafka is a **JSON Block**.  Please see below for :ref:`790_kafka` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/event-notification/kafka <event_notification_kafka>`

.. _790_kafka:

kafka
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **server**

        **Description:** server is a **JSON Block**.  Please see below for :ref:`790_kafka_server` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/event-notification/kafka/server <event_notification_kafka_server>`

.. _790_kafka_server:

kafka_server
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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