.. _snmp_server_user:

snmp-server user
================

Deprecated SNMPv3 user command


user Specification
------------------

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

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

	 **Object Key(s)**                     *username*

	 **Collection Name**                   :ref:`3122_user_list`

	 **Collection URI**                    /axapi/v3/snmp-server/user

	                                       

	 **Element Name**                      user

	 **Element URI**                       /axapi/v3/snmp-server/user/{username}

	 **Element Attributes**                user_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`user schema <snmp-server-user/snmp-server-user.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/snmp-server/user



.. raw:: html

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


:ref:`3122_user_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/snmp_server_user_POST.txt
   :literal:




.. raw:: html

   </div></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/snmp-server/user



.. raw:: html

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


:ref:`3122_user_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/snmp-server/user/{username}



.. raw:: html

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


:ref:`3122_user_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/snmp_server_user_GET.txt
   :literal:




.. raw:: html

   </div></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/snmp-server/user



.. raw:: html

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


:ref:`3122_user_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/snmp-server/user/{username}



.. raw:: html

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


:ref:`3122_user_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/snmp-server/user/{username}



.. raw:: html

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


:ref:`3122_user_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/snmp_server_user_PUT.txt
   :literal:




.. raw:: html

   </div></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/snmp-server/user



.. raw:: html

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


:ref:`3122_user_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/snmp-server/user/{username}



.. raw:: html

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


:ref:`3122_user_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/snmp_server_user_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3122_user_list:

user-list
---------


    user-list is **JSON List** of :ref:`3122_user_attributes` 

        user-list : [

             { :ref:`3122_user_attributes` },

             { :ref:`3122_user_attributes` },

             ...

         ]

.. _3122_user_attributes:

user attributes
---------------

    **auth-val**

        **Description** 'md5': Use HMAC MD5 algorithm for authentication; 'sha': Use HMAC SHA algorithm for authentication; 

        **Type:** string

        **Supported Values:** md5, sha

    **encpasswd**

        **Description** Passphrase for encryption

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 8 characters

    **group**

        **Description** Group to which the user belongs

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **passwd**

        **Description** Password of this user

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 8 characters

    **priv**

        **Description** 'des': DES encryption alogrithm; 'aes': AES encryption alogrithm;  (Encryption type)

        **Type:** string

        **Supported Values:** des, aes

    **priv-pw-encrypted**

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

    **pw-encrypted**

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

    **username**

        **Description** Name of the user

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v3**

        **Description** 'auth': Using the authNoPriv Security Level; 'noauth': Using the noAuthNoPriv Security Level; 

        **Type:** string

        **Supported Values:** auth, noauth