.. _health_monitor_method_snmp:

health monitor method snmp
==========================

SNMP type


snmp Specification
------------------

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

	===================================== ==========================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      snmp

	 **Element URI**                       /axapi/v3/health/monitor/{name}/method/snmp

	 **Element Attributes**                snmp_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`snmp schema <health-monitor-method-snmp/health-monitor-method-snmp.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/health/monitor/{name}/method/snmp



.. raw:: html

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


:ref:`1852_snmp_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/health_monitor_method_snmp_POST.txt
   :literal:




.. raw:: html

   </div></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/health/monitor/{name}/method/snmp



.. raw:: html

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


:ref:`1852_snmp_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/health_monitor_method_snmp_GET.txt
   :literal:




.. raw:: html

   </div></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/health/monitor/{name}/method/snmp



.. raw:: html

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


:ref:`1852_snmp_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/health/monitor/{name}/method/snmp



.. raw:: html

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


:ref:`1852_snmp_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/health_monitor_method_snmp_PUT.txt
   :literal:




.. raw:: html

   </div></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/health/monitor/{name}/method/snmp



.. raw:: html

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


:ref:`1852_snmp_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/health_monitor_method_snmp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1852_snmp_attributes:

snmp attributes
---------------

    **community**

        **Description** Specify SNMP community, default is "public" (Community String)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

        **Default:** public

    **oid**

        **Description:** oid is a **JSON Block**.  Please see below for :ref:`1852_oid` 

        **Type:** Object

    **operation**

        **Description:** operation is a **JSON Block**.  Please see below for :ref:`1852_operation` 

        **Type:** Object

    **snmp**

        **Description** SNMP type

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **snmp-port**

        **Description** Specify SNMP port, default is 161 (Port Number)

        **Type:** number

        **Range:** 1-65534

        **Default:** 161

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1852_oid:

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

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

    **asn**

        **Description** Specify the format in ASN.1 style

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** asn and mib are mutually exclusive

    **mib**

        **Description** 'sysDescr': The MIB-2 OID of system description, 1.1.0; 'sysUpTime': The MIB-2 OID of system up time, 1.3.0; 'sysName': The MIB-2 OID of system nume, 1.5.0; 

        **Type:** string

        **Supported Values:** sysDescr, sysUpTime, sysName

        **Mutual Exclusion:** mib and asn are mutually exclusive

.. _1852_operation:

operation
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper-type**

        **Description** 'getnext': Get-Next-Request command; 'get': Get-Request command; 

        **Type:** string

        **Supported Values:** getnext, get