.. _system_resource_usage:

system resource-usage
=====================

Configure System Resource Usage


resource-usage Specification
----------------------------

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

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

	 **Element Name**                      resource-usage

	 **Element URI**                       /axapi/v3/system/resource-usage

	 **Element Attributes**                resource-usage_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/system/resource-usage/oper

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



.. raw:: html

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


:ref:`3377_resource-usage_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/system_resource_usage_POST.txt
   :literal:




.. raw:: html

   </div></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/resource-usage



.. raw:: html

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


:ref:`3377_resource-usage_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/resource-usage



.. raw:: html

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


:ref:`3377_resource-usage_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/resource-usage



.. raw:: html

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


:ref:`3377_resource-usage_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/resource-usage



.. raw:: html

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


:ref:`3377_resource-usage_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3377_resource-usage_attributes:

resource-usage attributes
-------------------------

    **aflex-table-entry-count**

        **Description** Total aFleX table entry in the system (Total aFlex entry in the system)

        **Type:** number

    **auth-portal-html-file-size**

        **Description** Specify maximum html file size for each html page in auth portal (in KB)

        **Type:** number

        **Range:** 4-120

        **Default:** 20

    **auth-portal-image-file-size**

        **Description** Specify maximum image file size for default portal (in KB)

        **Type:** number

        **Range:** 1-80

        **Default:** 6

    **auth-session-count**

        **Description** Total auth sessions in the system

        **Type:** number

    **authz-policy-number**

        **Description** Specify the maximum number of authorization policies

        **Type:** number

    **class-list-ac-entry-count**

        **Description** Total entries for AC class-list

        **Type:** number

    **class-list-entry-count**

        **Description** Total entries for class-list

        **Type:** number

    **class-list-ipv6-addr-count**

        **Description** Total IPv6 addresses for class-list

        **Type:** number

    **ipsec-sa-number**

        **Description** Specify the maximum number of IPsec SA

        **Type:** number

    **l4-session-count**

        **Description** Total Sessions in the System

        **Type:** number

    **max-aflex-authz-collection-number**

        **Description** Specify the maximum number of collections supported by aFleX authorization

        **Type:** number

        **Range:** 256-4096

        **Default:** 512

    **max-aflex-file-size**

        **Description** Set maximum aFleX file size (Maximum file size in KBytes, default is 32K)

        **Type:** number

        **Range:** 16-256

        **Default:** 32

    **nat-pool-addr-count**

        **Description** Total configurable NAT Pool addresses in the System

        **Type:** number

    **radius-table-size**

        **Description** Total configurable CGNV6 RADIUS Table entries

        **Type:** number

    **ram-cache-memory-limit**

        **Description** Specify the maximum memory used by ram cache

        **Type:** number

    **ssl-context-memory**

        **Description** Total SSL context memory needed in units of MB. Will be rounded to closest multiple of 2MB

        **Type:** number

        **Range:** 256-16384

        **Default:** 2048

    **ssl-dma-memory**

        **Description** Total SSL DMA memory needed in units of MB. Will be rounded to closest multiple of 2MB

        **Type:** number

        **Range:** 32-2048

        **Default:** 256

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **visibility**

        **Description:** visibility is a **JSON Block**.  Please see below for :ref:`3377_visibility` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/resource-usage/visibility <system_resource_usage_visibility>`

.. _3377_visibility:

visibility
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **monitored-entity-count**

        **Description** Total number of monitored entities for visibility

        **Type:** number

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters