.. _so_counters:

so-counters
===========

Show scaleout statistics


so-counters Specification
-------------------------

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

	 **Element Name**                      so-counters

	 **Element URI**                       /axapi/v3/so-counters

	 **Element Attributes**                so-counters_attributes

	 **Statistics Data URI**               /axapi/v3/so-counters/stats

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



.. raw:: html

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


:ref:`1519_so-counters_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/so-counters



.. raw:: html

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


:ref:`1519_so-counters_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/so-counters



.. raw:: html

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


:ref:`1519_so-counters_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/so-counters



.. raw:: html

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


:ref:`1519_so-counters_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/so-counters



.. raw:: html

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


:ref:`1519_so-counters_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1519_so-counters_attributes:

so-counters attributes
----------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1519_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'so_pkts_conn_in': Total packets processed for an established connection; 'so_pkts_conn_redirect': Total packets redirected for an established connection; 'so_pkts_dropped': Total packets dropped; 'so_pkts_errors': Total packet errors; 'so_pkts_in': Total packets in-coming; 'so_pkts_new_conn_in': Total packets processed for a new connection; 'so_pkts_new_conn_redirect': Total packets redirected for a new connection; 'so_pkts_out': Total packets sent out; 'so_pkts_redirect': Total packets redirected; 'so_pkts_conn_sync_fail': Total connection sync failures; 'so_pkts_nat_reserve_fail': Total NAT reserve failures; 'so_pkts_nat_release_fail': Total NAT release failures; 'so_pkts_conn_l7_sync': Total L7 connection syncs; 'so_pkts_conn_l4_sync': Total L4 connection syncs; 'so_pkts_redirect_conn_aged_out': Total redirect conns aged out; 

        **Type:** string

        **Supported Values:** all, so_pkts_conn_in, so_pkts_conn_redirect, so_pkts_dropped, so_pkts_errors, so_pkts_in, so_pkts_new_conn_in, so_pkts_new_conn_redirect, so_pkts_out, so_pkts_redirect, so_pkts_conn_sync_fail, so_pkts_nat_reserve_fail, so_pkts_nat_release_fail, so_pkts_conn_l7_sync, so_pkts_conn_l4_sync, so_pkts_conn_nat_sync, so_pkts_conn_xparent_fw_sync, so_pkts_redirect_conn_aged_out, so_pkts_traffic_map_not_found_drop, so_pkts_scaleout_not_active_drop, so_pkts_dest_mac_mistmatch_drop, so_pkts_l2redirect_interface_not_up, so_fw_internal_rule_count, so_pkts_redirect_table_error, so_pkts_mac_zero_drop

.. _1519_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - so_pkts_conn_l7_sync
      - 8
      - Total L7 connection syncs

   *  - 
      - so_pkts_traffic_map_not_found_drop
      - 8
      - Traffic MAP Not Found Drop

   *  - 
      - so_pkts_dropped
      - 8
      - Total packets dropped

   *  - 
      - so_pkts_conn_xparent_fw_sync
      - 8
      - Total Xparent FW connection syncs

   *  - 
      - so_pkts_in
      - 8
      - Total packets in-coming

   *  - 
      - so_pkts_errors
      - 8
      - Total packet errors

   *  - 
      - so_pkts_conn_sync_fail
      - 8
      - Total connection sync failures

   *  - 
      - so_pkts_redirect_table_error
      - 8
      - Redirect Table Error

   *  - 
      - so_pkts_conn_nat_sync
      - 8
      - Total NAT connection syncs

   *  - 
      - so_fw_internal_rule_count
      - 8
      - FW internal rule count

   *  - 
      - so_pkts_dest_mac_mistmatch_drop
      - 8
      - Destination MAC Mistmatch Drop

   *  - 
      - so_pkts_l2redirect_interface_not_up
      - 8
      - L2redirect Intf is not UP

   *  - 
      - so_pkts_conn_in
      - 8
      - Total packets processed for an established connection

   *  - 
      - so_pkts_scaleout_not_active_drop
      - 8
      - Scaleout Not Active Drop

   *  - 
      - so_pkts_conn_redirect
      - 8
      - Total packets redirected for an established connection

   *  - 
      - so_pkts_redirect_conn_aged_out
      - 8
      - Total redirect conns aged out

   *  - 
      - so_pkts_nat_reserve_fail
      - 8
      - Total NAT reserve failures

   *  - 
      - so_pkts_redirect
      - 8
      - Total packets redirected

   *  - 
      - so_pkts_mac_zero_drop
      - 8
      - MAC Address zero Drop

   *  - 
      - so_pkts_out
      - 8
      - Total packets sent out

   *  - 
      - so_pkts_new_conn_in
      - 8
      - Total packets processed for a new connection

   *  - 
      - so_pkts_nat_release_fail
      - 8
      - Total NAT release failures

   *  - 
      - so_pkts_new_conn_redirect
      - 8
      - Total packets redirected for a new connection

   *  - 
      - so_pkts_conn_l4_sync
      - 8
      - Total L4 connection syncs