.. _snmp_server_community_read_oid:

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

Define a remote entity to which user belongs


oid Specification
-----------------

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

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

	 **Object Key(s)**                     *oid-val*

	 **Collection Name**                   :ref:`3078_oid_list`

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

	                                       

	 **Element Name**                      oid

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

	 **Element Attributes**                oid_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3078_oid_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/snmp-server/community/read/{user}/oid



.. raw:: html

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


:ref:`3078_oid_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}/oid/{oid-val}



.. raw:: html

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


:ref:`3078_oid_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/snmp-server/community/read/{user}/oid



.. raw:: html

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


:ref:`3078_oid_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}/oid/{oid-val}



.. raw:: html

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


:ref:`3078_oid_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}/oid/{oid-val}



.. raw:: html

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


:ref:`3078_oid_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/snmp-server/community/read/{user}/oid



.. raw:: html

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


:ref:`3078_oid_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}/oid/{oid-val}



.. raw:: html

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


:ref:`3078_oid_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3078_oid_list:

oid-list
--------


    oid-list is **JSON List** of :ref:`3078_oid_attributes` 

        oid-list : [

             { :ref:`3078_oid_attributes` },

             { :ref:`3078_oid_attributes` },

             ...

         ]

.. _3078_oid_attributes:

oid attributes
--------------

    **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:`3078_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

.. _3078_remote:

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

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

    **host-list**

        **Type:** List

    **ipv4-list**

        **Type:** List

    **ipv6-list**

        **Type:** List

.. _3078_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

.. _3078_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

.. _3078_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