.. _class_list_oper:

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

Operational Status for the object class-list


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

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

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

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

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

	                                       

	 **Element Name**                      class-list

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

	 **Element Attributes**                class-list_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`class-list schema <class-list-oper/class-list-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/class-list/{name}



.. raw:: html

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


:ref:`625_class-list_attributes`



.. raw:: html

   </td><td></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/{name}



.. raw:: html

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


:ref:`625_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}/oper



.. raw:: html

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


:ref:`625_class-list_attributes`



.. raw:: html

   </td><td></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/{name}



.. raw:: html

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


:ref:`625_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}/oper



.. raw:: html

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


:ref:`625_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}/oper



.. raw:: html

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


:ref:`625_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/{name}



.. raw:: html

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


:ref:`625_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}/oper



.. raw:: html

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


:ref:`625_class-list_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _625_class-list_list:

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


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

        class-list-list : [

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

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

             ...

         ]

.. _625_class-list_attributes:

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

    **name**

        **Description** Specify name of the class list

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **oper**

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

        **Type:** Object

.. _625_oper:

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

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

    **ac-entries**

        **Type:** List

    **ac-total-entries**

        **Description** 

        **Type:** number

    **dns-entries**

        **Type:** List

    **dns-total-entries**

        **Description** 

        **Type:** number

    **file-or-string**

        **Description** 

        **Type:** string

        **Supported Values:** file, config

    **geo-location-entries**

        **Type:** List

    **geo-location-total-entries**

        **Description** 

        **Type:** number

    **ipv4-entries**

        **Type:** List

    **ipv4-total-single-ip**

        **Description** 

        **Type:** number

    **ipv4-total-subnet**

        **Description** 

        **Type:** number

    **ipv6-entries**

        **Type:** List

    **ipv6-total-single-ip**

        **Description** 

        **Type:** number

    **ipv6-total-subnet**

        **Description** 

        **Type:** number

    **string-entries**

        **Type:** List

    **string-total-entries**

        **Description** 

        **Type:** number

    **type**

        **Description** 

        **Type:** string

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

    **user-tag**

        **Description** 

        **Type:** string

.. _625_oper_ac-entries:

oper_ac-entries
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ac-gtp-policy**

        **Description** 

        **Type:** string

    **ac-hit-count**

        **Description** 

        **Type:** number

    **ac-match-string**

        **Description** 

        **Type:** string

    **ac-match-type**

        **Description** 

        **Type:** string

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

    **ac-match-value**

        **Description** 

        **Type:** string

.. _625_oper_dns-entries:

oper_dns-entries
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **dns-glid**

        **Description** 

        **Type:** number

    **dns-hit-count**

        **Description** 

        **Type:** number

    **dns-lid**

        **Description** 

        **Type:** number

    **dns-match-string**

        **Description** 

        **Type:** string

    **dns-match-type**

        **Description** 

        **Type:** string

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

    **dns-rpz-type**

        **Description** 

        **Type:** number

.. _625_oper_ipv4-entries:

oper_ipv4-entries
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4-addr**

        **Description** 

        **Type:** string

    **ipv4-age**

        **Description** 

        **Type:** number

    **ipv4-glid**

        **Description** 

        **Type:** number

    **ipv4-gtp-policy**

        **Description** 

        **Type:** string

    **ipv4-hit-count**

        **Description** 

        **Type:** number

    **ipv4-lid**

        **Description** 

        **Type:** number

    **ipv4-lsn-lid**

        **Description** 

        **Type:** number

    **ipv4-lsn-radius-profile**

        **Description** 

        **Type:** number

    **ipv4-rpz-type**

        **Description** 

        **Type:** number

.. _625_oper_ipv6-entries:

oper_ipv6-entries
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv6-age**

        **Description** 

        **Type:** number

    **ipv6-glid**

        **Description** 

        **Type:** number

    **ipv6-gtp-policy**

        **Description** 

        **Type:** string

    **ipv6-hit-count**

        **Description** 

        **Type:** number

    **ipv6-lid**

        **Description** 

        **Type:** number

    **ipv6-lsn-lid**

        **Description** 

        **Type:** number

    **ipv6-lsn-radius-profile**

        **Description** 

        **Type:** number

    **ipv6-rpz-type**

        **Description** 

        **Type:** number

    **ipv6addr**

        **Description** 

        **Type:** string

.. _625_oper_string-entries:

oper_string-entries
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **string-glid**

        **Description** 

        **Type:** number

    **string-hit-count**

        **Description** 

        **Type:** number

    **string-key**

        **Description** 

        **Type:** string

    **string-lid**

        **Description** 

        **Type:** number

    **string-value**

        **Description** 

        **Type:** string

.. _625_oper_geo-location-entries:

oper_geo-location-entries
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **geo-location**

        **Description** 

        **Type:** string