.. _slb_ftp_proxy:

slb ftp-proxy
=============

Configure FTP Proxy global


ftp-proxy Specification
-----------------------

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

	 **Element Name**                      ftp-proxy

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

	 **Element Attributes**                ftp-proxy_attributes

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

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

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



.. raw:: html

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


:ref:`1657_ftp-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/ftp-proxy



.. raw:: html

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


:ref:`1657_ftp-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/ftp-proxy



.. raw:: html

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


:ref:`1657_ftp-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/ftp-proxy



.. raw:: html

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


:ref:`1657_ftp-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/ftp-proxy



.. raw:: html

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


:ref:`1657_ftp-proxy_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1657_ftp-proxy_attributes:

ftp-proxy attributes
--------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1657_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'num': Num; 'curr': Current proxy conns; 'total': Total proxy conns; 'svrsel_fail': Server selection failure; 'no_route': no route failure; 'snat_fail': source nat failure; 'feat': feat packet; 'cc': clear ctrl port packet; 'data_ssl': data ssl force; 'line_too_long': line too long; 'line_mem_freed': request line freed; 'invalid_start_line': invalid start line; 'auth_tls': auth tls cmd; 'prot': prot cmd; 'pbsz': pbsz cmd; 'pasv': pasv cmd; 'port': port cmd; 'request_dont_care': other cmd; 'client_auth_tls': client auth tls; 'cant_find_pasv': cant find pasv; 'pasv_addr_ne_server': psv addr not equal to svr; 'smp_create_fail': smp create fail; 'data_server_conn_fail': data svr conn fail; 'data_send_fail': data send fail; 'epsv': epsv command; 'cant_find_epsv': cant find epsv; 'data_curr': Current Data Proxy; 'data_total': Total Data Proxy; 'auth_unsupported': Unsupported auth; 'adat': adat cmd; 'unsupported_pbsz_value': Unsupported PBSZ; 'unsupported_prot_value': Unsupported PROT; 'unsupported_command': Unsupported cmd; 'control_to_clear': Control chn clear txt; 'control_to_ssl': Control chn ssl; 'bad_sequence': Bad Sequence; 'rsv_persist_conn_fail': Serv Sel Persist fail; 'smp_v6_fail': Serv Sel SMPv6 fail; 'smp_v4_fail': Serv Sel SMPv4 fail; 'insert_tuple_fail': Serv Sel insert tuple fail; 'cl_est_err': Client EST state erro; 'ser_connecting_err': Serv CTNG state error; 'server_response_err': Serv RESP state error; 'cl_request_err': Client RQ state error; 'data_conn_start_err': Data Start state error; 'data_serv_connecting_err': Data Serv CTNG error; 'data_serv_connected_err': Data Serv CTED error; 'request': Total FTP Request; 'auth_req': Auth Request; 'auth_succ': Auth Success; 'auth_fail': Auth Failure; 'fwd_to_internet': Forward to Internet; 'fwd_to_sg': Total Forward to Service-group; 'drop': Total FTP Drop; 'ds_succ': Host Domain Name is resolved; 'ds_fail': Host Domain Name isn't resolved; 'open': open cmd; 'site': site cmd; 'user': user cmd; 'pass': pass cmd; 'quit': quit cmd; 'eprt': eprt cmd; 'cant_find_port': cant find port; 'cant_find_eprt': cant find eprt; 

        **Type:** string

        **Supported Values:** all, num, curr, total, svrsel_fail, no_route, snat_fail, feat, cc, data_ssl, line_too_long, line_mem_freed, invalid_start_line, auth_tls, prot, pbsz, pasv, port, request_dont_care, client_auth_tls, cant_find_pasv, pasv_addr_ne_server, smp_create_fail, data_server_conn_fail, data_send_fail, epsv, cant_find_epsv, data_curr, data_total, auth_unsupported, adat, unsupported_pbsz_value, unsupported_prot_value, unsupported_command, control_to_clear, control_to_ssl, bad_sequence, rsv_persist_conn_fail, smp_v6_fail, smp_v4_fail, insert_tuple_fail, cl_est_err, ser_connecting_err, server_response_err, cl_request_err, data_conn_start_err, data_serv_connecting_err, data_serv_connected_err, request, auth_req, auth_succ, auth_fail, fwd_to_internet, fwd_to_sg, drop, ds_succ, ds_fail, open, site, user, pass, quit, eprt, cant_find_port, cant_find_eprt

.. _1657_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - fwd_to_internet
      - 8
      - Forward to Internet

   *  - 
      - ser_connecting_err
      - 8
      - Serv CTNG state error

   *  - 
      - svrsel_fail
      - 8
      - Server selection failure

   *  - 
      - curr
      - 8
      - Current proxy conns

   *  - 
      - unsupported_prot_value
      - 8
      - Unsupported PROT

   *  - 
      - cc
      - 8
      - clear ctrl port packet

   *  - 
      - request
      - 8
      - Total FTP Request

   *  - 
      - server_response_err
      - 8
      - Serv RESP state error

   *  - 
      - pass
      - 8
      - pass cmd

   *  - 
      - unsupported_pbsz_value
      - 8
      - Unsupported PBSZ

   *  - 
      - cant_find_pasv
      - 8
      - cant find pasv

   *  - 
      - cant_find_port
      - 8
      - cant find port

   *  - 
      - pbsz
      - 8
      - pbsz cmd

   *  - 
      - pasv
      - 8
      - pasv cmd

   *  - 
      - smp_v4_fail
      - 8
      - Serv Sel SMPv4 fail

   *  - 
      - no_route
      - 8
      - no route failure

   *  - 
      - total
      - 8
      - Total proxy conns

   *  - 
      - feat
      - 8
      - feat packet

   *  - 
      - port
      - 8
      - port cmd

   *  - 
      - data_total
      - 8
      - Total Data Proxy

   *  - 
      - auth_tls
      - 8
      - auth tls cmd

   *  - 
      - quit
      - 8
      - quit cmd

   *  - 
      - request_dont_care
      - 8
      - other cmd

   *  - 
      - cl_est_err
      - 8
      - Client EST state erro

   *  - 
      - open
      - 8
      - open cmd

   *  - 
      - cl_request_err
      - 8
      - Client RQ state error

   *  - 
      - prot
      - 8
      - prot cmd

   *  - 
      - auth_fail
      - 8
      - Auth Failure

   *  - 
      - insert_tuple_fail
      - 8
      - Serv Sel insert tuple fail

   *  - 
      - line_mem_freed
      - 8
      - request line freed

   *  - 
      - ds_succ
      - 8
      - Host Domain Name is resolved

   *  - 
      - invalid_start_line
      - 8
      - invalid start line

   *  - 
      - epsv
      - 8
      - epsv command

   *  - 
      - rsv_persist_conn_fail
      - 8
      - Serv Sel Persist fail

   *  - 
      - cant_find_eprt
      - 8
      - cant find eprt

   *  - 
      - control_to_ssl
      - 8
      - Control chn ssl

   *  - 
      - cant_find_epsv
      - 8
      - cant find epsv

   *  - 
      - fwd_to_sg
      - 8
      - Total Forward to Service-group

   *  - 
      - user
      - 8
      - user cmd

   *  - 
      - smp_v6_fail
      - 8
      - Serv Sel SMPv6 fail

   *  - 
      - data_curr
      - 8
      - Current Data Proxy

   *  - 
      - site
      - 8
      - site cmd

   *  - 
      - auth_succ
      - 8
      - Auth Success

   *  - 
      - snat_fail
      - 8
      - source nat failure

   *  - 
      - data_ssl
      - 8
      - data ssl force

   *  - 
      - auth_req
      - 8
      - Auth Request

   *  - 
      - data_serv_connecting_err
      - 8
      - Data Serv CTNG error

   *  - 
      - auth_unsupported
      - 8
      - Unsupported auth

   *  - 
      - pasv_addr_ne_server
      - 8
      - psv addr not equal to svr

   *  - 
      - smp_create_fail
      - 8
      - smp create fail

   *  - 
      - control_to_clear
      - 8
      - Control chn clear txt

   *  - 
      - line_too_long
      - 8
      - line too long

   *  - 
      - data_serv_connected_err
      - 8
      - Data Serv CTED error

   *  - 
      - client_auth_tls
      - 8
      - client auth tls

   *  - 
      - adat
      - 8
      - adat cmd

   *  - 
      - bad_sequence
      - 8
      - Bad Sequence

   *  - 
      - unsupported_command
      - 8
      - Unsupported cmd

   *  - 
      - data_send_fail
      - 8
      - data send fail

   *  - 
      - data_conn_start_err
      - 8
      - Data Start state error

   *  - 
      - drop
      - 8
      - Total FTP Drop

   *  - 
      - data_server_conn_fail
      - 8
      - data svr conn fail

   *  - 
      - eprt
      - 8
      - eprt cmd

   *  - 
      - ds_fail
      - 8
      - Host Domain Name isn't resolved

.. _1657_oper_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

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

   *  - 
      - ftp-proxy-cpu-list
      - 
      - ftp-proxy-cpu-list