.. _gslb_template:

gslb template
=============

Specify a GSLB template


template Specification
----------------------

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

	===================================== ======================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      template

	 **Element URI**                       /axapi/v3/gslb/template

	 **Element Attributes**                template_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/gslb/template



.. raw:: html

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


template_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1769_template_attributes:

template attributes
-------------------

    **csv-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/template/csv/{csv-name} <gslb_template_csv>`

    **snmp-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/template/snmp/{snmp-name} <gslb_template_snmp>`

.. _1769_snmp-list:

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

	 **Block object keys**             

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

    **auth-key**

        **Description** Specify authentication key (Specify key)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **auth-proto**

        **Description** 'sha': SHA; 'md5': MD5; 

        **Type:** string

        **Supported Values:** sha, md5

        **Default:** md5

    **community**

        **Description** Specify community for version 2c (Community name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **context-engine-id**

        **Description** Specify context engine ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **context-name**

        **Description** Specify context name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **host**

        **Description** Specify host (Host name or ip address)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **interface**

        **Description** Specify Interface ID

        **Type:** number

        **Range:** 0-2147483647

    **interval**

        **Description** Specify interval, default is 3 (Interval, unit: second, default is 3)

        **Type:** number

        **Range:** 1-999

        **Default:** 3

    **oid**

        **Description** Specify OID

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **port**

        **Description** Specify port, default is 161 (Port Number, default is 161)

        **Type:** number

        **Range:** 1-65535

        **Default:** 161

    **priv-key**

        **Description** Specify privacy key (Specify key)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **priv-proto**

        **Description** 'aes': AES; 'des': DES; 

        **Type:** string

        **Supported Values:** aes, des

        **Default:** des

    **security-engine-id**

        **Description** Specify security engine ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **security-level**

        **Description** 'no-auth': No authentication; 'auth-no-priv': Authentication, but no privacy; 'auth-priv': Authentication and privacy; 

        **Type:** string

        **Supported Values:** no-auth, auth-no-priv, auth-priv

        **Default:** no-auth

    **snmp-name**

        **Description** Specify name of snmp template

        **Type:** string

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

    **username**

        **Description** Specify username (User name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **version**

        **Description** 'v1': Version 1; 'v2c': Version 2c; 'v3': Version 3; 

        **Type:** string

        **Supported Values:** v1, v2c, v3

        **Default:** v3

.. _1769_csv-list:

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

	 **Block object keys**             

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

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

.. _1769_csv-list_multiple-fields:

csv-list_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