.. _cgnv6_server_stats:

cgnv6 server stats
==================

Statistics for the object server


server Specification
--------------------

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

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

	 **Collection Name**                   :ref:`561_server_list`

	 **Collection URI**                    /axapi/v3/cgnv6/server/{name}

	                                       

	 **Element Name**                      server

	 **Element URI**                       /axapi/v3/cgnv6/server/{name}/stats

	 **Element Attributes**                server_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`server schema <cgnv6-server-stats/cgnv6-server-stats.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/server/{name}



.. raw:: html

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


:ref:`561_server_attributes`



.. raw:: html

   </td><td></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/cgnv6/server/{name}



.. raw:: html

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


:ref:`561_server_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/cgnv6/server/{name}/stats



.. raw:: html

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


:ref:`561_server_attributes`



.. raw:: html

   </td><td></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/cgnv6/server/{name}



.. raw:: html

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


:ref:`561_server_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/cgnv6/server/{name}/stats



.. raw:: html

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


:ref:`561_server_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/server/{name}/stats



.. raw:: html

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


:ref:`561_server_attributes`



.. raw:: html

   </td><td></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/cgnv6/server/{name}



.. raw:: html

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


:ref:`561_server_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/cgnv6/server/{name}/stats



.. raw:: html

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


:ref:`561_server_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _561_server_list:

server-list
-----------


    server-list is **JSON List** of :ref:`561_server_attributes` 

        server-list : [

             { :ref:`561_server_attributes` },

             { :ref:`561_server_attributes` },

             ...

         ]

.. _561_server_attributes:

server attributes
-----------------

    **name**

        **Description** Server Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **port-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol} <cgnv6_server>`

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`561_stats` 

        **Type:** Object

.. _561_port-list:

port-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **port-number**

        **Description** Port Number

        **Type:** number

        **Range:** 0-65534

    **protocol**

        **Description** 'tcp': TCP Port; 'udp': UDP Port; 

        **Type:** string

        **Supported Values:** tcp, udp

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`561_port-list_stats` 

        **Type:** Object

.. _561_port-list_stats:

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

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

    **curr_conn**

        **Description** Current connections

        **Type:** number

        **Format:** counter

    **curr_req**

        **Description** Current requests

        **Type:** number

        **Format:** counter

    **es_req_count**

        **Description** Total proxy request

        **Type:** number

        **Format:** counter

    **es_resp_200**

        **Description** Response status 200

        **Type:** number

        **Format:** counter

    **es_resp_300**

        **Description** Response status 300

        **Type:** number

        **Format:** counter

    **es_resp_400**

        **Description** Response status 400

        **Type:** number

        **Format:** counter

    **es_resp_500**

        **Description** Response status 500

        **Type:** number

        **Format:** counter

    **es_resp_count**

        **Description** Total proxy Response

        **Type:** number

        **Format:** counter

    **es_resp_invalid_http**

        **Description** Total non-http response

        **Type:** number

        **Format:** counter

    **es_resp_other**

        **Description** Response status other

        **Type:** number

        **Format:** counter

    **fastest_rsp_time**

        **Description** Fastest response time

        **Type:** number

        **Format:** counter

    **last_total_conn**

        **Description** Last total connections

        **Type:** number

        **Format:** counter

    **peak_conn**

        **Description** Peak connections

        **Type:** number

        **Format:** counter

    **response_time**

        **Description** Response time

        **Type:** number

        **Format:** counter

    **slowest_rsp_time**

        **Description** Slowest response time

        **Type:** number

        **Format:** counter

    **total_conn**

        **Description** Total connections

        **Type:** number

        **Format:** counter

    **total_fwd_bytes**

        **Description** Forward bytes

        **Type:** number

        **Format:** counter

    **total_fwd_pkts**

        **Description** Forward packets

        **Type:** number

        **Format:** counter

    **total_req**

        **Description** Total requests

        **Type:** number

        **Format:** counter

    **total_req_succ**

        **Description** Total request success

        **Type:** number

        **Format:** counter

    **total_rev_bytes**

        **Description** Reverse bytes

        **Type:** number

        **Format:** counter

    **total_rev_pkts**

        **Description** Reverse packets

        **Type:** number

        **Format:** counter

    **total_rev_pkts_inspected**

        **Description** Total reverse packets inspected

        **Type:** number

        **Format:** counter

    **total_rev_pkts_inspected_good_status_code**

        **Description** Total reverse packets with good status code inspected

        **Type:** number

        **Format:** counter

.. _561_stats:

stats
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **curr-conn**

        **Description** Current connections

        **Type:** number

        **Format:** counter

    **fwd-pkt**

        **Description** Forward packets

        **Type:** number

        **Format:** counter

    **peak-conn**

        **Description** Peak connections

        **Type:** number

        **Format:** counter

    **rev-pkt**

        **Description** Reverse Packets

        **Type:** number

        **Format:** counter

    **total-conn**

        **Description** Total connections

        **Type:** number

        **Format:** counter