.. _cgnv6_one_to_one_global:

cgnv6 one-to-one global
=======================

Set one-to-one NAT config parameters


global Specification
--------------------

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

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

	 **Element Name**                      global

	 **Element URI**                       /axapi/v3/cgnv6/one-to-one/global

	 **Element Attributes**                global_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/cgnv6/one-to-one/global/stats

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



.. raw:: html

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


:ref:`522_global_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_one_to_one_global_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/one-to-one/global



.. raw:: html

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


:ref:`522_global_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_one_to_one_global_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/one-to-one/global



.. raw:: html

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


:ref:`522_global_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/one-to-one/global



.. raw:: html

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


:ref:`522_global_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/cgnv6_one_to_one_global_PUT.txt
   :literal:




.. raw:: html

   </div></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/one-to-one/global



.. raw:: html

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


:ref:`522_global_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_one_to_one_global_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _522_global_attributes:

global attributes
-----------------

    **mapping-timeout**

        **Description** Configure timeout for the one-to-one NAT mapping (Timeout in minutes (default: 10 minutes))

        **Type:** number

        **Range:** 0-180

        **Default:** 10

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _522_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'total-map-allocated': Total One-to-One Address Mapping Allocated; 'total-map-freed': Total One-to-One Address Mapping Freed; 'map-alloc-failure': One-to-One Address Mapping Allocation Failure; 'map-dbl-free': Address Mapping Double Free; 'alloc-map-race': Mapping Exists When Allocating Address Mapping; 'map-not-found': Mapping to be Released Not Found; 'ha-map-mismatch': HA Standby Mapping Mismatch; 'ha-select-addr-failure': HA Standby Allocate Address Failure; 'ha-alloc-map-conflicts': HA Standby Allocate Mapping Conflicts; 

        **Type:** string

        **Supported Values:** all, total-map-allocated, total-map-freed, map-alloc-failure, map-dbl-free, alloc-map-race, map-not-found, ha-map-mismatch, ha-select-addr-failure, ha-alloc-map-conflicts