.. _ai_firewall:

ai firewall
===========

AI Firewall related configuration


firewall Specification
----------------------

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

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

	 **Element Name**                      firewall

	 **Element URI**                       /axapi/v3/ai/firewall

	 **Element Attributes**                firewall_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/ai/firewall/stats

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



.. raw:: html

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


:ref:`192_firewall_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/ai/firewall



.. raw:: html

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


:ref:`192_firewall_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/ai/firewall



.. raw:: html

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


:ref:`192_firewall_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/ai/firewall



.. raw:: html

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


:ref:`192_firewall_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/ai/firewall



.. raw:: html

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


:ref:`192_firewall_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _192_firewall_attributes:

firewall attributes
-------------------

    **clear-log**

        **Description** Clear AI Firewall Application Logging

        **Type:** boolean

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

        **Default:** 0

    **disable**

        **Description** Disable AI Firewall Support globally

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** disable and enable are mutually exclusive

    **enable**

        **Description** Enable AI Firewall Support globally

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** enable and disable are mutually exclusive

    **restart**

        **Description** Restart AI Firewall Components and Services

        **Type:** boolean

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

        **Default:** 0

    **sampling-enable**

        **Type:** List

    **start**

        **Description** Start AI Firewall Components and Services

        **Type:** boolean

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

        **Default:** 0

    **status**

        **Description:** status is a **JSON Block**.  Please see below for :ref:`192_status` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ai/firewall/status <ai_firewall_status>`

    **stop**

        **Description** Stop AI Firewall Components and Services

        **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

.. _192_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'total-requests': Total AI Firewall Request counts; 'total-responses': Total AI Firewall Response counts; 'total-icap-reqmod': Total ICAP REQMOD counts; 'total-icap-respmod': Total ICAP RESPMOD counts; 'total-icap-options': Total ICAP Options counts; 'total-violatons': Total AI Firewall Violations counts; 'total-acceptance': Total AI Firewall acceptance counts; 'avg-time-msec': Average Requests Time in millisec; 'avg-time-resp-msec': Average Responses Time in millisec; 'total-monitor-reqmod': Total monitored reqmod counts; 'total-monitor-respmod': Total monitored respmod counts; 'total-lic-allow': Total licensed requests  counts; 'total-lic-block': Total license drop counts; 'lic-live-tokens': Current live licens used  counts; 'lic-peak-tokens': Peak utilization of licensed tokens; 'lic-cbr-tokens': Committed licensed tokens; 

        **Type:** string

        **Supported Values:** all, total-requests, total-responses, total-icap-reqmod, total-icap-respmod, total-icap-options, total-violatons, total-acceptance, avg-time-msec, avg-time-resp-msec, total-monitor-reqmod, total-monitor-respmod, total-lic-allow, total-lic-block, lic-live-tokens, lic-peak-tokens, lic-cbr-tokens

.. _192_status:

status
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters