.. _slb_template_diameter:

slb template diameter
=====================

diameter template


diameter Specification
----------------------

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

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

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

	 **Collection Name**                   :ref:`2921_diameter_list`

	 **Collection URI**                    /axapi/v3/slb/template/diameter

	                                       

	 **Element Name**                      diameter

	 **Element URI**                       /axapi/v3/slb/template/diameter/{name}

	 **Element Attributes**                diameter_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2921_diameter_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/slb_template_diameter_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/slb/template/diameter



.. raw:: html

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


:ref:`2921_diameter_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/slb/template/diameter/{name}



.. raw:: html

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


:ref:`2921_diameter_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/slb_template_diameter_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/slb/template/diameter



.. raw:: html

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


:ref:`2921_diameter_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/slb/template/diameter/{name}



.. raw:: html

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


:ref:`2921_diameter_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/slb/template/diameter/{name}



.. raw:: html

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


:ref:`2921_diameter_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/slb_template_diameter_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/slb/template/diameter



.. raw:: html

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


:ref:`2921_diameter_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/slb/template/diameter/{name}



.. raw:: html

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


:ref:`2921_diameter_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/slb_template_diameter_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2921_diameter_list:

diameter-list
-------------


    diameter-list is **JSON List** of :ref:`2921_diameter_attributes` 

        diameter-list : [

             { :ref:`2921_diameter_attributes` },

             { :ref:`2921_diameter_attributes` },

             ...

         ]

.. _2921_diameter_attributes:

diameter attributes
-------------------

    **avp-code**

        **Description** avp code

        **Type:** number

        **Range:** 1-2147483647

    **avp-list**

        **Type:** List

    **avp-string**

        **Description** pattern to be matched in the avp string name, max length 127 bytes

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **customize-cea**

        **Description** customizing cea response

        **Type:** boolean

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

        **Default:** 0

    **dwr-time**

        **Description** dwr health-check timer interval (in 100 milli second unit, default is 100, 0 means unset this option)

        **Type:** number

        **Range:** 0-2147483647

        **Default:** 100

    **dwr-up-retry**

        **Description** number of successful dwr health-check before declaring target up

        **Type:** number

        **Range:** 1-7

        **Default:** 3

    **forward-to-latest-server**

        **Description** Forward client message to the latest server that sends message with the same session id

        **Type:** boolean

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

        **Default:** 0

    **forward-unknown-session-id**

        **Description** Forward server message even it has unknown session id

        **Type:** boolean

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

        **Default:** 0

    **idle-timeout**

        **Description** user sesison idle timeout (in minutes, default is 5)

        **Type:** number

        **Range:** 1-65535

        **Default:** 5

    **load-balance-on-session-id**

        **Description** Load balance based on the session id

        **Type:** boolean

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

        **Default:** 0

    **message-code-list**

        **Type:** List

    **multiple-origin-host**

        **Description** allowing multiple origin-host to a single server

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** diameter template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **origin-host**

        **Description:** origin-host is a **JSON Block**.  Please see below for :ref:`2921_origin-host` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/template/diameter/{name}/origin-host <slb_template_diameter>`

    **origin-realm**

        **Description** origin-realm name avp

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **product-name**

        **Description** product name avp

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **relaxed-origin-host**

        **Description** Relaxed Origin-Host Format

        **Type:** boolean

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

        **Default:** 0

    **service-group-name**

        **Description** service group name, this is the service group that the message needs to be copied to

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/service-group <slb_service_group>`

    **session-age**

        **Description** user session age allowed (default 10), this is not idle-time (in minutes)

        **Type:** number

        **Range:** 1-65535

        **Default:** 10

    **terminate-on-cca-t**

        **Description** remove diameter session when receiving CCA-T message

        **Type:** boolean

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

        **Default:** 0

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

    **vendor-id**

        **Description** vendor-id avp (Vendor Id)

        **Type:** number

        **Range:** 0-2147483647

        **Default:** 0

.. _2921_message-code-list:

message-code-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **message-code**

        **Description** 

        **Type:** number

        **Range:** 1-2147483647

.. _2921_avp-list:

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

	 **Block object keys**             

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

    **avp**

        **Description** customize avps for cer to the server (avp number)

        **Type:** number

        **Range:** 0-2147483647

    **int32**

        **Description** 32 bits integer

        **Type:** number

        **Range:** 0-2147483647

        **Mutual Exclusion:** int32, int64, and string are mutually exclusive

    **int64**

        **Description** 64 bits integer

        **Type:** number

        **Range:** 0-2147483647

        **Mutual Exclusion:** int64, int32, and string are mutually exclusive

    **mandatory**

        **Description** mandatory avp

        **Type:** boolean

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

        **Default:** 0

    **string**

        **Description** String (string name, max length 127 bytes)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** string, int32, and int64 are mutually exclusive

.. _2921_origin-host:

origin-host
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **origin-host-name**

        **Description** origin-host name avp

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters