.. _class_list:

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

Configure classification list


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

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

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

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

	 **Collection Name**                   :ref:`626_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

	 **Partition Visibility**              shared

	 **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:`626_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:`626_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:`626_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:`626_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:`626_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:`626_class-list_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/class_list_PUT.txt
   :literal:




.. raw:: html

   </div></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:`626_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:`626_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>

.. _626_class-list_list:

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


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

        class-list-list : [

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

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

             ...

         ]

.. _626_class-list_attributes:

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

    **ac-list**

        **Type:** List

    **dns**

        **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

    **str-list**

        **Type:** List

    **type**

        **Description** 'ac': Make class-list type Aho-Corasick; 'dns': Make class-list type DNS; 'ipv4': Make class-list type IPv4; 'ipv6': Make class-list type IPv6; 'string': Make class-list type String; 'string-case-insensitive': Make class-list type String-case-insensitive. Case insensitive is applied to key string; 

        **Type:** string

        **Supported Values:** ac, dns, ipv4, ipv6, string, string-case-insensitive

    **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

.. _626_ipv4-list:

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

	 **Block object keys**             

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

    **age**

        **Description** Specify age in minutes

        **Type:** number

        **Range:** 1-2000

    **glid**

        **Description** Use global Limit ID (Specify global LID index)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** glid,lid, shared-partition-glid, lsn-lid,  lsn-radius-profile, and gtp-rate-limit-policy-v4 are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **glid-shared**

        **Description** Use global Limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **gtp-rate-limit-policy-v4**

        **Description** GTP Rate Limit Template Name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** gtp-rate-limit-policy-v4,lid, glid,  lsn-lid, and lsn-radius-profile are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/template/gtp/rate-limit-policy <template_gtp_rate_limit_policy>`

    **ipv4addr**

        **Description** Specify IP address

        **Type:** string

        **Format:** ipv4-cidr

    **lid**

        **Description** Use Limit ID defined in template (Specify LID index)

        **Type:** number

        **Range:** 1-1023

        **Mutual Exclusion:** lid,glid-num, glid, lsn-lid, lsn-radius-profile, gtp-rate-limit-policy-v4,  v6-glid, and dns-glid are mutually exclusive

    **lsn-lid**

        **Description** LSN Limit ID (LID index)

        **Type:** number

        **Range:** 1-1023

        **Mutual Exclusion:** lsn-lid,lid, glid,  lsn-radius-profile, and gtp-rate-limit-policy-v4 are mutually exclusive

    **lsn-radius-profile**

        **Description** LSN RADIUS Profile Index

        **Type:** number

        **Range:** 1-16

        **Mutual Exclusion:** lsn-radius-profile,lid, glid,  lsn-lid, and gtp-rate-limit-policy-v4 are mutually exclusive

    **shared-partition-glid**

        **Description** Reference a glid from shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared-partition-glid and glid are mutually exclusive

.. _626_str-list:

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

	 **Block object keys**             

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

    **shared-partition-str-glid**

        **Description** Reference a glid from shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared-partition-str-glid and str-glid are mutually exclusive

    **str**

        **Description** Specify key string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **str-glid**

        **Description** Global LID index

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** str-glid and shared-partition-str-glid are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **str-glid-dummy**

        **Description** Use global Limit ID

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** str-glid-dummy and str-lid-dummy are mutually exclusive

    **str-glid-shared**

        **Description** Use global Limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **str-lid**

        **Description** LID index

        **Type:** number

        **Range:** 1-1023

    **str-lid-dummy**

        **Description** Use Limit ID defined in template

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** str-lid-dummy and str-glid-dummy are mutually exclusive

    **value-str**

        **Description** Specify value string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 639 characters

        **Maximum Length:** 1 characters

.. _626_geo-list:

geo-list
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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

.. _626_ac-list:

ac-list
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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

    **gtp-rate-limit-policy-str**

        **Description** GTP Rate Limit Template Name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

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

        **Reference Object:** :doc:`/axapi/v3/template/gtp/rate-limit-policy <template_gtp_rate_limit_policy>`

.. _626_ipv6-list:

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

	 **Block object keys**             

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

    **gtp-rate-limit-policy-v6**

        **Description** GTP Rate Limit Template Name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** gtp-rate-limit-policy-v6,v6-lid, v6-glid,  v6-lsn-lid, and v6-lsn-radius-profile are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/template/gtp/rate-limit-policy <template_gtp_rate_limit_policy>`

    **ipv6-addr**

        **Description** Specify IPv6 host or subnet

        **Type:** string

        **Format:** ipv6-address-plen

    **shared-partition-v6-glid**

        **Description** Reference a glid from shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared-partition-v6-glid and v6-glid are mutually exclusive

    **v6-age**

        **Description** Specify age in minutes

        **Type:** number

        **Range:** 1-2000

    **v6-glid**

        **Description** Use global Limit ID (Specify global LID index)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** v6-glid,lid, shared-partition-v6-glid, v6-lsn-lid,  v6-lsn-radius-profile, and gtp-rate-limit-policy-v6 are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **v6-glid-shared**

        **Description** Use global Limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **v6-lid**

        **Description** Use Limit ID defined in template (Specify LID index)

        **Type:** number

        **Range:** 1-1023

        **Mutual Exclusion:** v6-lid,glid-v6, v6-lsn-lid,  v6-lsn-radius-profile, and gtp-rate-limit-policy-v6 are mutually exclusive

    **v6-lsn-lid**

        **Description** LSN Limit ID (LID index)

        **Type:** number

        **Range:** 1-1023

        **Mutual Exclusion:** v6-lsn-lid,v6-lid, v6-glid,  v6-lsn-radius-profile, and gtp-rate-limit-policy-v6 are mutually exclusive

    **v6-lsn-radius-profile**

        **Description** LSN RADIUS Profile Index

        **Type:** number

        **Range:** 1-16

        **Mutual Exclusion:** v6-lsn-radius-profile,v6-lid, v6-glid,  v6-lsn-lid, and gtp-rate-limit-policy-v6 are mutually exclusive

.. _626_dns:

dns
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **dns-glid**

        **Description** Use global Limit ID (Specify global LID index)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** dns-glid, lid, and shared-partition-dns-glid are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **dns-glid-shared**

        **Description** Use global Limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1023 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **dns-lid**

        **Description** Use Limit ID defined in template (Specify LID index)

        **Type:** number

        **Range:** 1-1023

        **Mutual Exclusion:** dns-lid and glid-dns are mutually exclusive

    **dns-match-string**

        **Description** Domain name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **dns-match-type**

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

        **Type:** string

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

    **shared-partition-dns-glid**

        **Description** Reference a glid from shared partition

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** shared-partition-dns-glid and dns-glid are mutually exclusive