.. _fw_alg_sip:

fw alg sip
==========

Change Firewall SIP ALG Settings


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

	===================================== ===================================================
	===================================== ===================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      sip

	 **Element URI**                       /axapi/v3/fw/alg/sip

	 **Element Attributes**                sip_attributes

	 **Statistics Data URI**               /axapi/v3/fw/alg/sip/stats

	 **Schema**                             :download:`sip schema <fw-alg-sip/fw-alg-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/fw/alg/sip



.. raw:: html

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


:ref:`779_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/fw/alg/sip



.. raw:: html

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


:ref:`779_sip_attributes`



.. 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/fw/alg/sip



.. raw:: html

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


:ref:`779_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/fw/alg/sip



.. raw:: html

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


:ref:`779_sip_attributes`



.. 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/fw/alg/sip



.. raw:: html

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


:ref:`779_sip_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _779_sip_attributes:

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

    **default-port-disable**

        **Description** 'default-port-disable': Disable SIP ALG default port 5060; 

        **Type:** string

        **Supported Values:** default-port-disable

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _779_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'stat-request': Request Received; 'stat-response': Response Received; 'method-register': Method REGISTER; 'method-invite': Method INVITE; 'method-ack': Method ACK; 'method-cancel': Method CANCEL; 'method-bye': Method BYE; 'method-options': Method OPTIONS; 'method-prack': Method PRACK; 'method-subscribe': Method SUBSCRIBE; 'method-notify': Method NOTIFY; 'method-publish': Method PUBLISH; 'method-info': Method INFO; 'method-refer': Method REFER; 'method-message': Method MESSAGE; 'method-update': Method UPDATE; 'method-unknown': Method Unknown; 'parse-error': Message Parse Error; 'keep-alive': Keep Alive; 'contact-error': Contact Process Error; 'sdp-error': SDP Process Error; 'rtp-port-no-op': RTP Port No Op; 'rtp-rtcp-port-success': RTP RTCP Port Success; 'rtp-port-failure': RTP Port Failure; 'rtcp-port-failure': RTCP Port Failure; 'contact-port-no-op': Contact Port No Op; 'contact-port-success': Contact Port Success; 'contact-port-failure': Contact Port Failure; 'contact-new': Contact Alloc; 'contact-alloc-failure': Contact Alloc Failure; 'contact-eim': Contact EIM; 'contact-eim-set': Contact EIM Set; 'rtp-new': RTP Alloc; 'rtp-alloc-failure': RTP Alloc Failure; 'rtp-eim': RTP EIM; 'helper-found': SMP Helper Conn Found; 'helper-created': SMP Helper Conn Created; 'helper-deleted': SMP Helper Conn Already Deleted; 'helper-freed': SMP Helper Conn Freed; 'helper-failure': SMP Helper Failure; 

        **Type:** string

        **Supported Values:** all, stat-request, stat-response, method-register, method-invite, method-ack, method-cancel, method-bye, method-options, method-prack, method-subscribe, method-notify, method-publish, method-info, method-refer, method-message, method-update, method-unknown, parse-error, keep-alive, contact-error, sdp-error, rtp-port-no-op, rtp-rtcp-port-success, rtp-port-failure, rtcp-port-failure, contact-port-no-op, contact-port-success, contact-port-failure, contact-new, contact-alloc-failure, contact-eim, contact-eim-set, rtp-new, rtp-alloc-failure, rtp-eim, helper-found, helper-created, helper-deleted, helper-freed, helper-failure

.. _779_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - method-options
      - 8
      - Method OPTIONS

   *  - 
      - stat-request
      - 8
      - Request Received

   *  - 
      - method-publish
      - 8
      - Method PUBLISH

   *  - 
      - method-unknown
      - 8
      - Method Unknown

   *  - 
      - method-message
      - 8
      - Method MESSAGE

   *  - 
      - method-subscribe
      - 8
      - Method SUBSCRIBE

   *  - 
      - method-invite
      - 8
      - Method INVITE

   *  - 
      - method-register
      - 8
      - Method REGISTER

   *  - 
      - method-prack
      - 8
      - Method PRACK

   *  - 
      - method-notify
      - 8
      - Method NOTIFY

   *  - 
      - method-info
      - 8
      - Method INFO

   *  - 
      - method-ack
      - 8
      - Method ACK

   *  - 
      - method-refer
      - 8
      - Method REFER

   *  - 
      - stat-response
      - 8
      - Response Received

   *  - 
      - method-update
      - 8
      - Method UPDATE

   *  - 
      - method-bye
      - 8
      - Method BYE

   *  - 
      - method-cancel
      - 8
      - Method CANCEL