.. _domain_list_oper:

domain-list oper
================

Operational Status for the object domain-list


domain-list Specification
-------------------------

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

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

	 **Collection Name**                   :ref:`598_domain-list_list`

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

	                                       

	 **Element Name**                      domain-list

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

	 **Element Attributes**                domain-list_attributes

	 **Partition Visibility**              None

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

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



.. raw:: html

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


:ref:`598_domain-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/domain-list/{name}



.. raw:: html

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


:ref:`598_domain-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/domain-list/{name}/oper



.. raw:: html

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


:ref:`598_domain-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/domain-list/{name}



.. raw:: html

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


:ref:`598_domain-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/domain-list/{name}/oper



.. raw:: html

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


:ref:`598_domain-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/domain-list/{name}/oper



.. raw:: html

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


:ref:`598_domain-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/domain-list/{name}



.. raw:: html

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


:ref:`598_domain-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/domain-list/{name}/oper



.. raw:: html

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


:ref:`598_domain-list_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _598_domain-list_list:

domain-list-list
----------------


    domain-list-list is **JSON List** of :ref:`598_domain-list_attributes` 

        domain-list-list : [

             { :ref:`598_domain-list_attributes` },

             { :ref:`598_domain-list_attributes` },

             ...

         ]

.. _598_domain-list_attributes:

domain-list attributes
----------------------

    **name**

        **Description** Specify name of the domain 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:`598_oper` 

        **Type:** Object

.. _598_oper:

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

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

    **binding-num**

        **Description** 

        **Type:** number

    **config-type**

        **Description** 

        **Type:** string

        **Supported Values:** FILE, CLI

    **displayed-count**

        **Description** 

        **Type:** number

    **domain-entries**

        **Type:** List

    **domain-list-name**

        **Description** 

        **Type:** string

    **match-type**

        **Description** 

        **Type:** string

    **total-entry-num**

        **Description** 

        **Type:** number

.. _598_oper_domain-entries:

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

	 **Block object keys**             

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

    **domain-match-type**

        **Description** 

        **Type:** string

        **Supported Values:** Equals, Suffix, Zone-transfer

    **domain-name**

        **Description** 

        **Type:** string

    **zone-transfer-interval**

        **Description** 

        **Type:** string

    **zone-transfer-ip**

        **Description** 

        **Type:** string

    **zone-transfer-port**

        **Description** 

        **Type:** string