.. _system_ai_engine_oper:

system ai engine oper
=====================

Operational Status for the object engine


engine Specification
--------------------

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

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

	 **Element Name**                      engine

	 **Element URI**                       /axapi/v3/system/ai/engine/oper

	 **Element Attributes**                engine_attributes

	 **Partition Visibility**              shared,private,service-partition

	 **Schema**                             :download:`engine schema <system-ai-engine-oper/system-ai-engine-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/system/ai/engine/oper



.. raw:: html

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


:ref:`3308_engine_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/system/ai/engine/oper



.. raw:: html

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


:ref:`3308_engine_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/system/ai/engine/oper



.. raw:: html

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


:ref:`3308_engine_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/system/ai/engine/oper



.. raw:: html

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


:ref:`3308_engine_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/system/ai/engine/oper



.. raw:: html

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


:ref:`3308_engine_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3308_engine_attributes:

engine attributes
-----------------

    **oper**

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

        **Type:** Object

.. _3308_oper:

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

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

    **ai-engine-count**

        **Description** Number of SSL modules

        **Type:** number

    **ai-engine-info**

        **Type:** List

    **ai-engine-type**

        **Description** SSL module

        **Type:** string

    **cuda-version**

        **Description** AI Engine CUDA version

        **Type:** string

    **driver-version**

        **Description** AI Engine Driver version

        **Type:** string

.. _3308_oper_ai-engine-info:

oper_ai-engine-info
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **10sec-rate**

        **Description** Average Engine percentage per 10 sec

        **Type:** number

    **1sec-rate**

        **Description** Average Engine percentage per sec

        **Type:** number

    **30sec-rate**

        **Description** Average Engine percentage per 30 sec

        **Type:** number

    **5sec-rate**

        **Description** Average Engine percentage per 5 sec

        **Type:** number

    **60sec-rate**

        **Description** Average Engine percentage per 60 sec

        **Type:** number

    **ai-engine-index**

        **Description** AI Engine index

        **Type:** number

    **gpu_name**

        **Description** AI Engine vendor name

        **Type:** string

    **gpu_state**

        **Description** AI Engine state

        **Type:** string

    **memory**

        **Description** AI Engine memory utilization

        **Type:** number

    **memory_percent**

        **Description** AI Engine memory Percent

        **Type:** string

    **memory_total**

        **Description** AI Engine memory total

        **Type:** number

    **memory_used**

        **Description** AI Engine memory usage

        **Type:** number

    **power**

        **Description** AI Engine Power usage

        **Type:** number

    **power_limit**

        **Description** AI Engine Power Limit

        **Type:** number

    **power_percent**

        **Description** AI Engine Power Limit

        **Type:** string

    **temperature**

        **Description** AI Engine Temperature usage

        **Type:** number

    **utilization**

        **Description** AI Engine utilization

        **Type:** number