.. _slb_template_logging:

slb template logging
====================

Logging template


logging Specification
---------------------

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

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

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

	 **Collection Name**                   :ref:`2186_logging_list`

	 **Collection URI**                    /axapi/v3/slb/template/logging

	                                       

	 **Element Name**                      logging

	 **Element URI**                       /axapi/v3/slb/template/logging/{name}

	 **Element Attributes**                logging_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2186_logging_attributes`



.. raw:: html

   </td><td></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/slb/template/logging



.. raw:: html

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


:ref:`2186_logging_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/slb/template/logging/{name}



.. raw:: html

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


:ref:`2186_logging_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/slb/template/logging



.. raw:: html

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


:ref:`2186_logging_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/slb/template/logging/{name}



.. raw:: html

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


:ref:`2186_logging_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/slb/template/logging/{name}



.. raw:: html

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


:ref:`2186_logging_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/slb/template/logging



.. raw:: html

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


:ref:`2186_logging_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/slb/template/logging/{name}



.. raw:: html

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


:ref:`2186_logging_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2186_logging_list:

logging-list
------------


    logging-list is **JSON List** of :ref:`2186_logging_attributes` 

        logging-list : [

             { :ref:`2186_logging_attributes` },

             { :ref:`2186_logging_attributes` },

             ...

         ]

.. _2186_logging_attributes:

logging attributes
------------------

    **auto**

        **Description** 'auto': Configure auto NAT for logging, default is auto enabled; 

        **Type:** string

        **Supported Values:** auto

        **Default:** auto

        **Mutual Exclusion:** auto and pool are mutually exclusive

    **format**

        **Description** Specify a format string for web logging (format string(less than 250 characters) for web logging)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 250 characters

        **Maximum Length:** 1 characters

    **keep-end**

        **Description** Number of unmasked characters at the end (default: 0)

        **Type:** number

        **Range:** 0-65535

        **Default:** 0

    **keep-start**

        **Description** Number of unmasked characters at the beginning (default: 0)

        **Type:** number

        **Range:** 0-65535

        **Default:** 0

    **local-logging**

        **Description** 1 to enable local logging (1 to enable local logging, default 0)

        **Type:** number

        **Range:** 0-1

        **Default:** 0

    **mask**

        **Description** Character to mask the matched pattern (default: X)

        **Type:** string

        **Maximum Length:** 1 characters

        **Maximum Length:** 1 characters

        **Default:** X

    **name**

        **Description** Logging Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **pcre-mask**

        **Description** Mask matched PCRE pattern in the log

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **pool**

        **Description** Specify NAT pool or pool group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** pool, shared-partition-pool, and auto are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ip/nat/pool <ip_nat_pool>`

    **pool-shared**

        **Description** Specify NAT pool or pool group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ip/nat/pool <ip_nat_pool>`

    **service-group**

        **Description** Bind a Service Group to the logging template (Service Group Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/service-group <slb_service_group>`

    **shared-partition-pool**

        **Description** Reference a NAT pool or pool group from shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared-partition-pool and pool are mutually exclusive

    **shared-partition-tcp-proxy-template**

        **Description** Reference a TCP Proxy template from shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive

    **tcp-proxy**

        **Description** TCP Proxy Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy <slb_template_tcp_proxy>`

    **template-tcp-proxy-shared**

        **Description** TCP Proxy Template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy <slb_template_tcp_proxy>`

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