.. _class_list:

class-list
==========

Configure classification list


class-list Specification
------------------------

	===================================== ==========================================================
	===================================== ==========================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`962_class-list_list`

	 **Collection URI**                    /axapi/v3/class-list

	                                       

	 **Element Name**                      class-list

	 **Element URI**                       /axapi/v3/class-list/{name}

	 **Element Attributes**                class-list_attributes

	 **Operational Data URI**              /axapi/v3/class-list/{name}/oper

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



.. raw:: html

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


:ref:`962_class-list_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/class_list_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/class-list



.. raw:: html

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


:ref:`962_class-list_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/class-list/{name}



.. raw:: html

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


:ref:`962_class-list_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/class_list_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/class-list



.. raw:: html

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


:ref:`962_class-list_list`



.. 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/class-list/{name}



.. raw:: html

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


:ref:`962_class-list_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/class-list/{name}



.. raw:: html

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


:ref:`962_class-list_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/class-list



.. raw:: html

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


:ref:`962_class-list_list`



.. 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/class-list/{name}



.. raw:: html

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


:ref:`962_class-list_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/class_list_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _962_class-list_list:

class-list-list
---------------


    class-list-list is **JSON List** of :ref:`962_class-list_attributes` 

        class-list-list : [

             { :ref:`962_class-list_attributes` },

             { :ref:`962_class-list_attributes` },

             ...

         ]

.. _962_class-list_attributes:

class-list attributes
---------------------

    **ac-list**

        **Type:** List

    **file**

        **Description** Create/Edit a class-list stored as a file

        **Type:** boolean

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

        **Default:** 0

    **geo-list**

        **Type:** List

    **ipv4-list**

        **Type:** List

    **ipv6-list**

        **Type:** List

    **name**

        **Description** Specify name of the class list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _962_ipv4-list:

ipv4-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **cid**

        **Description** 

        **Type:** number

        **Range:** 1-32

    **ipv4addr**

        **Description** Specify IP address

        **Type:** string

        **Format:** ipv4-cidr

.. _962_geo-list:

geo-list
^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **geo-location**

        **Description** Specify geo-location

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **geo-location-ipv6**

        **Description** Specify IPv6 geo-location

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

.. _962_ac-list:

ac-list
^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ac-key-string**

        **Description** Specify key string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **ac-match-type**

        **Description** 'contains': String contains another string; 'ends-with': String ends with another string; 'equals': String equals another string; 'starts-with': String starts with another string; 

        **Type:** string

        **Supported Values:** contains, ends-with, equals, starts-with

    **ac-value**

        **Description** Specify value string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 639 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** ac-value and gtp-rate-limit-policy-str are mutually exclusive

.. _962_ipv6-list:

ipv6-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **cid**

        **Description** 

        **Type:** number

        **Range:** 1-32

    **ipv6-addr**

        **Description** Specify IPv6 host or subnet

        **Type:** string

        **Format:** ipv6-address-plen

.. _962_oper_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - file-or-string
      - enum
      -  Output contains one of the following values: - file, config

   *  - 
      - ac-entries
      - 
      - ac-entries

   *  - 
      - ac-total-entries
      - number
      - ac-total-entries

   *  - 
      - ipv6-total-subnet
      - number
      - ipv6-total-subnet

   *  - 
      - dns-total-entries
      - number
      - dns-total-entries

   *  - 
      - ipv4-total-subnet
      - number
      - ipv4-total-subnet

   *  - 
      - dns-entries
      - 
      - dns-entries

   *  - 
      - ipv4-entries
      - 
      - ipv4-entries

   *  - 
      - ipv4-total-single-ip
      - number
      - ipv4-total-single-ip

   *  - 
      - user-tag
      - string
      - user-tag

   *  - 
      - ipv6-entries
      - 
      - ipv6-entries

   *  - 
      - string-total-entries
      - number
      - string-total-entries

   *  - 
      - geo-location-total-entries
      - number
      - geo-location-total-entries

   *  - 
      - type
      - enum
      -  Output contains one of the following values: - ac, dns, ipv4, ipv6, string, string-case-insensitive, [ipv4], [ipv6], [dns], [dns, ipv4], [dns, ipv6]

   *  - 
      - string-entries
      - 
      - string-entries

   *  - 
      - geo-location-entries
      - 
      - geo-location-entries

   *  - 
      - ipv6-total-single-ip
      - number
      - ipv6-total-single-ip