.. _fw_logging:

fw logging
==========

Bind a logging template to firewall


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

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

	 **Element Name**                      logging

	 **Element URI**                       /axapi/v3/fw/logging

	 **Element Attributes**                logging_attributes

	 **Statistics Data URI**               /axapi/v3/fw/logging/stats

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



.. raw:: html

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


:ref:`1598_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/fw/logging



.. raw:: html

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


:ref:`1598_logging_attributes`



.. 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/fw/logging



.. raw:: html

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


:ref:`1598_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/fw/logging



.. raw:: html

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


:ref:`1598_logging_attributes`



.. 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/fw/logging



.. raw:: html

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


:ref:`1598_logging_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1598_logging_attributes:

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

    **gtp**

        **Description:** gtp is a **JSON Block**.  Please see below for :ref:`1598_gtp` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/fw/logging/gtp <fw_logging_gtp>`

    **name**

        **Description** Logging Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Refernce Object:** :doc:`/axapi/v3/fw/template/logging <fw_template_logging>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1598_gtp:

gtp
^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1598_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - tcp-session-deleted
      - 8
      - TCP Session Deleted

   *  - 
      - icmpv6-session-created
      - 8
      - ICMPV6 Session Created

   *  - 
      - tcp-session-created
      - 8
      - TCP Session Created

   *  - 
      - sctp-session-created
      - 8
      - SCTP Session Created

   *  - 
      - iddos-blackhole-entry-delete
      - 8
      - iDDoS IP Entry Deleted

   *  - 
      - udp-session-created
      - 8
      - UDP Session Created

   *  - 
      - other-session-deleted
      - 8
      - Other Session Deleted

   *  - 
      - other-session-created
      - 8
      - Other Session Created

   *  - 
      - http-request-logged
      - 8
      - HTTP Request Logged

   *  - 
      - http-logging-invalid-format
      - 8
      - HTTP Logging Invalid Format Error

   *  - 
      - sctp-session-deleted
      - 8
      - SCTP Session Deleted

   *  - 
      - rule_not_logged
      - 8
      - Firewall Rule Not Logged

   *  - 
      - log_type_deny
      - 8
      - Log Event Type Deny

   *  - 
      - log_type_reset
      - 8
      - Log Event Type Reset

   *  - 
      - icmp-session-created
      - 8
      - ICMP Session Created

   *  - 
      - log_type_session_closed
      - 8
      - Log Event Type Session Close

   *  - 
      - icmpv6-session-deleted
      - 8
      - ICMPV6 Session Deleted

   *  - 
      - log_type_sctp_inner_proto_filter
      - 8
      - Log Event Type SCTP Inner Proto Filter

   *  - 
      - icmp-session-deleted
      - 8
      - ICMP Session Deleted

   *  - 
      - log_type_session_opened
      - 8
      - Log Event Type Session Open

   *  - 
      - log_message_sent
      - 8
      - Log Packet Sent

   *  - 
      - log-dropped
      - 8
      - Log Packets Dropped

   *  - 
      - udp-session-deleted
      - 8
      - UDP Session Deleted

   *  - 
      - iddos-blackhole-entry-create
      - 8
      - iDDoS IP Entry Created

   *  - 
      - session-limit-exceeded
      - 8
      - Session Limit Exceeded