.. _cgnv6_translation:

cgnv6 translation
=================

Configure CGN translation timeout values


translation Specification
-------------------------

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

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

	 **Element Name**                      translation

	 **Element URI**                       /axapi/v3/cgnv6/translation

	 **Element Attributes**                translation_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`620_translation_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/cgnv6_translation_POST.txt
   :literal:




.. raw:: html

   </div></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/cgnv6/translation



.. raw:: html

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


:ref:`620_translation_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/cgnv6_translation_GET.txt
   :literal:




.. raw:: html

   </div></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/cgnv6/translation



.. raw:: html

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


:ref:`620_translation_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/cgnv6/translation



.. raw:: html

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


:ref:`620_translation_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/cgnv6/translation



.. raw:: html

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


:ref:`620_translation_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/cgnv6_translation_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _620_translation_attributes:

translation attributes
----------------------

    **icmp-timeout**

        **Description:** icmp-timeout is a **JSON Block**.  Please see below for :ref:`620_icmp-timeout` 

        **Type:** Object

    **service-timeout-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cgnv6/translation/service-timeout/{service-type}+{port} <cgnv6_translation_service_timeout>`

    **tcp-timeout**

        **Description** TCP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes))

        **Type:** number

        **Range:** 2-15000

        **Default:** 300

    **udp-timeout**

        **Description** UDP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes))

        **Type:** number

        **Range:** 2-15000

        **Default:** 300

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _620_service-timeout-list:

service-timeout-list
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **fast**

        **Description** Use Fast Aging

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** fast and timeout-val are mutually exclusive

    **port**

        **Description** Port Number

        **Type:** number

        **Range:** 1-65535

    **port-end**

        **Description** End Port Number

        **Type:** number

        **Range:** 1-65535

    **service-type**

        **Description** 'tcp': TCP Protocol; 'udp': UDP Protocol; 

        **Type:** string

        **Supported Values:** tcp, udp

    **timeout-val**

        **Description** Timeout in seconds (Interval of 60 seconds)

        **Type:** number

        **Range:** 2-15000

        **Mutual Exclusion:** timeout-val and fast are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _620_icmp-timeout:

icmp-timeout
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **fast**

        **Description** Use Fast Aging

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** fast and icmp-timeout-val are mutually exclusive

    **icmp-timeout-val**

        **Description** Timeout in seconds (Interval of 60 seconds)

        **Type:** number

        **Range:** 2-15000

        **Mutual Exclusion:** icmp-timeout-val and fast are mutually exclusive