.. _slb_template_sip:

slb template sip
================

SIP Template


sip Specification
-----------------

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

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

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

	 **Collection Name**                   :ref:`3046_sip_list`

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

	                                       

	 **Element Name**                      sip

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

	 **Element Attributes**                sip_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3046_sip_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_sip_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/sip



.. raw:: html

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


:ref:`3046_sip_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/sip/{name}



.. raw:: html

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


:ref:`3046_sip_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_sip_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/sip



.. raw:: html

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


:ref:`3046_sip_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/sip/{name}



.. raw:: html

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


:ref:`3046_sip_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/sip/{name}



.. raw:: html

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


:ref:`3046_sip_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_sip_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/sip



.. raw:: html

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


:ref:`3046_sip_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/sip/{name}



.. raw:: html

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


:ref:`3046_sip_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_sip_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3046_sip_list:

sip-list
--------


    sip-list is **JSON List** of :ref:`3046_sip_attributes` 

        sip-list : [

             { :ref:`3046_sip_attributes` },

             { :ref:`3046_sip_attributes` },

             ...

         ]

.. _3046_sip_attributes:

sip attributes
--------------

    **acl-id**

        **Description** ACL id

        **Type:** number

        **Range:** 100-199

        **Mutual Exclusion:** acl-id and acl-name-value are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/access-list/standard <access_list_standard>`

    **acl-name-value**

        **Description** IPv4 Access List Name

        **Type:** string

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** acl-name-value and acl-id are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ip/access-list <ip_access_list>`

    **alg-dest-nat**

        **Description** Translate VIP to real server IP in SIP message when destination NAT is used

        **Type:** boolean

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

        **Default:** 0

    **alg-source-nat**

        **Description** Translate source IP to NAT IP in SIP message when source NAT is used

        **Type:** boolean

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

        **Default:** 0

    **call-id-persist-disable**

        **Description** Disable call-ID persistence

        **Type:** boolean

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

        **Default:** 0

    **client-keep-alive**

        **Description** Respond client keep-alive packet directly instead of forwarding to server

        **Type:** boolean

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

        **Default:** 0

    **client-request-header**

        **Type:** List

    **client-response-header**

        **Type:** List

    **dialog-aware**

        **Description** Permit system processes dialog session

        **Type:** boolean

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

        **Default:** 0

    **drop-when-client-fail**

        **Description** Drop current SIP message when select client fail

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** drop-when-client-fail and failed-client-selection-message are mutually exclusive

    **drop-when-server-fail**

        **Description** Drop current SIP message when select server fail

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** drop-when-server-fail and failed-server-selection-message are mutually exclusive

    **exclude-translation**

        **Type:** List

    **failed-client-selection**

        **Description** Define action when select client fail

        **Type:** boolean

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

        **Default:** 0

    **failed-client-selection-message**

        **Description** Send SIP message (includs status code) to server when select client fail(Format: 3 digits(1XX~6XX) space reason)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** failed-client-selection-message and drop-when-client-fail are mutually exclusive

    **failed-server-selection**

        **Description** Define action when select server fail

        **Type:** boolean

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

        **Default:** 0

    **failed-server-selection-message**

        **Description** Send SIP message (includs status code) to client when select server fail(Format: 3 digits(1XX~6XX) space reason)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** failed-server-selection-message and drop-when-server-fail are mutually exclusive

    **insert-client-ip**

        **Description** Insert Client IP address into SIP header

        **Type:** boolean

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

        **Default:** 0

    **interval**

        **Description** The interval of keep-alive packet for each persist connection (second)

        **Type:** number

        **Range:** 5-300

        **Default:** 30

    **keep-server-ip-if-match-acl**

        **Description** Use Real Server IP for addresses matching the ACL for a Call-Id

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** SIP Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **pstn-gw**

        **Description** configure pstn gw host name for tel: uri translate to sip: uri (Hostname String, default is "pstn")

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Default:** pstn

    **server-keep-alive**

        **Description** Send server keep-alive packet for every persist connection when enable conn-reuse

        **Type:** boolean

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

        **Default:** 0

    **server-request-header**

        **Type:** List

    **server-response-header**

        **Type:** List

    **server-selection-per-request**

        **Description** Force server selection on every SIP request

        **Type:** boolean

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

        **Default:** 0

    **service-group**

        **Description** service group name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

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

    **smp-call-id-rtp-session**

        **Description** Create the across cpu call-id rtp session

        **Type:** boolean

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

        **Default:** 0

    **timeout**

        **Description** Time in minutes

        **Type:** number

        **Range:** 1-250

        **Default:** 30

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

.. _3046_server-request-header:

server-request-header
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **insert-condition-server-request**

        **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; 

        **Type:** string

        **Supported Values:** insert-if-not-exist, insert-always

    **server-request-erase-all**

        **Description** Erase all headers

        **Type:** boolean

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

        **Default:** 0

    **server-request-header-erase**

        **Description** Erase a SIP header (Header Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **server-request-header-insert**

        **Description** Insert a SIP header (Header Content (Format: "name:value"))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

.. _3046_server-response-header:

server-response-header
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **insert-condition-server-response**

        **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; 

        **Type:** string

        **Supported Values:** insert-if-not-exist, insert-always

    **server-response-erase-all**

        **Description** Erase all headers

        **Type:** boolean

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

        **Default:** 0

    **server-response-header-erase**

        **Description** Erase a SIP header (Header Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **server-response-header-insert**

        **Description** Insert a SIP header (Header Content (Format: "name:value"))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

.. _3046_client-request-header:

client-request-header
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **client-request-erase-all**

        **Description** Erase all headers

        **Type:** boolean

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

        **Default:** 0

    **client-request-header-erase**

        **Description** Erase a SIP header (Header Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **client-request-header-insert**

        **Description** Insert a SIP header (Header Content (Format: "name:value"))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **insert-condition-client-request**

        **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; 

        **Type:** string

        **Supported Values:** insert-if-not-exist, insert-always

.. _3046_client-response-header:

client-response-header
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **client-response-erase-all**

        **Description** Erase all headers

        **Type:** boolean

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

        **Default:** 0

    **client-response-header-erase**

        **Description** Erase a SIP header (Header Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **client-response-header-insert**

        **Description** Insert a SIP header (Header Content (Format: "name:value"))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **insert-condition-client-response**

        **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; 

        **Type:** string

        **Supported Values:** insert-if-not-exist, insert-always

.. _3046_exclude-translation:

exclude-translation
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **header-string**

        **Description** SIP header name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **translation-value**

        **Description** 'start-line': SIP request line or status line; 'header': SIP message headers; 'body': SIP message body; 

        **Type:** string

        **Supported Values:** start-line, header, body