.. _slb_generic_proxy:

slb generic-proxy
=================

Configure Generic Proxy


generic-proxy Specification
---------------------------

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

	 **Element Name**                      generic-proxy

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

	 **Element Attributes**                generic-proxy_attributes

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

	 **Operational Data URI**              /axapi/v3/slb/generic-proxy/oper

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



.. raw:: html

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


:ref:`372_generic-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/generic-proxy



.. raw:: html

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


:ref:`372_generic-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/generic-proxy



.. raw:: html

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


:ref:`372_generic-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/generic-proxy



.. raw:: html

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


:ref:`372_generic-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/generic-proxy



.. raw:: html

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


:ref:`372_generic-proxy_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _372_generic-proxy_attributes:

generic-proxy attributes
------------------------

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _372_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - ccr_in
      - 8
      - Number of CCRs in

   *  - 
      - forward_unknown_session_id
      - 8
      - Forward server side message with unknown session id

   *  - 
      - svrsel_fail
      - 8
      - Number of server selection failed

   *  - 
      - curr
      - 8
      - Current

   *  - 
      - conn_closed_by_server
      - 8
      - Server initiates TCP close/reset

   *  - 
      - acr_out
      - 8
      - Number of ACRs out

   *  - 
      - dwr_in
      - 8
      - Number of DWRs in

   *  - 
      - cca_t
      - 8
      - Number of CCAs terminate

   *  - 
      - retry_client_request_fail
      - 8
      - Diameter retry client request fail

   *  - 
      - cca_in
      - 8
      - Number of CCAs in

   *  - 
      - num
      - 8
      - Number

   *  - 
      - no_route
      - 8
      - Number of no routes

   *  - 
      - conn_closed_by_client
      - 8
      - Client initiates TCP close/reset

   *  - 
      - server_fail
      - 8
      - Number of server failures

   *  - 
      - user_session
      - 8
      - Number of user sessions

   *  - 
      - dcmsg_fwd_in
      - 8
      - Diameter cross cpu fwd in

   *  - 
      - aca_out
      - 8
      - Number of ACAs out

   *  - 
      - sta_in
      - 8
      - Number of STAs in

   *  - 
      - total
      - 8
      - Total

   *  - 
      - dwa_in
      - 8
      - Number of DWAs in

   *  - 
      - no_session_id
      - 8
      - Diameter no session id avp

   *  - 
      - dwa_out
      - 8
      - Number of DWAs out

   *  - 
      - client_select_fail
      - 8
      - Fail to select client

   *  - 
      - asa_in
      - 8
      - Number of ASAs in

   *  - 
      - dcmsg_fwd_out
      - 8
      - Diameter cross cpu fwd out

   *  - 
      - reselect_fwd_tuple
      - 8
      - Original client tuple does not exist so reselect another one

   *  - 
      - retry_client_request
      - 8
      - Diameter retry client request

   *  - 
      - reply_unable_to_deliver
      - 8
      - Reply with unable to deliver error info

   *  - 
      - reselect_rev_tuple
      - 8
      - Original server tuple does not exist so reselect another one

   *  - 
      - dcmsg_error
      - 8
      - Diameter cross cpu error

   *  - 
      - asr_out
      - 8
      - Number of ASRs out

   *  - 
      - cca_out
      - 8
      - Number of CCAs out

   *  - 
      - update_latest_server
      - 8
      - Update to the latest server that used a session id

   *  - 
      - total_http_req_enter_gen
      - 8
      - Total number of HTTP requests enter generic proxy

   *  - 
      - aca_in
      - 8
      - Number of ACAs in

   *  - 
      - terminate_on_cca_t
      - 8
      - Diameter terminate on cca_t

   *  - 
      - unkwn_cmd_code
      - 8
      - Diameter unkown cmd code

   *  - 
      - dwr_out
      - 8
      - Number of DWRs out

   *  - 
      - dpa_out
      - 8
      - Number of DPAs out

   *  - 
      - invalid_avp
      - 8
      - AVP value contains illegal chars

   *  - 
      - other_out
      - 8
      - Number of other messages out

   *  - 
      - cea_out
      - 8
      - Number of CEAs out

   *  - 
      - dpr_in
      - 8
      - Number of DPRs in

   *  - 
      - asr_in
      - 8
      - Number of ASRs in

   *  - 
      - reply_error_info_fail
      - 8
      - Fail to reply error info to peer

   *  - 
      - no_fwd_tuple
      - 8
      - Diameter no fwd tuple matched

   *  - 
      - cer_in
      - 8
      - Number of CERs in

   *  - 
      - str_in
      - 8
      - Number of STRs in

   *  - 
      - sta_out
      - 8
      - Number of STAs out

   *  - 
      - snat_fail
      - 8
      - Number of snat failures

   *  - 
      - client_fail
      - 8
      - Number of client failures

   *  - 
      - cer_out
      - 8
      - Number of CERs out

   *  - 
      - str_out
      - 8
      - Number of STRs out

   *  - 
      - dcmsg_rev_in
      - 8
      - Diameter cross cpu rev in

   *  - 
      - ccr_t
      - 8
      - Number of CCRs terminate

   *  - 
      - ccr_u
      - 8
      - Number of CCRs update

   *  - 
      - cea_in
      - 8
      - Number of CEAs in

   *  - 
      - mismatch_fwd_id
      - 8
      - Diameter mismatch fwd session id

   *  - 
      - close_conn_when_vport_down
      - 8
      - Close client conn when virtual port is down

   *  - 
      - no_rev_tuple
      - 8
      - Diameter no rev tuple matched

   *  - 
      - mismatch_rev_id
      - 8
      - Diameter mismatch rev session id

   *  - 
      - reselect_fwd_tuple_other_cpu
      - 8
      - Original client tuple does not exist so reselect another one on other CPUs

   *  - 
      - asa_out
      - 8
      - Number of ASAs out

   *  - 
      - dcmsg_rev_out
      - 8
      - Diameter cross cpu rev out

   *  - 
      - no_sess
      - 8
      - Number of no sessions

   *  - 
      - dpa_in
      - 8
      - Number of DPAs in

   *  - 
      - reply_invalid_avp_value
      - 8
      - Reply with invalid AVP error info

   *  - 
      - reply_unknown_session_id
      - 8
      - Reply with unknown session ID error info

   *  - 
      - ccr_out
      - 8
      - Number of CCRs out

   *  - 
      - dpr_out
      - 8
      - Number of DPRs out

   *  - 
      - other_in
      - 8
      - Number of other messages in

   *  - 
      - ccr_i
      - 8
      - Number of CCRs initial

   *  - 
      - acr_in
      - 8
      - Number of ACRs in

.. _372_oper_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - generic-proxy-cpu-list
      - 
      - generic-proxy-cpu-list

   *  - 
      - cpu-count
      - number
      - cpu-count