.. _acos_events:

acos-events
===========

Configure message logging


acos-events Specification
-------------------------

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

	 **Element Name**                      acos-events

	 **Element URI**                       /axapi/v3/acos-events

	 **Element Attributes**                acos-events_attributes

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



.. raw:: html

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


acos-events_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1705_acos-events_attributes:

acos-events attributes
----------------------

    **active-template**

        **Description:** active-template is a **JSON Block**.  Please see below for :ref:`1705_active-template` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/acos-events/active-template <acos_events_active_template>`

    **collector-group-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/acos-events/collector-group/{name} <acos_events_collector_group>`

    **log-server-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/acos-events/log-server/{name} <acos_events_log_server>`

    **logdb**

        **Description:** logdb is a **JSON Block**.  Please see below for :ref:`1705_logdb` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/acos-events/logdb <acos_events_logdb>`

    **message-id-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/acos-events/message-id/{log-msg} <acos_events_message_id>`

    **message-info**

        **Description:** message-info is a **JSON Block**.  Please see below for :ref:`1705_message-info` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/acos-events/message-info <acos_events_message_info>`

    **message-selector-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/acos-events/message-selector/{name} <acos_events_message_selector>`

    **statistics**

        **Description:** statistics is a **JSON Block**.  Please see below for :ref:`1705_statistics` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/acos-events/statistics <acos_events_statistics>`

    **template-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/acos-events/template/{name} <acos_events_template>`

.. _1705_statistics:

statistics
^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1705_statistics_sampling-enable:

statistics_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'msg_dropped_malloc_failure': Messages Dropped due to malloc failure; 'msg_dropped_no_template': Messages Dropped, no active template; 'msg_dropped_selector': Messages Dropped, selector does not enable msg; 'msg_dropped_too_long': Messages Dropped, invalid length; 'msg_dropped_other': Messages Dropped, unexpected error; 

        **Type:** string

        **Supported Values:** all, msg_dropped_malloc_failure, msg_dropped_no_template, msg_dropped_selector, msg_dropped_too_long, msg_dropped_other

.. _1705_message-info:

message-info
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1705_active-template:

active-template
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **name**

        **Description** Specify the logging template name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Refernce Object:** :doc:`/axapi/v3/acos-events/template <acos_events_template>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1705_logdb:

logdb
^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **enable-all**

        **Description** Enable logging for all widgets

        **Type:** boolean

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

        **Default:** 0

    **enable-cgn**

        **Description** Enable CGN logging

        **Type:** boolean

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

        **Default:** 0

    **enable-file-inspection**

        **Description** Enable file-inspection logging

        **Type:** boolean

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

        **Default:** 0

    **enable-fw**

        **Description** Enable Firewall logging

        **Type:** boolean

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

        **Default:** 0

    **enable-smtp**

        **Description** Enable SMTP logging

        **Type:** boolean

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

        **Default:** 0

    **enable-ssli-bypass**

        **Description** Enable SSLi bypass logging

        **Type:** boolean

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

        **Default:** 0

    **enable-ssli-failed**

        **Description** Enable SSLi failed logging

        **Type:** boolean

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

        **Default:** 0

    **enable-ssli-success**

        **Description** Enable SSLi success logging

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

.. _1705_message-id-list:

message-id-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **log-msg**

        **Description** Specify log message-id lineage

        **Type:** string

        **Maximum Length:** 512 characters

        **Maximum Length:** 1 characters

    **property**

        **Description:** property is a **JSON Block**.  Please see below for :ref:`1705_message-id-list_property` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/acos-events/message-id/{log-msg}/property <acos_events_message_id>`

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

.. _1705_message-id-list_property:

message-id-list_property
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **severity**

        **Description:** severity is a **JSON Block**.  Please see below for :ref:`1705_message-id-list_property_severity` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/acos-events/message-id/{log-msg}/property/severity <acos_events_message_id>`

.. _1705_message-id-list_property_severity:

message-id-list_property_severity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **severity-val**

        **Description** 'emergency': System unusable log messages      (severity=0); 'alert': Action must be taken immediately  (severity=1); 'critical': Critical conditions               (severity=2); 'error': Error conditions                  (severity=3); 'warning': Warning conditions                (severity=4); 'notification': Normal but significant conditions (severity=5); 'information': Informational messages            (severity=6); 'debugging': Debug level messages              (severity=7); 

        **Type:** string

        **Supported Values:** emergency, alert, critical, error, warning, notification, information, debugging

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1705_log-server-list:

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

	 **Block object keys**             

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

    **action**

        **Description** 'enable': Enable this Logging Server; 'disable': Disable this Logging Server; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **fqdn-name**

        **Description** Server hostname

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **health-check**

        **Description** Health Check Monitor (Health monitor name)

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive

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

    **health-check-disable**

        **Description** Disable configured health check configuration

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive

    **host**

        **Description** IP Address

        **Type:** string

        **Format:** ipv4-address

    **name**

        **Description** Server Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **port-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/acos-events/log-server/{name}/port/{port-number}+{protocol} <acos_events_log_server>`

    **resolve-as**

        **Description** 'resolve-to-ipv4': Use A Query only to resolve FQDN; 'resolve-to-ipv6': Use AAAA Query only to resolve FQDN; 'resolve-to-ipv4-and-ipv6': Use A as well as AAAA Query to resolve FQDN; 

        **Type:** string

        **Supported Values:** resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6

        **Default:** resolve-to-ipv4

    **sampling-enable**

        **Type:** List

    **server-ipv6-addr**

        **Description** IPV6 address

        **Type:** string

        **Format:** ipv6-address

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

.. _1705_log-server-list_port-list:

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

	 **Block object keys**             

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

    **action**

        **Description** 'enable': enable; 'disable': disable; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **health-check**

        **Description** Health Check (Monitor Name)

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive

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

    **health-check-disable**

        **Description** Disable health check

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive

    **port-number**

        **Description** Port Number

        **Type:** number

        **Range:** 0-65534

    **protocol**

        **Description** 'tcp': TCP Port; 'udp': UDP Port; 

        **Type:** string

        **Supported Values:** tcp, udp

    **sampling-enable**

        **Type:** List

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

.. _1705_log-server-list_port-list_sampling-enable:

log-server-list_port-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'msgs_sent': Number of log messages sent; 

        **Type:** string

        **Supported Values:** all, msgs_sent

.. _1705_log-server-list_sampling-enable:

log-server-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'msgs_sent': Number of log messages sent; 

        **Type:** string

        **Supported Values:** all, msgs_sent

.. _1705_template-list:

template-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **msg-cfg**

        **Type:** List

    **name**

        **Description** Specify logging template name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

.. _1705_template-list_msg-cfg:

template-list_msg-cfg
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **collector-group**

        **Description** Specify the log server group for receiving log messages

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Refernce Object:** :doc:`/axapi/v3/acos-events/collector-group <acos_events_collector_group>`

    **message-selector**

        **Description** Specify the message selector

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Refernce Object:** :doc:`/axapi/v3/acos-events/message-selector <acos_events_message_selector>`

.. _1705_collector-group-list:

collector-group-list
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **format**

        **Description** 'syslog': syslog is the only format supported at this time; 

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

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

    **log-server-list**

        **Type:** List

        **Refernce 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:** 127 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

        **Type:** number

        **Range:** 0-2147483647

    **sampling-enable**

        **Type:** List

    **secs**

        **Description** Specify the interval in seconds

        **Type:** number

        **Range:** 1-100

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

.. _1705_collector-group-list_sampling-enable:

collector-group-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

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

        **Type:** string

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

.. _1705_collector-group-list_log-server-list:

collector-group-list_log-server-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **name**

        **Description** Member name

        **Type:** string

        **Format:** comp-string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

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

    **port**

        **Description** Port number

        **Type:** number

        **Range:** 0-65534

        **Default:** 65534

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

.. _1705_message-selector-list:

message-selector-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **name**

        **Description** Specify message selector name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **rule-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/acos-events/message-selector/{name}/rule/{index} <acos_events_message_selector>`

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

.. _1705_message-selector-list_rule-list:

message-selector-list_rule-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'send': log messages selected by this rule will be sent; 'drop': log messages selected by this rule will be dropped; 

        **Type:** string

        **Supported Values:** send, drop

        **Default:** send

    **index**

        **Description** Specify rule index - rules are applied in numeric order

        **Type:** number

        **Range:** 1-256

    **message-id**

        **Description** Select a specific message by message-id and optionally severity

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **message-id-scope**

        **Description** 'all': Log messages at this level and all sub-trees; 'node-only': Log messages at this node only; 'children-only': Log messages at all sub-trees; 

        **Type:** string

        **Supported Values:** all, node-only, children-only, log-field-only

    **severity-oper**

        **Description** 'equal-and-higher': emergency is highest, debugging lowest; 'equal': single severity; 

        **Type:** string

        **Supported Values:** equal-and-higher, equal

    **severity-val**

        **Description** 'emergency': System unusable log messages      (severity=0); 'alert': Action must be taken immediately  (severity=1); 'critical': Critical conditions               (severity=2); 'error': Error conditions                  (severity=3); 'warning': Warning conditions                (severity=4); 'notification': Normal but significant conditions (severity=5); 'information': Informational messages            (severity=6); 'debugging': Debug level messages              (severity=7); 

        **Type:** string

        **Supported Values:** emergency, alert, critical, error, warning, notification, information, debugging

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