.. _acos_events_collector_group:

acos-events collector-group
===========================

Configure log servers group


collector-group Specification
-----------------------------

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

	===================================== ===========================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`147_collector-group_list`

	 **Collection URI**                    /axapi/v3/acos-events/collector-group

	                                       

	 **Element Name**                      collector-group

	 **Element URI**                       /axapi/v3/acos-events/collector-group/{name}

	 **Element Attributes**                collector-group_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/acos-events/collector-group/{name}/stats

	 **Schema**                             :download:`collector-group schema <acos-events-collector-group/acos-events-collector-group.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/acos-events/collector-group



.. raw:: html

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


:ref:`147_collector-group_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/acos_events_collector_group_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/acos-events/collector-group



.. raw:: html

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


:ref:`147_collector-group_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/acos-events/collector-group/{name}



.. raw:: html

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


:ref:`147_collector-group_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/acos-events/collector-group



.. raw:: html

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


:ref:`147_collector-group_list`



.. 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/acos-events/collector-group/{name}



.. raw:: html

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


:ref:`147_collector-group_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/acos-events/collector-group/{name}



.. raw:: html

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


:ref:`147_collector-group_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/acos-events/collector-group



.. raw:: html

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


:ref:`147_collector-group_list`



.. 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/acos-events/collector-group/{name}



.. raw:: html

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


:ref:`147_collector-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _147_collector-group_list:

collector-group-list
--------------------


    collector-group-list is **JSON List** of :ref:`147_collector-group_attributes` 

        collector-group-list : [

             { :ref:`147_collector-group_attributes` },

             { :ref:`147_collector-group_attributes` },

             ...

         ]

.. _147_collector-group_attributes:

collector-group attributes
--------------------------

    **facility**

        **Description** 'local0': Local use(Default); 'local1': Local use; 'local2': Local use; 'local3': Local use; 'local4': Local use; 'local5': Local use; 'local6': Local use; 'local7': Local use;  (Facility parameter for syslog messages)

        **Type:** string

        **Supported Values:** local0, local1, local2, local3, local4, local5, local6, local7

        **Default:** local0

    **format**

        **Description** 'syslog': log message format is syslog (Default); 'cef': log message format is cef; 'leef': log message format is leef; 

        **Type:** string

        **Supported Values:** syslog, cef, leef

        **Default:** syslog

    **health-check**

        **Description** Health Check (Monitor Name)

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **log-distribution**

        **Description** 'round-robin': Log server selection will be based on round-robin (Default); 'hashing': Log messages at this node only; 

        **Type:** string

        **Supported Values:** round-robin, hashing

        **Default:** round-robin

    **log-server-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/acos-events/collector-group/{name}/log-server/{name}+{port} <acos_events_collector_group>`

    **name**

        **Description** Specify log server group name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **protocol**

        **Description** 'udp': use udp syslog protocol to send messages to log collector; 'tcp': use tcp syslog protocol to send messages to log collector; 

        **Type:** string

        **Supported Values:** udp, tcp

    **rate**

        **Description** Specify the log message rate per second(Default 500)

        **Type:** number

        **Range:** 0-2147483647

        **Default:** 500

    **sampling-enable**

        **Type:** List

    **server-distribution-hash**

        **Description** 'name': Hashing will be based on log server name (Default); 'ip-tuple': Hashing will be based on ip-tuple; 

        **Type:** string

        **Supported Values:** name, ip-tuple

        **Default:** name

    **use-mgmt-port**

        **Description** Use managament port to connect to the log servers

        **Type:** boolean

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

        **Default:** 0

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _147_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'msgs_sent': Number of log messages sent; 'msgs_rate_limited': Number of rate limited log messages; 'msgs_dropped': Number of messages dropped for other reasons; 

        **Type:** string

        **Supported Values:** all, msgs_sent, msgs_rate_limited, msgs_dropped

.. _147_log-server-list:

log-server-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **name**

        **Description** Member name

        **Type:** string

        **Format:** comp-string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/acos-events/log-server <acos_events_log_server>`

    **port**

        **Description** Port number

        **Type:** number

        **Range:** 0-65534

        **Default:** 65534

        **Reference Object:** :doc:`/axapi/v3/acos-events/log-server/port <acos_events_log_server_port>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters