.. _visibility_port_scan_detection:

visibility port-scan-detection
==============================

Configure port scan detection


port-scan-detection Specification
---------------------------------

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

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

	 **Element Name**                      port-scan-detection

	 **Element URI**                       /axapi/v3/visibility/port-scan-detection

	 **Element Attributes**                port-scan-detection_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/visibility/port-scan-detection/oper

	 **Schema**                             :download:`port-scan-detection schema <visibility-port-scan-detection/visibility-port-scan-detection.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/visibility/port-scan-detection



.. raw:: html

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


:ref:`4017_port-scan-detection_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/visibility_port_scan_detection_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/visibility/port-scan-detection



.. raw:: html

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


:ref:`4017_port-scan-detection_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/visibility_port_scan_detection_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/visibility/port-scan-detection



.. raw:: html

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


:ref:`4017_port-scan-detection_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/visibility/port-scan-detection



.. raw:: html

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


:ref:`4017_port-scan-detection_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/visibility/port-scan-detection



.. raw:: html

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


:ref:`4017_port-scan-detection_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _4017_port-scan-detection_attributes:

port-scan-detection attributes
------------------------------

    **events**

        **Description** Number of scanned port events (default 10)

        **Type:** number

        **Range:** 10-300

        **Default:** 10

    **interval**

        **Description** Time interval for port scan detection (default 60)

        **Type:** number

        **Range:** 1-300

        **Default:** 60

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **v4-list**

        **Description** Class list of ipv4 addresses to be whitelisted

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/class-list <class_list>`

    **v6-list**

        **Description** Class list of ipv6 addresses to be whitelisted

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/class-list <class_list>`