.. _sshd:

sshd
====

SSHD service operation


sshd Specification
------------------

	===================================== =============================================
	 **Parameter**                         **Value** 

	===================================== =============================================
	 **Type**                              *operational*

	 **Element Name**                      sshd

	 **Element URI**                       /axapi/v3/sshd

	 **Element Attributes**                sshd_attributes

	 **Partition Visibility**              shared

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


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/sshd



.. raw:: html

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


:ref:`3128_sshd_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3128_sshd_attributes:

sshd attributes
---------------

    **file-url**

        **Description** File URL

        **Type:** string

        **Format:** url

    **generate**

        **Description** Generate SSH key

        **Type:** boolean

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

        **Default:** 0

    **load**

        **Description** Load SSH key

        **Type:** boolean

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

        **Default:** 0

    **re-add-rsa**

        **Description** remove ip address from known_hosts

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **regenerate**

        **Description** Wipe and generate SSH key

        **Type:** boolean

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

        **Default:** 0

    **restart**

        **Description** Restart SSH service

        **Type:** boolean

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

        **Default:** 0

    **size**

        **Description** '2048': Key size 2048bit; '4096': Key size 4096bit; 

        **Type:** string

        **Supported Values:** 2048, 4096

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0

    **wipe**

        **Description** Wipe SSH key

        **Type:** boolean

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

        **Default:** 0