.. _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:`387_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:`387_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:`387_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:`387_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:`387_so-counters_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _387_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

.. _387_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_conn_nat_sync': Total NAT connection syncs; 'so_pkts_conn_xparent_fw_sync': Total Xparent FW connection syncs; 'so_pkts_redirect_conn_aged_out': Total redirect conns aged out; 'so_pkts_traffic_map_not_found_drop': Traffic MAP Not Found Drop; 'so_pkts_scaleout_not_active_drop': Scaleout Not Active Drop; 'so_pkts_dest_mac_mistmatch_drop': Destination MAC Mistmatch Drop; 'so_pkts_l2redirect_interface_not_up': L2redirect Intf is not UP; 'so_pkts_redirect_table_error': Redirect Table Error; 'so_pkts_mac_zero_drop': MAC Address zero Drop; 'so_pkts_l3_redirect_encap_error_drop': L3 Redirect encap error Drop; 'so_pkts_l3_redirect_inner_mac_zero_drop': L3 Redirect inner mac zero Drop; 'so_pkts_l3_redirect_decap_vlan_sanity_drop': L3 Redirect Decap VLAN Sanity Drop; 'so_pkts_l3_redirect_inner_ip_frag_req': L3 Redirect Inner ipv4 fragmentation, punt slowpath; 'so_pkts_l3_redirect_inner_ipv6_frag_req': L3 Redirect Inner ipv6 fragmentation, punt slowpath; 'so_pkts_l3_redirect_rx_pkts_in': Total number of L3 Redirected packets received; 'so_pkts_l3_redirect_decap_non_ipv4_vxlan_drop': L3 Redirect received non ipv4 VXLAN packet; 'so_pkts_l3_redirect_decap_rx_encap_params_drop': L3 Redirect decap Rx encap params error Drop; 'so_pkts_l3_redirect_table_error': L3 Redirect Table error Drop; 'so_pkts_l3_redirect_rcvd_in_l2_mode_drop': Recevied l3 redirect packets in L2 mode Drop; 'so_pkts_l3_redirect_encap_df_bit_set': L3 redirect encap DF bit set; 'so_pkts_l3_redirect_fragmentation_error': L3 redirect encap Fragmentation error; 'so_pkts_l3_redirect_internal_buffer_alloc_error': L3 redirect encap Internal buffer allocation error; 'so_pkts_l3_redirect_table_no_entry_found': L3 redirect Table no redirect entry found error; 'so_pkts_l3_redirect_follow_shared_table_error': L3 Redirect Follow Shared Table error Drop; 'so_pkts_l3_redirect_invalid_dev_dir': L3 Redirect Invalid Device direction; 'so_pkts_l3_redirect_chassis_dest_mac_error': L3 Redirect Chassis Destination Mac Error; 'so_pkts_fw_internal_rule_update_error': FW internal rule update Error; 'so_pkts_l3_redirect_encap_ip_jumbo_frag_drop': L3 Redirect ipv4 packet after encap more than max jumbo size; 'so_pkts_l3_redirect_encap_ipv6_jumbo_frag_drop': L3 Redirect ipv6 packet after encap more than max jumbo size; 'so_pkts_l3_redirect_too_large_pkts_in_drop': Received L3 Redirected fragmented packets too large; 'so_fw_internal_rule_count': FW internal rule count; 

        **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_pkts_redirect_table_error, so_pkts_mac_zero_drop, so_pkts_l3_redirect_encap_error_drop, so_pkts_l3_redirect_inner_mac_zero_drop, so_pkts_l3_redirect_decap_vlan_sanity_drop, so_pkts_l3_redirect_inner_ip_frag_req, so_pkts_l3_redirect_inner_ipv6_frag_req, so_pkts_l3_redirect_rx_pkts_in, so_pkts_l3_redirect_decap_non_ipv4_vxlan_drop, so_pkts_l3_redirect_decap_rx_encap_params_drop, so_pkts_l3_redirect_table_error, so_pkts_l3_redirect_rcvd_in_l2_mode_drop, so_pkts_l3_redirect_encap_df_bit_set, so_pkts_l3_redirect_fragmentation_error, so_pkts_l3_redirect_internal_buffer_alloc_error, so_pkts_l3_redirect_table_no_entry_found, so_pkts_l3_redirect_follow_shared_table_error, so_pkts_l3_redirect_invalid_dev_dir, so_pkts_l3_redirect_chassis_dest_mac_error, so_pkts_fw_internal_rule_update_error, so_pkts_l3_redirect_encap_ip_jumbo_frag_drop, so_pkts_l3_redirect_encap_ipv6_jumbo_frag_drop, so_pkts_l3_redirect_too_large_pkts_in_drop, so_sync_fw_shadow_session_create, so_fw_shadow_session_created, so_sync_fw_shadow_ext, so_sync_shadow_stats, so_sync_fw_shadow_session_delete, so_fw_create_shadow_flag, so_fw_internal_rule_count

.. _387_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_l3_redirect_encap_error_drop
      - 8
      - L3 Redirect encap error Drop

   *  - 
      - so_fw_shadow_session_created
      - 8
      - FW Shadow Session created

   *  - 
      - so_pkts_l3_redirect_inner_ipv6_frag_req
      - 8
      - L3 Redirect Inner ipv6 fragmentation, punt slowpath

   *  - 
      - so_pkts_l3_redirect_inner_mac_zero_drop
      - 8
      - L3 Redirect inner mac zero Drop

   *  - 
      - so_pkts_l3_redirect_encap_df_bit_set
      - 8
      - L3 redirect encap DF bit set

   *  - 
      - so_pkts_l3_redirect_invalid_dev_dir
      - 8
      - L3 Redirect Invalid Device direction

   *  - 
      - so_pkts_l3_redirect_follow_shared_table_error
      - 8
      - L3 Redirect Follow Shared Table error Drop

   *  - 
      - so_pkts_dropped
      - 8
      - Total packets dropped

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

   *  - 
      - so_pkts_l3_redirect_rx_pkts_in
      - 8
      - Total number of L3 Redirected packets received

   *  - 
      - so_pkts_l3_redirect_decap_rx_encap_params_drop
      - 8
      - L3 Redirect decap Rx encap params error Drop

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

   *  - 
      - so_pkts_errors
      - 8
      - Total packet errors

   *  - 
      - so_pkts_l3_redirect_decap_non_ipv4_vxlan_drop
      - 8
      - L3 Redirect received non ipv4 VXLAN packet

   *  - 
      - 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_pkts_l3_redirect_decap_vlan_sanity_drop
      - 8
      - L3 Redirect Decap VLAN Sanity Drop

   *  - 
      - 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_sync_fw_shadow_session_create
      - 8
      - Sent Sync message for FW Shadow session creation

   *  - 
      - 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_l3_redirect_encap_ipv6_jumbo_frag_drop
      - 8
      - L3 Redirect ipv6 packet after encap more than max jumbo size

   *  - 
      - so_sync_fw_shadow_ext
      - 8
      - Sync FW Shadow extension creation/updation

   *  - 
      - so_pkts_out
      - 8
      - Total packets sent out

   *  - 
      - so_pkts_l3_redirect_internal_buffer_alloc_error
      - 8
      - L3 redirect encap Internal buffer allocation error

   *  - 
      - so_pkts_l3_redirect_table_error
      - 8
      - L3 Redirect Table error Drop

   *  - 
      - so_pkts_fw_internal_rule_update_error
      - 8
      - FW internal rule update Error

   *  - 
      - so_pkts_l3_redirect_fragmentation_error
      - 8
      - L3 redirect encap Fragmentation error

   *  - 
      - so_pkts_l3_redirect_table_no_entry_found
      - 8
      - L3 redirect Table no redirect entry found error

   *  - 
      - so_pkts_l3_redirect_inner_ip_frag_req
      - 8
      - L3 Redirect Inner ipv4 fragmentation, punt slowpath

   *  - 
      - so_pkts_l3_redirect_chassis_dest_mac_error
      - 8
      - L3 Redirect Chassis Destination Mac Error

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

   *  - 
      - so_pkts_nat_release_fail
      - 8
      - Total NAT release failures

   *  - 
      - so_sync_shadow_stats
      - 8
      - Sync Shadow session stats from shadow to active

   *  - 
      - so_pkts_l3_redirect_rcvd_in_l2_mode_drop
      - 8
      - Recevied l3 redirect packets in L2 mode Drop

   *  - 
      - so_pkts_l3_redirect_encap_ip_jumbo_frag_drop
      - 8
      - L3 Redirect ipv4 packet after encap more than max jumbo size

   *  - 
      - so_pkts_l3_redirect_too_large_pkts_in_drop
      - 8
      - Received L3 Redirected fragmented packets too large

   *  - 
      - so_sync_fw_shadow_session_delete
      - 8
      - Sent Sync message for FW Shadow session deletion

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

   *  - 
      - so_pkts_conn_l4_sync
      - 8
      - Total L4 connection syncs