.. _ddos_detection_agent_snmp:

ddos detection agent snmp
=========================

Configure DDoS detection agent snmp


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

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

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

	 **Element Name**                      snmp

	 **Element URI**                       /axapi/v3/ddos/detection/agent/{agent-name}/snmp

	 **Element Attributes**                snmp_attributes

	 **Partition Visibility**              shared,private

	 **Schema**                             :download:`snmp schema <ddos-detection-agent-snmp/ddos-detection-agent-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/ddos/detection/agent/{agent-name}/snmp



.. raw:: html

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


:ref:`677_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/ddos/detection/agent/{agent-name}/snmp



.. raw:: html

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


:ref:`677_snmp_attributes`



.. 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/ddos/detection/agent/{agent-name}/snmp



.. raw:: html

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


:ref:`677_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/ddos/detection/agent/{agent-name}/snmp



.. raw:: html

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


:ref:`677_snmp_attributes`



.. 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/ddos/detection/agent/{agent-name}/snmp



.. raw:: html

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


:ref:`677_snmp_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _677_snmp_attributes:

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

    **community-string**

        **Description** Configure agent's community-string for SNMP

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **ipv4-addr**

        **Description** Configure agent's IPv4 address for SNMP

        **Type:** string

        **Format:** ipv4-address

    **refresh**

        **Description** refresh SNMP information

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters