.. _slb_proxy:

slb proxy
=========

Configure Proxy Global


proxy Specification
-------------------

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

	 **Element Name**                      proxy

	 **Element URI**                       /axapi/v3/slb/proxy

	 **Element Attributes**                proxy_attributes

	 **Statistics Data URI**               /axapi/v3/slb/proxy/stats

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



.. raw:: html

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


:ref:`1711_proxy_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/proxy



.. raw:: html

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


:ref:`1711_proxy_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/proxy



.. raw:: html

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


:ref:`1711_proxy_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/proxy



.. raw:: html

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


:ref:`1711_proxy_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/proxy



.. raw:: html

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


:ref:`1711_proxy_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1711_proxy_attributes:

proxy attributes
----------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1711_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'num': Num; 'tcp_event': TCP stack event; 'est_event': Connection established; 'data_event': Data received; 'client_fin': Client FIN; 'server_fin': Server FIN; 'wbuf_event': Ready to send data; 'err_event': Error occured; 'no_mem': No memory; 'client_rst': Client RST; 'server_rst': Server RST; 'queue_depth_over_limit': Queue depth over limit; 'event_failed': Event failed; 'conn_not_exist': Conn not exist; 'service_alloc_cb': Service alloc callback; 'service_alloc_cb_failed': Service alloc callback failed; 'service_free_cb': Service free callback; 'service_free_cb_failed': Service free callback failed; 'est_cb_failed': App EST callback failed; 'data_cb_failed': App DATA callback failed; 'wbuf_cb_failed': App WBUF callback failed; 'err_cb_failed': App ERR callback failed; 'start_server_conn': Start server conn; 'start_server_conn_succ': Success; 'start_server_conn_no_route': No route to server; 'start_server_conn_fail_mem': No memory; 'start_server_conn_fail_snat': Failed Source NAT; 'start_server_conn_fail_persist': Fail Persistence; 'start_server_conn_fail_server': Fail Server issue; 'start_server_conn_fail_tuple': Fail Tuple Issue; 'line_too_long': Line too long; 

        **Type:** string

        **Supported Values:** all, num, tcp_event, est_event, data_event, client_fin, server_fin, wbuf_event, err_event, no_mem, client_rst, server_rst, queue_depth_over_limit, event_failed, conn_not_exist, service_alloc_cb, service_alloc_cb_failed, service_free_cb, service_free_cb_failed, est_cb_failed, data_cb_failed, wbuf_cb_failed, err_cb_failed, start_server_conn, start_server_conn_succ, start_server_conn_no_route, start_server_conn_fail_mem, start_server_conn_fail_snat, start_server_conn_fail_persist, start_server_conn_fail_server, start_server_conn_fail_tuple, line_too_long

.. _1711_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - start_server_conn
      - 8
      - Start server conn

   *  - 
      - service_alloc_cb
      - 8
      - Service alloc callback

   *  - 
      - start_server_conn_fail_tuple
      - 8
      - Fail Tuple Issue

   *  - 
      - client_rst
      - 8
      - Client RST

   *  - 
      - queue_depth_over_limit
      - 8
      - Queue depth over limit

   *  - 
      - start_server_conn_fail_mem
      - 8
      - No memory

   *  - 
      - start_server_conn_fail_server
      - 8
      - Fail Server issue

   *  - 
      - service_free_cb_failed
      - 8
      - Service free callback failed

   *  - 
      - est_event
      - 8
      - Connection established

   *  - 
      - service_free_cb
      - 8
      - Service free callback

   *  - 
      - data_cb_failed
      - 8
      - App DATA callback failed

   *  - 
      - wbuf_event
      - 8
      - Ready to send data

   *  - 
      - data_event
      - 8
      - Data received

   *  - 
      - service_alloc_cb_failed
      - 8
      - Service alloc callback failed

   *  - 
      - start_server_conn_fail_persist
      - 8
      - Fail Persistence

   *  - 
      - server_fin
      - 8
      - Server FIN

   *  - 
      - server_rst
      - 8
      - Server RST

   *  - 
      - start_server_conn_fail_snat
      - 8
      - Failed Source NAT

   *  - 
      - start_server_conn_no_route
      - 8
      - No route to server

   *  - 
      - tcp_event
      - 8
      - TCP stack event

   *  - 
      - no_mem
      - 8
      - No memory

   *  - 
      - event_failed
      - 8
      - Event failed

   *  - 
      - err_event
      - 8
      - Error occured

   *  - 
      - line_too_long
      - 8
      - Line too long

   *  - 
      - wbuf_cb_failed
      - 8
      - App WBUF callback failed

   *  - 
      - err_cb_failed
      - 8
      - App ERR callback failed

   *  - 
      - client_fin
      - 8
      - Client FIN

   *  - 
      - est_cb_failed
      - 8
      - App EST callback failed

   *  - 
      - start_server_conn_succ
      - 8
      - Success

   *  - 
      - conn_not_exist
      - 8
      - Conn not exist