.. _ips:

ips
===

IPS feature


ips Specification
-----------------

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

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

	 **Element Name**                      ips

	 **Element URI**                       /axapi/v3/ips

	 **Element Attributes**                ips_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


ips_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2155_ips_attributes:

ips attributes
--------------

    **global**

        **Description:** global is a **JSON Block**.  Please see below for :ref:`2155_global` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ips/global <ips_global>`

    **profile**

        **Description:** profile is a **JSON Block**.  Please see below for :ref:`2155_profile` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ips/profile <ips_profile>`

    **signature**

        **Description:** signature is a **JSON Block**.  Please see below for :ref:`2155_signature` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ips/signature <ips_signature>`

    **summary**

        **Description:** summary is a **JSON Block**.  Please see below for :ref:`2155_summary` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ips/summary <ips_summary>`

.. _2155_profile:

profile
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2155_global:

global
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2155_global_sampling-enable:

global_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'ips_matched_total': IPS Matched Total; 'ips_matched_http': IPS Matched HTTP; 'ips_matched_dns': IPS Matched DNS; 'ips_matched_other': IPS Matched Other; 'ips_matched_action_pass': IPS Matched Action Pass; 'ips_matched_action_drop': IPS Matched Action Drop; 'ips_matched_action_blacklist': IPS Matched Action Blacklist; 'ips_matched_severity_high': IPS Matched Severity High; 'ips_matched_severity_medium': IPS Matched Severity Medium; 'ips_matched_severity_low': IPS Matched Severity Low; 

        **Type:** string

        **Supported Values:** all, ips_matched_total, ips_matched_http, ips_matched_dns, ips_matched_other, ips_matched_action_pass, ips_matched_action_drop, ips_matched_action_blacklist, ips_matched_severity_high, ips_matched_severity_medium, ips_matched_severity_low

.. _2155_summary:

summary
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2155_signature:

signature
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters