.. _cgnv6_sctp:

cgnv6 sctp
==========

Configure CGNv6 SCTP NAT parameters


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

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

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

	 **Element Name**                      sctp

	 **Element URI**                       /axapi/v3/cgnv6/sctp

	 **Element Attributes**                sctp_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/cgnv6/sctp



.. raw:: html

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


sctp_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _556_sctp_attributes:

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

    **global**

        **Description:** global is a **JSON Block**.  Please see below for :ref:`556_global` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/sctp/global <cgnv6_sctp_global>`

    **permit-payload-protocol**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/sctp/permit-payload-protocol <cgnv6_sctp_permit_payload_protocol>`

    **rate-limit**

        **Description:** rate-limit is a **JSON Block**.  Please see below for :ref:`556_rate-limit` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/sctp/rate-limit <cgnv6_sctp_rate_limit>`

    **rate-limit-entries**

        **Description:** rate-limit-entries is a **JSON Block**.  Please see below for :ref:`556_rate-limit-entries` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/cgnv6/sctp/rate-limit-entries <cgnv6_sctp_rate_limit_entries>`

.. _556_rate-limit-entries:

rate-limit-entries
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _556_global:

global
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **half-open-timeout**

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

        **Type:** number

        **Range:** 2-30

        **Default:** 4

    **idle-timeout**

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

        **Type:** number

        **Range:** 1-63

        **Default:** 5

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _556_rate-limit:

rate-limit
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **destination-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/sctp/rate-limit/destination/{ip} <cgnv6_sctp_rate_limit_destination>`

    **source-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/sctp/rate-limit/source/{ip} <cgnv6_sctp_rate_limit_source>`

.. _556_rate-limit_source-list:

rate-limit_source-list
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ip**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **rate-limit**

        **Description** Rate limit in packets per second

        **Type:** number

        **Range:** 1-2147483647

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _556_rate-limit_destination-list:

rate-limit_destination-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ip**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **rate-limit**

        **Description** Rate limit in packets per second

        **Type:** number

        **Range:** 1-2147483647

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _556_permit-payload-protocol:

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

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

    **protocol-id-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/sctp/permit-payload-protocol/protocol-id/{id} <cgnv6_sctp_permit_payload_protocol_protocol_id>`

    **protocol-name-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/sctp/permit-payload-protocol/protocol-name/{protocol} <cgnv6_sctp_permit_payload_protocol_protocol_name>`

.. _556_permit-payload-protocol_protocol-id-list:

permit-payload-protocol_protocol-id-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **id**

        **Description** Specify SCTP permitted payload protocol IDs

        **Type:** number

        **Range:** 1-63

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _556_permit-payload-protocol_protocol-name-list:

permit-payload-protocol_protocol-name-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **protocol**

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters