.. _gslb_template_snmp:

gslb template snmp
==================

Specify SNMP template


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

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

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

	 **Object Key(s)**                     *snmp-name*

	 **Collection Name**                   :ref:`1768_snmp_list`

	 **Collection URI**                    /axapi/v3/gslb/template/snmp

	                                       

	 **Element Name**                      snmp

	 **Element URI**                       /axapi/v3/gslb/template/snmp/{snmp-name}

	 **Element Attributes**                snmp_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`snmp schema <gslb-template-snmp/gslb-template-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/gslb/template/snmp



.. raw:: html

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


:ref:`1768_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/gslb_template_snmp_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/gslb/template/snmp



.. raw:: html

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


:ref:`1768_snmp_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/gslb/template/snmp/{snmp-name}



.. raw:: html

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


:ref:`1768_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/gslb_template_snmp_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/gslb/template/snmp



.. raw:: html

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


:ref:`1768_snmp_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/gslb/template/snmp/{snmp-name}



.. raw:: html

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


:ref:`1768_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/gslb/template/snmp/{snmp-name}



.. raw:: html

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


:ref:`1768_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/gslb_template_snmp_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/gslb/template/snmp



.. raw:: html

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


:ref:`1768_snmp_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/gslb/template/snmp/{snmp-name}



.. raw:: html

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


:ref:`1768_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/gslb_template_snmp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1768_snmp_list:

snmp-list
---------


    snmp-list is **JSON List** of :ref:`1768_snmp_attributes` 

        snmp-list : [

             { :ref:`1768_snmp_attributes` },

             { :ref:`1768_snmp_attributes` },

             ...

         ]

.. _1768_snmp_attributes:

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

    **auth-key**

        **Description** Specify authentication key (Specify key)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **auth-proto**

        **Description** 'sha': SHA; 'md5': MD5; 

        **Type:** string

        **Supported Values:** sha, md5

        **Default:** md5

    **community**

        **Description** Specify community for version 2c (Community name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **context-engine-id**

        **Description** Specify context engine ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **context-name**

        **Description** Specify context name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **host**

        **Description** Specify host (Host name or ip address)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **interface**

        **Description** Specify Interface ID

        **Type:** number

        **Range:** 0-2147483647

    **interval**

        **Description** Specify interval, default is 3 (Interval, unit: second, default is 3)

        **Type:** number

        **Range:** 1-999

        **Default:** 3

    **oid**

        **Description** Specify OID

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **port**

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

        **Type:** number

        **Range:** 1-65535

        **Default:** 161

    **priv-key**

        **Description** Specify privacy key (Specify key)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **priv-proto**

        **Description** 'aes': AES; 'des': DES; 

        **Type:** string

        **Supported Values:** aes, des

        **Default:** des

    **security-engine-id**

        **Description** Specify security engine ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **security-level**

        **Description** 'no-auth': No authentication; 'auth-no-priv': Authentication, but no privacy; 'auth-priv': Authentication and privacy; 

        **Type:** string

        **Supported Values:** no-auth, auth-no-priv, auth-priv

        **Default:** no-auth

    **snmp-name**

        **Description** Specify name of snmp template

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **username**

        **Description** Specify username (User name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **version**

        **Description** 'v1': Version 1; 'v2c': Version 2c; 'v3': Version 3; 

        **Type:** string

        **Supported Values:** v1, v2c, v3

        **Default:** v3