.. _slb_template_client_ssh:

slb template client-ssh
=======================

Client Side SSH Template


client-ssh Specification
------------------------

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`1778_client-ssh_list`

	 **Collection URI**                    /axapi/v3/slb/template/client-ssh

	                                       

	 **Element Name**                      client-ssh

	 **Element URI**                       /axapi/v3/slb/template/client-ssh/{name}

	 **Element Attributes**                client-ssh_attributes

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



.. raw:: html

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


:ref:`1778_client-ssh_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/slb/template/client-ssh



.. raw:: html

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


:ref:`1778_client-ssh_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/template/client-ssh/{name}



.. raw:: html

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


:ref:`1778_client-ssh_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/slb/template/client-ssh



.. raw:: html

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


:ref:`1778_client-ssh_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/slb/template/client-ssh/{name}



.. raw:: html

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


:ref:`1778_client-ssh_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/template/client-ssh/{name}



.. raw:: html

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


:ref:`1778_client-ssh_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/slb/template/client-ssh



.. raw:: html

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


:ref:`1778_client-ssh_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/slb/template/client-ssh/{name}



.. raw:: html

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


:ref:`1778_client-ssh_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1778_client-ssh_list:

client-ssh-list
---------------


    client-ssh-list is **JSON List** of :ref:`1778_client-ssh_attributes` 

        client-ssh-list : [

             { :ref:`1778_client-ssh_attributes` },

             { :ref:`1778_client-ssh_attributes` },

             ...

         ]

.. _1778_client-ssh_attributes:

client-ssh attributes
---------------------

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **forward-proxy-enable**

        **Description** Enable SSH forward proxy

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **forward-proxy-hostkey**

        **Description** Specify private-key (Key Name)

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **name**

        **Description** Client SSH Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **passphrase**

        **Description** Password Phrase

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1778_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - forwarding_errors
      - 8
      - some help string

   *  - 
      - successful_handshakes
      - 8
      - some help string

   *  - 
      - failed_handshakes
      - 8
      - some help string