.. _snmp_server_SNMPv3:

snmp-server SNMPv3
==================

Define a SNMPv3 user


SNMPv3 Specification
--------------------

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

	===================================== ===========================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      SNMPv3

	 **Element URI**                       /axapi/v3/snmp-server/SNMPv3

	 **Element Attributes**                SNMPv3_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/snmp-server/SNMPv3



.. raw:: html

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


SNMPv3_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _3120_SNMPv3_attributes:

SNMPv3 attributes
-----------------

    **user-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/snmp-server/SNMPv3/user/{username} <snmp_server_SNMPv3_user>`

.. _3120_user-list:

user-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **auth-val**

        **Description** 'md5': Use HMAC MD5 algorithm for authentication; 'sha': Use HMAC SHA algorithm for authentication; 'sha-512': Use HMAC SHA-512 algorithm for authentication; 'sha-384': Use HMAC SHA-384 algorithm for authentication; 'sha-256': Use HMAC SHA-256 algorithm for authentication; 'sha-224': Use HMAC SHA-224 algorithm for authentication; 

        **Type:** string

        **Supported Values:** md5, sha, sha-512, sha-384, sha-256, sha-224

    **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; 'aes-192': AES-192 encryption alogrithm; 'aes-256': AES-256 encryption alogrithm;  (Encryption type)

        **Type:** string

        **Supported Values:** des, aes, aes-192, aes-256

    **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