.. _snmp_server_community_read:

snmp-server community read
==========================

Define a read only community string


read Specification
------------------

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

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

	 **Object Key(s)**                     *user*

	 **Collection Name**                   :ref:`3079_read_list`

	 **Collection URI**                    /axapi/v3/snmp-server/community/read

	                                       

	 **Element Name**                      read

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

	 **Element Attributes**                read_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3079_read_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_community_read_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/community/read



.. raw:: html

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


:ref:`3079_read_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/community/read/{user}



.. raw:: html

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


:ref:`3079_read_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_community_read_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/community/read



.. raw:: html

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


:ref:`3079_read_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/community/read/{user}



.. raw:: html

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


:ref:`3079_read_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/community/read/{user}



.. raw:: html

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


:ref:`3079_read_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_community_read_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/community/read



.. raw:: html

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


:ref:`3079_read_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/community/read/{user}



.. raw:: html

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


:ref:`3079_read_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_community_read_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3079_read_list:

read-list
---------


    read-list is **JSON List** of :ref:`3079_read_attributes` 

        read-list : [

             { :ref:`3079_read_attributes` },

             { :ref:`3079_read_attributes` },

             ...

         ]

.. _3079_read_attributes:

read attributes
---------------

    **oid-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/snmp-server/community/read/{user}/oid/{oid-val} <snmp_server_community_read>`

    **remote**

        **Description:** remote is a **JSON Block**.  Please see below for :ref:`3079_remote` 

        **Type:** Object

    **user**

        **Description** SNMPv1/v2c community string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 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

.. _3079_oid-list:

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

	 **Block object keys**             

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

    **oid-val**

        **Description** specific the oid (The oid value, object-key)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **remote**

        **Description:** remote is a **JSON Block**.  Please see below for :ref:`3079_oid-list_remote` 

        **Type:** Object

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

.. _3079_oid-list_remote:

oid-list_remote
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **host-list**

        **Type:** List

    **ipv4-list**

        **Type:** List

    **ipv6-list**

        **Type:** List

.. _3079_oid-list_remote_host-list:

oid-list_remote_host-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **dns-host**

        **Description** DNS remote host

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **ipv4-mask**

        **Description** IPV4 mask

        **Type:** string

        **Format:** ipv4-netmask

.. _3079_oid-list_remote_ipv4-list:

oid-list_remote_ipv4-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-host**

        **Description** IPV4 remote host

        **Type:** string

        **Format:** ipv4-address

    **ipv4-mask**

        **Description** IPV4 mask

        **Type:** string

        **Format:** ipv4-netmask

.. _3079_oid-list_remote_ipv6-list:

oid-list_remote_ipv6-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv6-host**

        **Description** IPV6 remote host

        **Type:** string

        **Format:** ipv6-address

    **ipv6-mask**

        **Description** IPV6 mask

        **Type:** number

        **Range:** 1-128

.. _3079_remote:

remote
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **host-list**

        **Type:** List

    **ipv4-list**

        **Type:** List

    **ipv6-list**

        **Type:** List

.. _3079_remote_host-list:

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

	 **Block object keys**             

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

    **dns-host**

        **Description** DNS remote host

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **ipv4-mask**

        **Description** IPV4 mask

        **Type:** string

        **Format:** ipv4-netmask

.. _3079_remote_ipv4-list:

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

	 **Block object keys**             

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

    **ipv4-host**

        **Description** IPV4 remote host

        **Type:** string

        **Format:** ipv4-address

    **ipv4-mask**

        **Description** IPV4 mask

        **Type:** string

        **Format:** ipv4-netmask

.. _3079_remote_ipv6-list:

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

	 **Block object keys**             

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

    **ipv6-host**

        **Description** IPV6 remote host

        **Type:** string

        **Format:** ipv6-address

    **ipv6-mask**

        **Description** IPV6 mask

        **Type:** number

        **Range:** 1-128