.. _system_memory:

system memory
=============

Configure System Parameters


memory Specification
--------------------

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

	 **Element Name**                      memory

	 **Element URI**                       /axapi/v3/system/memory

	 **Element Attributes**                memory_attributes

	 **Statistics Data URI**               /axapi/v3/system/memory/stats

	 **Operational Data URI**              /axapi/v3/system/memory/oper

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



.. raw:: html

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


:ref:`2080_memory_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/memory



.. raw:: html

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


:ref:`2080_memory_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/memory



.. raw:: html

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


:ref:`2080_memory_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/memory



.. raw:: html

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


:ref:`2080_memory_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/memory



.. raw:: html

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


:ref:`2080_memory_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2080_memory_attributes:

memory attributes
-----------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2080_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'usage-percentage': Memory Usage percentage; 

        **Type:** string

        **Supported Values:** all, usage-percentage

.. _2080_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - usage-percentage
      - 8
      - Memory Usage percentage

.. _2080_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - aFleX-memory
      - 
      - aFleX-memory

   *  - 
      - Used
      - number
      - Used

   *  - 
      - aflex-memory-counts
      - number
      - aflex-memory-counts

   *  - 
      - ac-trie-memory-counts
      - number
      - ac-trie-memory-counts

   *  - 
      - ssl-memory-counts
      - number
      - ssl-memory-counts

   *  - 
      - N2-memory
      - 
      - N2-memory

   *  - 
      - Cached
      - number
      - Cached

   *  - 
      - TCP-memory
      - 
      - TCP-memory

   *  - 
      - system-memory-counts
      - number
      - system-memory-counts

   *  - 
      - Free
      - number
      - Free

   *  - 
      - System-memory
      - 
      - System-memory

   *  - 
      - tcp-memory-counts
      - number
      - tcp-memory-counts

   *  - 
      - SSL-memory
      - 
      - SSL-memory

   *  - 
      - n2-memory-counts
      - number
      - n2-memory-counts

   *  - 
      - Usage
      - string
      - Usage

   *  - 
      - Shared
      - number
      - Shared

   *  - 
      - Total
      - number
      - Total

   *  - 
      - AC-trie-memory
      - 
      - AC-trie-memory

   *  - 
      - Buffers
      - number
      - Buffers