.. _gslb_template_csv:

gslb template csv
=================

Specify csv template


csv Specification
-----------------

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

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

	 **Object Key(s)**                     *csv-name*

	 **Collection Name**                   :ref:`1767_csv_list`

	 **Collection URI**                    /axapi/v3/gslb/template/csv

	                                       

	 **Element Name**                      csv

	 **Element URI**                       /axapi/v3/gslb/template/csv/{csv-name}

	 **Element Attributes**                csv_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`csv schema <gslb-template-csv/gslb-template-csv.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/gslb/template/csv



.. raw:: html

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


:ref:`1767_csv_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/gslb_template_csv_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/gslb/template/csv



.. raw:: html

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


:ref:`1767_csv_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/gslb/template/csv/{csv-name}



.. raw:: html

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


:ref:`1767_csv_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/gslb_template_csv_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/gslb/template/csv



.. raw:: html

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


:ref:`1767_csv_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/gslb/template/csv/{csv-name}



.. raw:: html

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


:ref:`1767_csv_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/gslb/template/csv/{csv-name}



.. raw:: html

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


:ref:`1767_csv_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/gslb_template_csv_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/gslb/template/csv



.. raw:: html

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


:ref:`1767_csv_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/gslb/template/csv/{csv-name}



.. raw:: html

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


:ref:`1767_csv_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/gslb_template_csv_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1767_csv_list:

csv-list
--------


    csv-list is **JSON List** of :ref:`1767_csv_attributes` 

        csv-list : [

             { :ref:`1767_csv_attributes` },

             { :ref:`1767_csv_attributes` },

             ...

         ]

.. _1767_csv_attributes:

csv attributes
--------------

    **csv-name**

        **Description** Specify name of csv template

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **delim-char**

        **Description** enter a delimiter character, default ","

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1 characters

        **Maximum Length:** 1 characters

        **Default:** ,

        **Mutual Exclusion:** delim-char and delim-num are mutually exclusive

    **delim-num**

        **Description** enter a delimiter number, default 44 (",")

        **Type:** number

        **Range:** 0-255

        **Default:** 44

        **Mutual Exclusion:** delim-num and delim-char are mutually exclusive

    **ipv6-enable**

        **Description** Support IPv6 IP ranges

        **Type:** boolean

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

        **Default:** 0

    **multiple-fields**

        **Type:** List

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

.. _1767_multiple-fields:

multiple-fields
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **csv-type**

        **Description** 'ip-from': Beginning address of IP range or subnet; 'ip-to-mask': Ending address of IP range or Mask; 'continent': Continent; 'country': Country; 'state': State or province; 'city': City; 

        **Type:** string

        **Supported Values:** ip-from, ip-to-mask, continent, country, state, city

    **field**

        **Description** Field index number (Index of Field)

        **Type:** number

        **Range:** 1-64