.. _cgnv6_logging:

cgnv6 logging
=============

CGNV6 Logging Statistics


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

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

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

	 **Element Name**                      logging

	 **Element URI**                       /axapi/v3/cgnv6/logging

	 **Element Attributes**                logging_attributes

	 **Partition Visibility**              shared

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

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



.. raw:: html

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


:ref:`328_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/cgnv6_logging_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/cgnv6/logging



.. raw:: html

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


:ref:`328_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/cgnv6_logging_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/cgnv6/logging



.. raw:: html

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


:ref:`328_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/cgnv6/logging



.. raw:: html

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


:ref:`328_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/cgnv6_logging_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/cgnv6/logging



.. raw:: html

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


:ref:`328_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/cgnv6_logging_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _328_logging_attributes:

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

    **nat-quota-exceeded**

        **Description:** nat-quota-exceeded is a **JSON Block**.  Please see below for :ref:`328_nat-quota-exceeded` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/logging/nat-quota-exceeded <cgnv6_logging_nat_quota_exceeded>`

    **nat-resource-exhausted**

        **Description:** nat-resource-exhausted is a **JSON Block**.  Please see below for :ref:`328_nat-resource-exhausted` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/logging/nat-resource-exhausted <cgnv6_logging_nat_resource_exhausted>`

    **sampling-enable**

        **Type:** List

    **source-address**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/logging/source-address <cgnv6_logging_source_address>`

    **tcp-svr-status**

        **Description:** tcp-svr-status is a **JSON Block**.  Please see below for :ref:`328_tcp-svr-status` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/logging/tcp-svr-status <cgnv6_logging_tcp_svr_status>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _328_tcp-svr-status:

tcp-svr-status
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _328_source-address:

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

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _328_nat-quota-exceeded:

nat-quota-exceeded
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **level**

        **Description** 'warning': Log level Warning (Default); 'critical': Log level Critical; 'notice': Log level Notice; 

        **Type:** string

        **Supported Values:** warning, critical, notice

        **Default:** warning

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _328_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'tcp-session-created': TCP Session Created; 'tcp-session-deleted': TCP Session Deleted; 'tcp-port-allocated': TCP Port Allocated; 'tcp-port-freed': TCP Port Freed; 'tcp-port-batch-allocated': TCP Port Batch Allocated; 'tcp-port-batch-freed': TCP Port Batch Freed; 'udp-session-created': UDP Session Created; 'udp-session-deleted': UDP Session Deleted; 'udp-port-allocated': UDP Port Allocated; 'udp-port-freed': UDP Port Freed; 'udp-port-batch-allocated': UDP Port Batch Allocated; 'udp-port-batch-freed': UDP Port Batch Freed; 'icmp-session-created': ICMP Session Created; 'icmp-session-deleted': ICMP Session Deleted; 'icmp-resource-allocated': ICMP Resource Allocated; 'icmp-resource-freed': ICMP Resource Freed; 'icmpv6-session-created': ICMPV6 Session Created; 'icmpv6-session-deleted': ICMPV6 Session Deleted; 'icmpv6-resource-allocated': ICMPV6 Resource Allocated; 'icmpv6-resource-freed': ICMPV6 Resource Freed; 'gre-session-created': GRE Session Created; 'gre-session-deleted': GRE Session Deleted; 'gre-resource-allocated': GRE Resource Allocated; 'gre-resource-freed': GRE Resource Freed; 'esp-session-created': ESP Session Created; 'esp-session-deleted': ESP Session Deleted; 'esp-resource-allocated': ESP Resource Allocated; 'esp-resource-freed': ESP Resource Freed; 'fixed-nat-user-ports': Fixed NAT Inside User Port Mapping; 'fixed-nat-disable-config-logged': Fixed NAT Periodic Configs Logged; 'fixed-nat-disable-config-logs-sent': Fixed NAT Periodic Config Logs Sent; 'fixed-nat-periodic-config-logs-sent': Fixed NAT Disabled Configs Logged; 'fixed-nat-periodic-config-logged': Fixed NAT Disabled Config Logs Sent; 'fixed-nat-interim-updated': Fixed NAT Interim Updated; 'enhanced-user-log': Enhanced User Log; 'log-sent': Log Packets Sent; 'log-dropped': Log Packets Dropped; 'conn-tcp-established': TCP Connection Established; 'conn-tcp-dropped': TCP Connection Lost; 'tcp-port-overloading-allocated': TCP Port Overloading Allocated; 'tcp-port-overloading-freed': TCP Port Overloading Freed; 'udp-port-overloading-allocated': UDP Port Overloading Allocated; 'udp-port-overloading-freed': UDP Port Overloading Freed; 'http-request-logged': HTTP Request Logged; 'reduced-logs-by-destination': Reduced Logs by Destination Protocol and Port; 'out-of-buffers': Out of Buffers; 'add-msg-failed': Add Message to Buffer Failed; 'rtsp-port-allocated': RTSP UDP Port Allocated; 'rtsp-port-freed': RTSP UDP Port Freed; 'conn-tcp-create-failed': TCP Connection Failed; 'ipv4-frag-applied': IPv4 Fragmentation Applied; 'ipv4-frag-failed': IPv4 Fragmentation Failed; 'ipv6-frag-applied': IPv6 Fragmentation Applied; 'ipv6-frag-failed': IPv6 Fragmentation Failed; 'interim-update-scheduled': Port Allocation Interim Update Scheduled; 'interim-update-schedule-failed': Port Allocation Interim Update Failed; 'interim-update-terminated': Port Allocation Interim Update Terminated; 'interim-update-memory-freed': Port Allocation Interim Update Memory Freed; 'interim-update-no-buff-retried': Port Allocation Interim Update Memory Freed; 'tcp-port-batch-interim-updated': TCP Port Batch Interim Updated; 'udp-port-batch-interim-updated': UDP Port Batch Interim Updated; 'port-block-accounting-freed': Port Allocation Accounting Freed; 'port-block-accounting-allocated': Port Allocation Accounting Allocated; 'log-message-too-long': Log message too long; 'http-out-of-order-dropped': HTTP out-of-order dropped; 'http-alloc-failed': HTTP Request Info Allocation Failed; 'http-frag-merge-failed-dropped': HTTP frag merge failed dropped; 'http-malloc': HTTP mem allocate; 'http-mfree': HTTP mem free; 'http-spm-alloc-type0': HTTP Conn SPM Type 0 allocate; 'http-spm-alloc-type1': HTTP Conn SPM Type 1 allocate; 'http-spm-alloc-type2': HTTP Conn SPM Type 2 allocate; 'http-spm-alloc-type3': HTTP Conn SPM Type 3 allocate; 'http-spm-alloc-type4': HTTP Conn SPM Type 4 allocate; 'http-spm-free-type0': HTTP Conn SPM Type 0 free; 'http-spm-free-type1': HTTP Conn SPM Type 1 free; 'http-spm-free-type2': HTTP Conn SPM Type 2 free; 'http-spm-free-type3': HTTP Conn SPM Type 3 free; 'http-spm-free-type4': HTTP Conn SPM Type 4 free; 'iddos-l3-entry-create': iDDoS L3 Entry Created; 'iddos-l3-entry-delete': iDDoS L3 Entry Deleted; 'iddos-l4-entry-create': iDDoS L4 Entry Created; 'iddos-l4-entry-delete': iDDoS L4 Entry Deleted; 

        **Type:** string

        **Supported Values:** all, tcp-session-created, tcp-session-deleted, tcp-port-allocated, tcp-port-freed, tcp-port-batch-allocated, tcp-port-batch-freed, udp-session-created, udp-session-deleted, udp-port-allocated, udp-port-freed, udp-port-batch-allocated, udp-port-batch-freed, icmp-session-created, icmp-session-deleted, icmp-resource-allocated, icmp-resource-freed, icmpv6-session-created, icmpv6-session-deleted, icmpv6-resource-allocated, icmpv6-resource-freed, gre-session-created, gre-session-deleted, gre-resource-allocated, gre-resource-freed, esp-session-created, esp-session-deleted, esp-resource-allocated, esp-resource-freed, fixed-nat-user-ports, fixed-nat-disable-config-logged, fixed-nat-disable-config-logs-sent, fixed-nat-periodic-config-logs-sent, fixed-nat-periodic-config-logged, fixed-nat-interim-updated, enhanced-user-log, log-sent, log-dropped, conn-tcp-established, conn-tcp-dropped, tcp-port-overloading-allocated, tcp-port-overloading-freed, udp-port-overloading-allocated, udp-port-overloading-freed, http-request-logged, reduced-logs-by-destination, out-of-buffers, add-msg-failed, rtsp-port-allocated, rtsp-port-freed, conn-tcp-create-failed, ipv4-frag-applied, ipv4-frag-failed, ipv6-frag-applied, ipv6-frag-failed, interim-update-scheduled, interim-update-schedule-failed, interim-update-terminated, interim-update-memory-freed, interim-update-no-buff-retried, tcp-port-batch-interim-updated, udp-port-batch-interim-updated, port-block-accounting-freed, port-block-accounting-allocated, log-message-too-long, http-out-of-order-dropped, http-alloc-failed, http-frag-merge-failed-dropped, http-malloc, http-mfree, http-spm-alloc-type0, http-spm-alloc-type1, http-spm-alloc-type2, http-spm-alloc-type3, http-spm-alloc-type4, http-spm-free-type0, http-spm-free-type1, http-spm-free-type2, http-spm-free-type3, http-spm-free-type4, iddos-l3-entry-create, iddos-l3-entry-delete, iddos-l4-entry-create, iddos-l4-entry-delete

.. _328_nat-resource-exhausted:

nat-resource-exhausted
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **level**

        **Description** 'warning': Log level Warning; 'critical': Log level Critical (Default); 'notice': Log level Notice; 

        **Type:** string

        **Supported Values:** warning, critical, notice

        **Default:** critical

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters