.. _template_sctp:

template sctp
=============

Define a SCTP template


sctp Specification
------------------

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

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

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

	 **Collection Name**                   :ref:`3492_sctp_list`

	 **Collection URI**                    /axapi/v3/template/sctp

	                                       

	 **Element Name**                      sctp

	 **Element URI**                       /axapi/v3/template/sctp/{name}

	 **Element Attributes**                sctp_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3492_sctp_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/template_sctp_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/template/sctp



.. raw:: html

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


:ref:`3492_sctp_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/template/sctp/{name}



.. raw:: html

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


:ref:`3492_sctp_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/template_sctp_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/template/sctp



.. raw:: html

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


:ref:`3492_sctp_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/template/sctp/{name}



.. raw:: html

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


:ref:`3492_sctp_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/template/sctp/{name}



.. raw:: html

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


:ref:`3492_sctp_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/template_sctp_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/template/sctp



.. raw:: html

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


:ref:`3492_sctp_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/template/sctp/{name}



.. raw:: html

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


:ref:`3492_sctp_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/template_sctp_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3492_sctp_list:

sctp-list
---------


    sctp-list is **JSON List** of :ref:`3492_sctp_attributes` 

        sctp-list : [

             { :ref:`3492_sctp_attributes` },

             { :ref:`3492_sctp_attributes` },

             ...

         ]

.. _3492_sctp_attributes:

sctp attributes
---------------

    **checksum-check**

        **Description** 'enable': Enable Checksum check; 

        **Type:** string

        **Supported Values:** enable

    **log**

        **Description:** log is a **JSON Block**.  Please see below for :ref:`3492_log` 

        **Type:** Object

    **name**

        **Description** SCTP Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Default:** default

    **permit-payload-protocol**

        **Description:** permit-payload-protocol is a **JSON Block**.  Please see below for :ref:`3492_permit-payload-protocol` 

        **Type:** Object

    **sctp-half-open-idle-timeout**

        **Description** Set SCTP half-open timeout (SCTP half-open timeout in seconds (default 4))

        **Type:** number

        **Range:** 2-30

        **Default:** 4

    **sctp-idle-timeout**

        **Description** SCTP idle timeout in minutes (default 5)

        **Type:** number

        **Range:** 1-63

        **Default:** 5

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

.. _3492_log:

log
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **payload-proto-filtering**

        **Description** Log Payload Protocol IDs Filtered

        **Type:** boolean

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

        **Default:** 0

.. _3492_permit-payload-protocol:

permit-payload-protocol
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **permit-config-id**

        **Type:** List

    **permit-config-name**

        **Type:** List

.. _3492_permit-payload-protocol_permit-config-id:

permit-payload-protocol_permit-config-id
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **protocol-id**

        **Description** Specify SCTP permitted payload protocol IDs

        **Type:** number

        **Range:** 1-63

.. _3492_permit-payload-protocol_permit-config-name:

permit-payload-protocol_permit-config-name
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **protocol-name**

        **Description** 'iua': IUA; 'm2ua': M2UA; 'm3ua': M3UA; 'sua': SUA; 'm2pa': M2PA; 'h.323': H.323; 

        **Type:** string

        **Supported Values:** iua, m2ua, m3ua, sua, m2pa, h.323