.. _snmp_server_community:

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

Deprecated SNMP community command


community Specification
-----------------------

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

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

	 **Element Name**                      community

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

	 **Element Attributes**                community_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


community_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _3080_community_attributes:

community attributes
--------------------

    **read-list**

        **Type:** List

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

.. _3080_read-list:

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

	 **Block object keys**             

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

    **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:`3080_read-list_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

.. _3080_read-list_oid-list:

read-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:`3080_read-list_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

.. _3080_read-list_oid-list_remote:

read-list_oid-list_remote
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **host-list**

        **Type:** List

    **ipv4-list**

        **Type:** List

    **ipv6-list**

        **Type:** List

.. _3080_read-list_oid-list_remote_host-list:

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

.. _3080_read-list_oid-list_remote_ipv4-list:

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

.. _3080_read-list_oid-list_remote_ipv6-list:

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

.. _3080_read-list_remote:

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

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

    **host-list**

        **Type:** List

    **ipv4-list**

        **Type:** List

    **ipv6-list**

        **Type:** List

.. _3080_read-list_remote_host-list:

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

.. _3080_read-list_remote_ipv4-list:

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

.. _3080_read-list_remote_ipv6-list:

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