.. _logging_auditlog:

logging auditlog
================

Set send auditlog to syslog host


auditlog Specification
----------------------

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

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

	 **Element Name**                      auditlog

	 **Element URI**                       /axapi/v3/logging/auditlog

	 **Element Attributes**                auditlog_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2225_auditlog_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/logging_auditlog_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/logging/auditlog



.. raw:: html

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


:ref:`2225_auditlog_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/logging_auditlog_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/logging/auditlog



.. raw:: html

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


:ref:`2225_auditlog_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/logging/auditlog



.. raw:: html

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


:ref:`2225_auditlog_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/logging_auditlog_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/logging/auditlog



.. raw:: html

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


:ref:`2225_auditlog_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/logging_auditlog_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2225_auditlog_attributes:

auditlog attributes
-------------------

    **audit-facility**

        **Description** 'local0': Local use; 'local1': Local use; 'local2': Local use; 'local3': Local use; 'local4': Local use; 'local5': Local use; 'local6': Local use; 'local7': Local use;  (Configure the facility of auditlog)

        **Type:** string

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

    **host4**

        **Description** Configure the auditlog host

        **Type:** string

        **Format:** host

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** host4,shared,  partition-name, and host6 are mutually exclusive

    **host6**

        **Description** Configure the auditlog host

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** host6,shared,  partition-name, and host4 are mutually exclusive

    **partition-name**

        **Description** Select partition name for logging

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** partition-name,shared,  host6, and host4 are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/partition <partition>`

    **port**

        **Description** Set remote audit log port number(Default 514)

        **Type:** number

        **Range:** 1-32767

        **Default:** 514

    **shared**

        **Description** Select shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared,partition-name,  host6, and host4 are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters