.. _ip_nat_template_logging:

ip nat template logging
=======================

NAT Logging Template


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

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

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

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

	 **Collection Name**                   :ref:`2125_logging_list`

	 **Collection URI**                    /axapi/v3/ip/nat/template/logging

	                                       

	 **Element Name**                      logging

	 **Element URI**                       /axapi/v3/ip/nat/template/logging/{name}

	 **Element Attributes**                logging_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2125_logging_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/ip_nat_template_logging_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/ip/nat/template/logging



.. raw:: html

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


:ref:`2125_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/ip/nat/template/logging/{name}



.. raw:: html

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


:ref:`2125_logging_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/ip_nat_template_logging_GET.txt
   :literal:




.. raw:: html

   </div></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/ip/nat/template/logging



.. raw:: html

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


:ref:`2125_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/ip/nat/template/logging/{name}



.. raw:: html

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


:ref:`2125_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/ip/nat/template/logging/{name}



.. raw:: html

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


:ref:`2125_logging_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/ip_nat_template_logging_PUT.txt
   :literal:




.. raw:: html

   </div></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/ip/nat/template/logging



.. raw:: html

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


:ref:`2125_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/ip/nat/template/logging/{name}



.. raw:: html

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


:ref:`2125_logging_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/ip_nat_template_logging_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2125_logging_list:

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


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

        logging-list : [

             { :ref:`2125_logging_attributes` },

             { :ref:`2125_logging_attributes` },

             ...

         ]

.. _2125_logging_attributes:

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

    **facility**

        **Description** 'kernel': 0: Kernel; 'user': 1: User-level; 'mail': 2: Mail; 'daemon': 3: System daemons; 'security-authorization': 4: Security/authorization; 'syslog': 5: Syslog internal; 'line-printer': 6: Line printer; 'news': 7: Network news; 'uucp': 8: UUCP subsystem; 'cron': 9: Time-related; 'security-authorization-private': 10: Private security/authorization; 'ftp': 11: FTP; 'ntp': 12: NTP; 'audit': 13: Audit; 'alert': 14: Alert; 'clock': 15: Clock-related; 'local0': 16: Local use 0; 'local1': 17: Local use 1; 'local2': 18: Local use 2; 'local3': 19: Local use 3; 'local4': 20: Local use 4; 'local5': 21: Local use 5; 'local6': 22: Local use 6; 'local7': 23: Local use 7; 

        **Type:** string

        **Supported Values:** kernel, user, mail, daemon, security-authorization, syslog, line-printer, news, uucp, cron, security-authorization-private, ftp, ntp, audit, alert, clock, local0, local1, local2, local3, local4, local5, local6, local7

        **Default:** local0

    **include-destination**

        **Description** Include the destination IP and port in logs

        **Type:** boolean

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

        **Default:** 0

    **include-rip-rport**

        **Description** Include the IP and port of real server in logs

        **Type:** boolean

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

        **Default:** 0

    **log**

        **Description:** log is a **JSON Block**.  Please see below for :ref:`2125_log` 

        **Type:** Object

    **name**

        **Description** NAT logging template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **service-group**

        **Description** Set NAT logging service-group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

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

    **severity**

        **Description:** severity is a **JSON Block**.  Please see below for :ref:`2125_severity` 

        **Type:** Object

    **source-port**

        **Description:** source-port is a **JSON Block**.  Please see below for :ref:`2125_source-port` 

        **Type:** Object

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

.. _2125_severity:

severity
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **severity-string**

        **Description** 'emergency': 0: Emergency; 'alert': 1: Alert; 'critical': 2: Critical; 'error': 3: Error; 'warning': 4: Warning; 'notice': 5: Notice; 'informational': 6: Informational; 'debug': 7: Debug; 

        **Type:** string

        **Supported Values:** emergency, alert, critical, error, warning, notice, informational, debug

        **Default:** debug

        **Mutual Exclusion:** severity-string and severity-val are mutually exclusive

    **severity-val**

        **Description** Logging severity level

        **Type:** number

        **Range:** 0-7

        **Default:** 7

        **Mutual Exclusion:** severity-val and severity-string are mutually exclusive

.. _2125_log:

log
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **port-mappings**

        **Description** 'creation': Log creation of NAT mappgins; 'disable': Disable Log creation and deletion of NAT mappings; 

        **Type:** string

        **Supported Values:** creation, disable

.. _2125_source-port:

source-port
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **any**

        **Description** Use any source port

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** any and source-port-num are mutually exclusive

    **source-port-num**

        **Description** Set source port for sending NAT syslogs (default: 514)

        **Type:** number

        **Range:** 1-65535

        **Default:** 514

        **Mutual Exclusion:** source-port-num and any are mutually exclusive