.. _slb_health_stat:

slb health-stat
===============

Configure health monitor


health-stat Specification
-------------------------

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

	 **Element Name**                      health-stat

	 **Element URI**                       /axapi/v3/slb/health-stat

	 **Element Attributes**                health-stat_attributes

	 **Statistics Data URI**               /axapi/v3/slb/health-stat/stats

	 **Operational Data URI**              /axapi/v3/slb/health-stat/oper

	 **Schema**                             :download:`health-stat schema <slb-health-stat/slb-health-stat.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/slb/health-stat



.. raw:: html

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


:ref:`1667_health-stat_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/slb/health-stat



.. raw:: html

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


:ref:`1667_health-stat_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/slb/health-stat



.. raw:: html

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


:ref:`1667_health-stat_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/slb/health-stat



.. raw:: html

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


:ref:`1667_health-stat_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/slb/health-stat



.. raw:: html

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


:ref:`1667_health-stat_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1667_health-stat_attributes:

health-stat attributes
----------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1667_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'num_burst': Number of burst; 'max_jiffie': Maximum number of jiffies; 'min_jiffie': Minimum number of jiffies; 'avg_jiffie': Average number of jiffies; 'open_socket': Number of open sockets; 'open_socket_failed': Number of failed open sockets; 'close_socket': Number of closed sockets; 'connect_failed': Number of failed connections; 'send_packet': Number of packets sent; 'send_packet_failed': Number of packet send failures; 'recv_packet': Number of received packets; 'recv_packet_failed': Number of failed packet receives; 'retry_times': Retry times; 'timeout': Timouet value; 'unexpected_error': Number of unexpected errors; 'conn_imdt_succ': Number of connection immediete success; 'sock_close_before_17': Number of sockets closed before l7; 'sock_close_without_notify': Number of sockets closed without notify; 'curr_health_rate': Current health rate; 'ext_health_rate': External health rate; 'ext_health_rate_val': External health rate value; 'total_number': Total number; 'status_up': Number of status ups; 'status_down': Number of status downs; 'status_unkn': Number of status unknowns; 'status_other': Number of other status; 'running_time': Running time; 'config_health_rate': Config health rate; 'ssl_post_handshake_packet': Number of ssl post handshake packets before client sends request; 'timeout_with_packet': Number of pin timeouts while socket has packets; 

        **Type:** string

        **Supported Values:** all, num_burst, max_jiffie, min_jiffie, avg_jiffie, open_socket, open_socket_failed, close_socket, connect_failed, send_packet, send_packet_failed, recv_packet, recv_packet_failed, retry_times, timeout, unexpected_error, conn_imdt_succ, sock_close_before_17, sock_close_without_notify, curr_health_rate, ext_health_rate, ext_health_rate_val, total_number, status_up, status_down, status_unkn, status_other, running_time, config_health_rate, ssl_post_handshake_packet, timeout_with_packet

.. _1667_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - min_jiffie
      - 8
      - Minimum number of jiffies

   *  - 
      - connect_failed
      - 8
      - Number of failed connections

   *  - 
      - num_burst
      - 8
      - Number of burst

   *  - 
      - ext_health_rate_val
      - 8
      - External health rate value

   *  - 
      - retry_times
      - 8
      - Retry times

   *  - 
      - send_packet
      - 8
      - Number of packets sent

   *  - 
      - status_other
      - 8
      - Number of other status

   *  - 
      - unexpected_error
      - 8
      - Number of unexpected errors

   *  - 
      - config_health_rate
      - 8
      - Config health rate

   *  - 
      - ssl_post_handshake_packet
      - 8
      - Number of ssl post handshake packets before client sends request

   *  - 
      - status_down
      - 8
      - Number of status downs

   *  - 
      - recv_packet_failed
      - 8
      - Number of failed packet receives

   *  - 
      - close_socket
      - 8
      - Number of closed sockets

   *  - 
      - conn_imdt_succ
      - 8
      - Number of connection immediete success

   *  - 
      - recv_packet
      - 8
      - Number of received packets

   *  - 
      - curr_health_rate
      - 8
      - Current health rate

   *  - 
      - open_socket_failed
      - 8
      - Number of failed open sockets

   *  - 
      - send_packet_failed
      - 8
      - Number of packet send failures

   *  - 
      - sock_close_before_17
      - 8
      - Number of sockets closed before l7

   *  - 
      - timeout_with_packet
      - 8
      - Number of pin timeouts while socket has packets

   *  - 
      - total_number
      - 8
      - Total number

   *  - 
      - status_unkn
      - 8
      - Number of status unknowns

   *  - 
      - open_socket
      - 8
      - Number of open sockets

   *  - 
      - sock_close_without_notify
      - 8
      - Number of sockets closed without notify

   *  - 
      - status_up
      - 8
      - Number of status ups

   *  - 
      - running_time
      - 8
      - Running time

   *  - 
      - avg_jiffie
      - 8
      - Average number of jiffies

   *  - 
      - max_jiffie
      - 8
      - Maximum number of jiffies

   *  - 
      - ext_health_rate
      - 8
      - External health rate

   *  - 
      - timeout
      - 8
      - Timouet value

.. _1667_oper_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - num_pins_stat_down
      - number
      - num_pins_stat_down

   *  - 
      - num_pins_stat_unkn
      - number
      - num_pins_stat_unkn

   *  - 
      - num_pins_stat_up
      - number
      - num_pins_stat_up

   *  - 
      - monitor
      - string
      - monitor

   *  - 
      - num_pins_stat_else
      - number
      - num_pins_stat_else

   *  - 
      - num_pins
      - number
      - num_pins

   *  - 
      - clear_ssl_ticket
      - number
      - clear_ssl_ticket

   *  - 
      - method
      - enum
      -  Output contains one of the following values: - icmp, tcp, udp, http, ftp, snmp, smtp, dns, pop3, imap, sip, radius, ldap, rtsp, database, external, ntp, compound, https, kerberos-kdc, tacplus

   *  - 
      - health-check-list
      - 
      - health-check-list

   *  - 
      - num_ssl_tickets
      - number
      - num_ssl_tickets

   *  - 
      - total_stat
      - number
      - total_stat