.. _ng_waf_oper:

ng-waf oper
===========

Operational Status for the object ng-waf


ng-waf Specification
--------------------

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

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

	 **Element Name**                      ng-waf

	 **Element URI**                       /axapi/v3/ng-waf/oper

	 **Element Attributes**                ng-waf_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


:ref:`2380_ng-waf_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/ng-waf/oper



.. raw:: html

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


:ref:`2380_ng-waf_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/ng-waf/oper



.. raw:: html

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


:ref:`2380_ng-waf_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/ng-waf/oper



.. raw:: html

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


:ref:`2380_ng-waf_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/ng-waf/oper



.. raw:: html

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


:ref:`2380_ng-waf_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2380_ng-waf_attributes:

ng-waf attributes
-----------------

    **cpu**

        **Description:** cpu is a **JSON Block**.  Please see below for :ref:`2380_cpu` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ng-waf/status/custom-page/custom-signals/cpu <ng_waf_status_custom_page_custom_signals_cpu>`

    **custom-page**

        **Description:** custom-page is a **JSON Block**.  Please see below for :ref:`2380_custom-page` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ng-waf/status/custom-page <ng_waf_status_custom_page>`

    **custom-signals**

        **Description:** custom-signals is a **JSON Block**.  Please see below for :ref:`2380_custom-signals` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ng-waf/status/custom-page/custom-signals <ng_waf_status_custom_page_custom_signals>`

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2380_oper` 

        **Type:** Object

    **status**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ng-waf/status <ng_waf_status>`

.. _2380_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **cache-vport**

        **Description** 

        **Type:** string

    **cache-vserver**

        **Description** 

        **Type:** string

    **clear-all**

        **Description** 

        **Type:** boolean

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

    **ngwaf-stats-list**

        **Type:** List

    **vport**

        **Description** 

        **Type:** string

    **vserver**

        **Description** 

        **Type:** string

.. _2380_oper_ngwaf-stats-list:

oper_ngwaf-stats-list
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **count**

        **Description** 

        **Type:** number

    **name**

        **Description** 

        **Type:** string

    **type**

        **Description** 

        **Type:** string

.. _2380_status:

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

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2380_status_oper` 

        **Type:** Object

.. _2380_status_oper:

status_oper
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ngwaf-version**

        **Description** 

        **Type:** string

    **partition-list**

        **Type:** List

.. _2380_status_oper_partition-list:

status_oper_partition-list
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **access-key-id**

        **Description** 

        **Type:** string

    **agent-name**

        **Description** 

        **Type:** string

    **cache-entries**

        **Description** 

        **Type:** number

    **partition-name**

        **Description** 

        **Type:** string

    **secret-access-key**

        **Description** 

        **Type:** string

    **status**

        **Description** 

        **Type:** string

    **tracked-custom-signal**

        **Description** 

        **Type:** number

.. _2380_custom-signals:

custom-signals
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2380_custom-signals_oper` 

        **Type:** Object

.. _2380_custom-signals_oper:

custom-signals_oper
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **signal-list**

        **Type:** List

.. _2380_custom-signals_oper_signal-list:

custom-signals_oper_signal-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **signal**

        **Description** 

        **Type:** string

.. _2380_cpu:

cpu
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2380_cpu_oper` 

        **Type:** Object

.. _2380_cpu_oper:

cpu_oper
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **cpu-info**

        **Type:** List

    **number-of-cpus**

        **Description** 

        **Type:** number

.. _2380_cpu_oper_cpu-info:

cpu_oper_cpu-info
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **1-sec**

        **Description** 

        **Type:** number

    **10-sec**

        **Description** 

        **Type:** number

    **30-sec**

        **Description** 

        **Type:** number

    **5-sec**

        **Description** 

        **Type:** number

    **60-sec**

        **Description** 

        **Type:** number

    **cpu-id**

        **Description** 

        **Type:** number

.. _2380_custom-page:

custom-page
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2380_custom-page_oper` 

        **Type:** Object

.. _2380_custom-page_oper:

custom-page_oper
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **file-list**

        **Type:** List

.. _2380_custom-page_oper_file-list:

custom-page_oper_file-list
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **file**

        **Description** 

        **Type:** string

    **size**

        **Description** 

        **Type:** number